Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
9 changes: 7 additions & 2 deletions .github/actions/create-package-release/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ runs:
latest_flag="--latest=false"
[ "$LATEST" = "true" ] && latest_flag="--latest"

# A release that continues the legacy bare series takes that tag as its
# title (v1.18.0 -> v2.0.0); everything else is "<package> v<version>".
title="${PACKAGE} v${VERSION}"
[ -n "$VANITY_TAG" ] && title="$VANITY_TAG"

# Validate requested assets exist before the dry-run branch, so a dry
# run catches a missing or misnamed asset.
read -ra assets <<< "$ASSETS"
Expand All @@ -114,7 +119,7 @@ runs:
{
echo "## 🔍 Dry run: \`${PACKAGE}\` ${VERSION}"
echo ""
echo "Would create tag \`${TAG}\` at \`${TARGET}\` (${latest_flag})."
echo "Would create tag \`${TAG}\` at \`${TARGET}\` titled \`${title}\` (${latest_flag})."
if [ -n "$VANITY_TAG" ]; then
echo "Would also create vanity tag \`${VANITY_TAG}\` (no release)."
fi
Expand All @@ -135,7 +140,7 @@ runs:
gh release create "$TAG" \
--repo "$GITHUB_REPOSITORY" \
--target "$TARGET" \
--title "\`${PACKAGE}\` ${VERSION}" \
--title "$title" \
--notes-file "${RUNNER_TEMP}/notes.md" \
$latest_flag \
"${assets[@]}"
Expand Down
7 changes: 4 additions & 3 deletions docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,12 @@ cascade (see [Guardrails](#guardrails)).
### Tag scheme

Each package has its own release series: tag `<package>-v<major>.<minor>.<patch>`,
title `` `<package>` <version> ``. The umbrella `overture-schema` release is
title `<package> v<version>`. The umbrella `overture-schema` release is
flagged **Latest**, and additionally continues the historical bare series
(`v0.4.0` … `v1.17.0`) as a vanity tag: each umbrella release also creates a
(`v0.4.0` … `v1.18.0`) as a vanity tag: each umbrella release also creates a
bare `v<version>` git tag at the same commit, with no second GitHub Release
attached. The umbrella package is the primary entrypoint for most consumers,
attached, and takes that tag as its title (`v2.0.0`) so the release list reads
as one continuous series. The umbrella package is the primary entrypoint for most consumers,
so its bare tags keep the long-standing convention alive; all other packages
use only the package-prefixed scheme.

Expand Down
Loading