Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(maint) - Update readme #236

Merged
merged 1 commit into from
Aug 17, 2023
Merged

(maint) - Update readme #236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 0 additions & 52 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down