Repository navigation
Releases
Releases · OpenShock/release-tool
v1.1.0
Immutable
release. Only release title and notes can be modified.
Added
- Record a given release time via SOURCE_DATE_EPOCH
SetSOURCE_DATE_EPOCH(Unix seconds) to record that time asreleased_atand as the CHANGELOG.md date instead of now, so a release can be replayed and reproduce its commit exactly.
Changed
- Credit the pull request that created a change file, not the one that last moved it (#17)
The PR link was taken from the most recent commit that added the file under its current name, so renaming change files while tidying them credited the tidy-up instead, and theprfield had to be set by hand. Renames are now followed back to the commit that created the file. Copies are not followed, so a new change file that only shares text with an existing one keeps its own credit. A commit that deletes one change file and adds another with near-identical text still reads as a rename, since git cannot tell the two apart.
Fixed
- Count change files that a merge commit adds (#17)
A pull request whose change file was added while merging the base branch back in, such as during a conflict resolution, was reported as having no change file. Change files are now found by comparing the pull request against its base, so a file added and later removed no longer counts either.
Full Changelog: v1.0.1...v1.1.0
v1.0.1
Immutable
release. Only release title and notes can be modified.
Warning
Breaking: Put safety, breaking changes and upgrade requirements first in the release notes
Important
- Notice levels are now caution, warning, important and note. Change files using info or error fail to parse; rename info to note and error to caution.
- release.json is now schema version 2. Consumers should read the new fields and the renamed notice levels.
- The PR check now fails without a change file. Set require-changes to false to keep the old warning, or list paths that never need one under ignore_paths in .changes/config.json.
- A prerelease with version_files configured now pushes a commit. Push HEAD together with the tag, as OpenShock/actions/publish-tag does, so the tag's commit lands on the branch.
Note
Unknown frontmatter keys are now errors, and files in .changes/ starting with "_" are reserved.
Added
- Set the version in project files on release
List files such as package.json underversion_filesin .changes/config.json, each with thejson_keythat holds the version. Stable releases and prereleases set it to the released version in their release commit, so the files always match the tag. A prerelease now makes that commit before tagging when version files are configured. - Override the computed version of a stable release
Pass--version(action inputversion) to release a specific MAJOR.MINOR.PATCH instead of the computed one, for example to skip a tag name GitHub no longer accepts because it belonged to a deleted immutable release. It may skip ahead but never below what the pending changes require, and only applies to stable branches.
Changed
- Breaking: Put safety, breaking changes and upgrade requirements first in the release notes (#15)
The GitHub Release body now starts with the prerelease warning, the headline and GitHub alerts for safety changes, breaking changes, upgrade requirements and notices, then lists what is new since the previous prerelease. Safety and Security are the first sections. Known issues, first-time contributors and a Full Changelog link were added, long sections fold, and nothing in a change's release note is dropped anymore. Change files gain upgrade, advisories, authors and yanks fields, and are linted for breaking changes that don't tell users what to do. A stable release archives its change files instead of deleting them. The PR check comment now says how the PR bumps the version and what the next release will be.
Full Changelog: v0.6.0...v1.0.1
v0.6.0
Immutable
release. Only release title and notes can be modified.
Changed
- Trim, link and order the generated release notes
List items in a change's release note are left out of the GitHub Release body, which keeps implementation detail out of it; release.json still carries them. A "(#123)" written into a title is used as the PR instead of being rendered twice, and the PR is also read offline from the subject of the commit that added the change file, so dry runs show it too. PR references and bare #123 mentions become links in the release body and CHANGELOG when the repository is known. Within each section, breaking changes come first and the rest follow the order their change files were committed instead of the filename order.
Contributors
Thanks to @hhvrc for contributing to this release!
v0.5.1
Immutable
release. Only release title and notes can be modified.
Security
- Bump OpenShock/actions publish-tag pin to v1.1.1 (code-injection fix)
Contributors
Thanks to @hhvrc for contributing to this release!
v0.5.0
Immutable
release. Only release title and notes can be modified.
Changed
- Fold release-mode git prep (rebase + fetch tags) into the action itself (#12)
Previously, workflows had to rebase and fetch tags themselves before invoking release-tool in release mode. The action now does this internally, so the tag always lands on the true tip and version computation always has full tag history, regardless of whether the caller remembered to do it.
Notices
- INFO: Workflows that were manually rebasing/fetching tags before calling release-tool in release mode can remove those now-redundant steps.
Contributors
Thanks to @hhvrc for contributing to this release!
v0.3.0
Immutable
release. Only release title and notes can be modified.
Changed
- Bump
actions/cachefrom 4.3.0 to 6.1.0 in the github-actions dependency group
Contributors
Thanks to @hhvrc for contributing to this release!
v0.2.2
Immutable
release. Only release title and notes can be modified.
v0.2.1
Immutable
release. Only release title and notes can be modified.
Fixed
- Cache the compiled binary keyed on a source content hash instead of recompiling via
go run .every invocation; fixes the non-functional setup-go module cache (its cache-dependency-path sat outside GITHUB_WORKSPACE) and removes the per-run compile cost (#6)
Contributors
Thanks to @hhvrc for contributing to this release!
v0.2.0
Immutable
release. Only release title and notes can be modified.
Added
- Expose the computed version as action outputs:
statusemitsnext-version,previous-version, andbump;release/prereleaseemitversion(set even on the no-tag path) (#5)
statusmode now writes machine-readable step outputs (next-version,previous-version,bump) andrelease/prereleaseexpose aversionoutput, so consuming workflows can read the version directly instead of parsing logs or re-deriving it from git tags.
Contributors
Thanks to @hhvrc for contributing to this release!
v0.1.0
Immutable
release. Only release title and notes can be modified.
Initial release — a small Go CLI and GitHub Action for change-file-driven, branch-aware semver releases.
Added
- A single
releasecommand cuts a stable, prerelease, or no-tag build based on per-branch config in.changes/config.json - Change files in
.changes/(kind, breaking, mandatory) drive the semver bump and generate a Keep-a-ChangelogCHANGELOG.md, validated notices, and a structuredrelease.json - Release notes thank commit contributors and link PRs, with per-change override or suppression of the PR number
- GitHub Action with
release,status, andcheckmodes for use in release and pull-request workflows initscaffolds the.changes/config and the GitHub Actions release and check workflows- Pull-request check validates the change files a PR adds and posts a sticky verdict comment, flagging missing, invalid, or
pr:-pinned files