Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.6 KB

RELEASING.md

File metadata and controls

42 lines (30 loc) · 1.6 KB

Releasing platformOS Check

Follow these steps to release a new version of latformOS Check:

  1. Versioning: Refer to the Semantic Versioning page to determine the appropriate version number for the new release based on the changes made.

  2. Update Version: Update the version number in the lib/platformos_check/version.rb file. Also, replace the PLATFORMOS_CHECK_VERSION placeholder in the documentation for any new rules. Use the following command to automate these updates:

    VERSION="X.X.X"
rake prerelease[$VERSION]

  3. Update Changelog: Use the git changelog command to automatically update the CHANGELOG.md with the latest commit descriptions.

    git changelog

  4. Commit and Prepare PR: Commit the changes and prepare a pull request for review.

    git checkout -b "bump/platformos-check-$VERSION"
git add docs/checks CHANGELOG.md lib/platformos_check/version.rb
git commit -m "Bump platformos-check version to $VERSION"
hub compare "main:bump/platformos-check-$VERSION"

  5. Merge PR: After review, merge your pull request into the main branch.

  6. Create GitHub Release: Create a GitHub release for the change using the updated version tag.

    VERSION=v1.X.Y
git fetch origin
git fetch origin --tags
git reset origin $VERSION
gh release create -t $VERSION

⚠️ Note: Incorporate relevant parts of the CHANGELOG into the release notes to provide context on the changes.