Skip to content

Commit 5d500e7

Browse files
authored
Update README with release and tagging instructions (#367)
1 parent 4b1d14c commit 5d500e7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@ For JS modules you will need to use gitpkg.now.sh to point to a subfolder within
140140

141141
Releases will be published according to [Semantic Versioning](https://semver.org/) and it is the responsibility of the consumers to keep their application dependencies up to date. We recommend leveraging [renovatebot](https://github.com/renovatebot/renovate) 🤖
142142

143+
To release a new version of a package, [create a new release](https://github.com/powerhome/power-tools/releases/new) and a tag in the format of `v<new-version>-<package-name>`, where `new-version` matches the new version of your package and the `package-name` matches the github workflow name (which should match the package name).
144+
145+
When releasing different packages, please create different releases.
146+
143147
## Supporting multiple gem versions
144148

145149
To support multiple versions of a gem, and add a build to the pipeline, we use [Appraisal](https://github.com/thoughtbot/appraisal). The installation is simple, add `appraisal` to your gemspec as a development dependency and install it, then create an Appraisals file like the following to support multiple versions of rails:

0 commit comments

Comments
 (0)