Skip to content

Release Workflow

Michael Geiger edited this page Feb 10, 2021 · 9 revisions

Draft - ideas welcome

Howto release a new version

Version number format: x.y.z (no v1.2.3!)

Prepare

  • Close (+label) processed pull requests / issues
  • Update milestones --> nothing open for the upcoming release
  • Actions must be "green" on latest build

Release

  1. Create new changelog
    • Create new branch vx.y.z
    • metadata.json update version number
    • Copy this file to test/fixtures/
    • Create changelog with bundle exec rake changelog
  2. Create PR
    • commit message: "New release x.y.z" (signoff --> -s)
    • Tag commit with version number x.y.z
    • Push commit to upstream (also the new tag --> --tags)
    • Label PR with no changelog
  3. Merge
  4. Create release with changelog entries from CHANGELOG.md (mark headlines as H3 --> ###)

Deploy

  • Adjust file permissions for Puppet Forge
    • Run tools/fix_permissions
    • Hopefully this will be fixed in pdk?
  • Upload release to Puppet Forge
    • Create package with pdk build
    • Upload via website
    • Should be automated with Travis CI in the future
  • On major releases:
    • Inform on Gitter
    • Write blog entry
Clone this wiki locally