diff --git a/README.md b/README.md index 8289dc5a..8f60ef8b 100644 --- a/README.md +++ b/README.md @@ -70,58 +70,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). --> -## Releasing the Gem and Puppet Module - -Steps to release an update to the gem and module include: - -1. From main, checkout a new working branch for the release prep (where xyz is the appropriate version, sans periods): - ```bash - git checkout -b maint-release_prep_xyz - ``` - -2. Update the version in `lib/pwsh/version.rb` and `metadata.json` to the appropriate version for the new release. - -3. Run the changelog update task (make sure to verify the changelog, correctly tagging PRs as needed): - ```bash - bundle exec rake changelog - ``` - - 4. Commit your changes with a short, sensible commit message, like: - ```bash - git add lib/pwsh/version.rb - git add metadata.json - git add CHANGELOG.md - git commit -m '(MAINT) Prep for x.y.z release' - ``` - -5. Push your changes and submit a pull request for review _against main: - ```bash - git push -u origin maint_release_prep_xyz - ``` - -6. Ensure tests pass and the code is merged to `main`. - -7. Once the release_prep PR has been merged, checkout main and pull down the latests changes. - ```bash - git checkout main - git pull - ``` - -8. Assuming that the release_prep merge commit is at the HEAD of main we can simply create and push a tag as follows (replacing xyz with the appropriate version). - ```bash - git tag -a xyx -m "Release xyz" - git push --follow-tags - ``` - -9. Execute the publish workflow. This will: - - Create a GitHub release - - Build and publish the Gem - - Build and publish the Puppet module - -10. Finally check that the expected versions are present on rubygems.org and the Forge. - -## Known Issues - ## Supported Operating Systems The following platforms are supported: