From f88859828f27dc792a69f5cf3662c54305a87c8b Mon Sep 17 00:00:00 2001 From: Mikhail Zholobov Date: Wed, 24 May 2023 22:04:38 +0200 Subject: [PATCH] Add a doc note for releasing a new provider version --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff3e6c3..9e7a3d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,3 +78,31 @@ Run acceptance tests: $ bundle exec rake acceptance:run ... ``` + +### Releasing a New Provider Version + +_Note: Only the owners of `vagrant-parallels` gem on https://rubygems.org are permitted +to release new versions._ + +1. Build and test the new gem version (see details above): +``` +$ bundle exec rake build +``` + +2. Update the gem version in `./lib/vagrant-parallels/version.rb` + +3. Update change log in `./CHANGELOG.md` + +4. Commit those changes and also tag the release with the version: +```sh +$ git tag vX.Y.Z +$ git push --tags +``` + +4. Push a new gem version to rubygems.org: +```sh +$ gem push ./pkg/vagrant-parallels-.gem +``` + +5. Create a new Release on Github from the newly pushed tag: https://github.com/Parallels/vagrant-parallels/tags. + More info on the doc page: [Managing releases in a repository](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)