docs(release): document release procedure in AGENTS.MD; remove deprecated createRelease.sh#7920
Merged
Merged
Conversation
This script has carried a "DEPRECATED since Etherpad 1.7.0 (2018-08-17), left here just for documentation" banner for years and is dead code: - It authenticates to the GitHub API with the `?access_token=` query parameter, which GitHub removed in 2021 — every API call (token check, branch merge, release publish) now fails outright. - It targets the old `ether/etherpad-lite` repo paths and calls `bin/buildForWindows.sh` / `make docs`, neither of which is how releases are built anymore. - Nothing references it (no workflow, script, or doc). The current release flow is the "Release etherpad" workflow (.github/workflows/release.yml) driving bin/release.ts, then the tag-push triggers handleRelease.yml + releaseEtherpad.yml. createRelease.sh only adds confusion, so remove it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require review |
Add a "Releasing" section to AGENTS.MD so maintainers have a single reference for cutting a release, instead of reverse-engineering it from bin/release.ts and the workflow files. Covers: - Prerequisites: the CHANGELOG `# X.Y.Z` guard, and the requirement that all four package.json files agree (release.ts reads the current version from src/package.json) — the desync that blocked the 3.3.0 release. - The one-dispatch flow: "Release etherpad" -> bin/release.ts -> tag push, and what the vX.Y.Z tag auto-triggers (handleRelease GitHub Release, docker, snap-publish), plus the separate manual npm publish dispatch. - Documentation: the two distinct kinds of doc work — per-PR doc/ updates in behaviour-change PRs, and the automated release-time versioned-docs publish into the ether.github.com sibling repo. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
JohnMcLear
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two related changes that tidy up release tooling and documentation.
1. Document the release procedure in
AGENTS.MDAdds a Releasing section so maintainers have a single reference instead of reverse-engineering it from
bin/release.tsand the workflow files. It covers:# X.Y.ZCHANGELOG.mdguard (release.ts:146), and the requirement that all fourpackage.jsonfiles agree on the current version (release.tsreads it fromsrc/package.json). This is the exact desync that blocked the 3.3.0 release.bin/release.ts→bin/push-after-release.sh, and what thevX.Y.Ztag push auto-triggers (handleRelease.ymlGitHub Release,docker.yml,snap-publish.yml), plus the separate manual npm publish (releaseEtherpad.yaml, OIDC).doc/updates in any behaviour-change PR (doc/api/http_api.{md,adoc}etc.); (2) the automated release-time versioned-docs publish into theether.github.comsibling repo (makeDocs→public/doc/vX.Y.Z).2. Remove deprecated
bin/createRelease.shIt has carried a "DEPRECATED since Etherpad 1.7.0 (2018-08-17), left here just for documentation" banner for ~8 years and cannot run: it authenticates with the
?access_token=query parameter GitHub removed in 2021, targets oldether/etherpad-litepaths, and nothing references it. The AGENTS.MD section now documents the real flow, so the dead script only added confusion.🤖 Generated with Claude Code