Skip to content

v1.0.1

Choose a tag to compare

@openshock-release-bot openshock-release-bot released this 29 Oct 07:59
· 5 commits to develop since this release
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 under version_files in .changes/config.json, each with the json_key that 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 input version) 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