Repository navigation
Conversation
The "Cut a new tag" workflow only bumps package.json and package-lock.json, so manifest.json carries no version and the plugin changelogs must be updated by hand, drifting from the tag. Set manifest.json's "version" (creating the field when missing) to the bumped version, and prepend an entry built from the commit subjects since the previous tag to CHANGELOG.md and debian/changelog when the plugin has them. Hand-written entries for the new version are kept untouched. Bump, manifest and changelogs land in a single commit, tagged as before.
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
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.
What does this PR do?
Extends the "Cut a new tag" workflow (
.github/workflows/publish-tag.yml) so that, besidespackage.jsonandpackage-lock.json, it also:version(introduced in feat: Add propversionto plugins manifest to avoid browser caching bigbluebutton#24153) field ofmanifest.jsonto the bumped version, creating the field when it does not exist yet;CHANGELOG.md, when the plugin has one, following the heading level (##/###) and bullet style (*/-) already used in the file;debian/changelog, when the plugin has one, reusing the package name, distribution and maintainer of the previous entry.The changelog entries are built from the commit subjects since the previous tag, skipping merge commits and previous
chore: bump version tocommits; when nothing is left, the entry ischore: release vX.Y.Z. If a changelog already has a hand-written entry for the new version, it is left untouched.Version bump, manifest and changelogs land in a single
chore: bump version to X.Y.Zcommit, taggedvX.Y.Zand pushed as before.Supporting changes:
fetch-depth: 0on checkout, so the history and tags needed to list commits since the previous release are available;permissions: contents: writeon the job, so the push of the commit and tag is allowed;Closes Issue(s)
Closes none
Motivation
Today the workflow only bumps
package.jsonandpackage-lock.json.manifest.jsoncarries no version, so a deployed plugin cannot be traced back to a release, and the plugin changelogs have to be updated by hand, which is easy to forget and lets them drift from the tags. The manifest bump follows the samejqapproach already used by other plugins built from this template.More
Tested locally by running the workflow steps against a scratch clone of
v0.1.x(withgit pushdisabled):manifest.jsongainsversion, both changelogs get a new entry, anddpkg-parsechangelogparses the resultingdebian/changelog;CHANGELOG.mdentry:CHANGELOG.mdis kept as is,debian/changeloggetschore: release v0.2.1;CHANGELOG.mdand nodebian/: only the version files change and the changelog steps are skipped.Notes for reviewers:
debian/changelogmaintainer is copied from the previous entry rather than taken from the user who triggered the workflow.