ansible / product-demos

GNU General Public License v3.0
194 stars 194 forks source link

Feature/changelog release #131

Closed youtous closed 10 months ago

youtous commented 10 months ago

Description

This pull request introduces an enhanced versioning workflow and automated release process using GitHub Actions.

Release Process Highlights

  1. Create Release Branch:

    • Start a release branch: git checkout -b release/v-<version>.
  2. Update Changelog:

    • Manually update CHANGELOG.md.
    • Add entries following the Keep a Changelog format.
  3. Commit Changes:

    • Commit changes: git add CHANGELOG.md & git commit -m "Update CHANGELOG for release <version>".
  4. Create Pull Request:

    • Open a pull request from the release branch to main.
  5. Review and Merge:

    • Review and merge the pull request into main.
  6. Tag the Release:

    • Tag the release: git tag -a v-<version> -m "Release <version>" & git push origin v-<version>.
  7. Automated Release:

    • An automatic GitHub Action will publish the release.
    • It parses CHANGELOG.md, generates a release note, and attaches relevant files.
  8. Cleanup:

    • Delete the release branch: git branch -d release/v-<version>.

Example Release

Explore an example release here, ci: https://github.com/youtous/product-demos/actions/runs/7503731628/job/20429143450.