RELEASE.md in vagrant-zones-0.1.3 vs RELEASE.md in vagrant-zones-0.1.8

- old
+ new

@@ -1,15 +1,22 @@ # Release process This is vagrant-zones' current release process, documented so people know what is -currently done. +currently done to release it. ## Prepare the release +Github Actions now handles the release cycle. We are using SemVer Verision and Convential Commits to ensure that we can use our Commits in our CI/CD Workflow + +To push a fix, ie a the Patch digit in Version string, prefix your commit header with "fix: Some Commit Message" + +To push a feature, ie a the feature digit in Version string, prefix your commit header with "feat: Some Commit Message" + +Doing so will cause GitHub Actions to perform the following * Update the version in "lib/vagrant-zones/version.rb" * Update the version in CHANGELOG.md -* Use "rake release". This will make sure to tag that commit and push it RubyGems. -* Update the version again in both files to a dev version for working again. +* Create a Release and Corresponding tag +* Push the package to the GPR and Ruby Gems -The CHANGELOG.md should be maintained in a similar format to Vagrant: +The CHANGELOG.md will be automatically maintained in a similar format to Vagrant by the Github Action Release-Please: https://github.com/mitchellh/vagrant/blob/master/CHANGELOG.md