Skip to content

Commit 2d540fa

Browse files
authored
Merge pull request #236 from puppetlabs/maint-update_readme
(maint) - Update readme
2 parents af04f66 + 7d7ccf0 commit 2d540fa

File tree

1 file changed

+0
-52
lines changed

1 file changed

+0
-52
lines changed

README.md

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -70,58 +70,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
7070
7171
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). -->
7272

73-
## Releasing the Gem and Puppet Module
74-
75-
Steps to release an update to the gem and module include:
76-
77-
1. From main, checkout a new working branch for the release prep (where xyz is the appropriate version, sans periods):
78-
```bash
79-
git checkout -b maint-release_prep_xyz
80-
```
81-
82-
2. Update the version in `lib/pwsh/version.rb` and `metadata.json` to the appropriate version for the new release.
83-
84-
3. Run the changelog update task (make sure to verify the changelog, correctly tagging PRs as needed):
85-
```bash
86-
bundle exec rake changelog
87-
```
88-
89-
4. Commit your changes with a short, sensible commit message, like:
90-
```bash
91-
git add lib/pwsh/version.rb
92-
git add metadata.json
93-
git add CHANGELOG.md
94-
git commit -m '(MAINT) Prep for x.y.z release'
95-
```
96-
97-
5. Push your changes and submit a pull request for review _against main:
98-
```bash
99-
git push -u origin maint_release_prep_xyz
100-
```
101-
102-
6. Ensure tests pass and the code is merged to `main`.
103-
104-
7. Once the release_prep PR has been merged, checkout main and pull down the latests changes.
105-
```bash
106-
git checkout main
107-
git pull
108-
```
109-
110-
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).
111-
```bash
112-
git tag -a xyx -m "Release xyz"
113-
git push --follow-tags
114-
```
115-
116-
9. Execute the publish workflow. This will:
117-
- Create a GitHub release
118-
- Build and publish the Gem
119-
- Build and publish the Puppet module
120-
121-
10. Finally check that the expected versions are present on rubygems.org and the Forge.
122-
123-
## Known Issues
124-
12573
## Supported Operating Systems
12674

12775
The following platforms are supported:

0 commit comments

Comments
 (0)