Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions CONTEXT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Library Release Communication

This context defines the language for how this repository communicates published library versions through GitHub Releases. It exists to keep release discussion and implementation consistent.
Comment thread
mumenthalers marked this conversation as resolved.

## Language

**Release Run**:
A single publishing execution that may publish multiple packages and yields one consolidated GitHub Release.
_Avoid_: deploy, rollout, package release

**Release Tag**:
The Git tag attached to a Release Run record in GitHub Releases, optionally suffixing a PR tag for pull request runs.
Comment thread
mumenthalers marked this conversation as resolved.
_Avoid_: version tag, package tag

**PR Tag**:
The identifier derived from a pull request context and used as an optional suffix in a Release Tag.
_Avoid_: branch name, build number

**Stable Release**:
A GitHub Release created from `main` that represents a non-prerelease publication event.
_Avoid_: production release, final publish

**Pre-release**:
A GitHub Release created from a pull request run and explicitly marked as prerelease.
_Avoid_: draft release, beta by default

**Package Version Set**:
The set of package name/version pairs published in one Release Run.
_Avoid_: changelog, artifact list

**Changelog Link**:
A navigable reference from the GitHub Release body to package changelog entries relevant to the Release Run.
_Avoid_: release note text, commit log
Loading