Skip to content

docs: de-hardcode the initial-publish section in RELEASING.md - #145

Closed
OmarAlJarrah wants to merge 1 commit into
mainfrom
e3-releasing-version
Closed

docs: de-hardcode the initial-publish section in RELEASING.md#145
OmarAlJarrah wants to merge 1 commit into
mainfrom
e3-releasing-version

Conversation

@OmarAlJarrah

Copy link
Copy Markdown
Member

Summary

  • RELEASING.md's "Publishing the initial 0.1.0-alpha.1" section still assumed .release-please-manifest.json and gradle.properties read 0.1.0-alpha.1 and that the next automated release would be alpha.2; both files are now at 0.1.0-alpha.4, so the runbook pointed at a stale version and a false "next release" claim.
  • Reworded the section to describe the actual condition that requires a manual publish -- release-please's publish job builds off an existing GitHub Release, so a version with no prior tag (the very first alpha, or the start of a future series) has to be published by hand once -- instead of naming a specific version number.
  • This keeps the runbook accurate as releases keep shipping and lets it apply again if a future series ever needs the same manual bootstrap, rather than needing another edit every time the version moves.

Test plan

  • Doc-only change (no logic touched); proofread the diff for accuracy against the current .release-please-manifest.json (0.1.0-alpha.4) and gradle.properties (version=0.1.0-alpha.4).
  • No Gradle build required per repo policy for doc-only changes.

Closes #94

The "Publishing the initial 0.1.0-alpha.1" runbook still assumed
.release-please-manifest.json and gradle.properties read 0.1.0-alpha.1 and
that the first automated release would be alpha.2. Both files have long
since moved to 0.1.0-alpha.4, so the runbook was pointing a maintainer at a
stale version and a false "first automated release" claim.

Reframe the section around the general condition that actually requires a
manual publish -- release-please's publish job needs an existing GitHub
Release to build from, so whatever version is on gradle.properties when
there is no tag for it yet has to be published by hand once. This describes
the same one-time bootstrap procedure without hardcoding a version number,
so it stays accurate as releases ship and applies again if a future series
ever needs the same manual kick-start.

Closes #94
@OmarAlJarrah

Copy link
Copy Markdown
Member Author

Superseded by #157, which switches the project to a stable 0.1.0 release line. This PR's de-hardcoded, generic "bootstrap a version with no prior tag" runbook is incorporated into the RELEASING.md rework there, alongside the broader alpha-to-0.x cadence changes the version switch requires. Closing in favor of #157; #94 is closed there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: RELEASING.md initial-release runbook still assumes the current version is 0.1.0-alpha.1 (actual: 0.1.0-alpha.4)

1 participant