Skip to content

Commit e29f5cd

Browse files
committed
docs: move how to publish release to contribution
1 parent 9e80d24 commit e29f5cd

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

CONTRIBUTION.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,20 @@ The project uses a monorepo architecture. The main source files for the package
2929
## Ask for help
3030

3131
Working on the app is not a solo job. It is always fine to ask on how something should be done, or how something can be improved. Ask for help when you're stuck!
32+
33+
## Making a new release
34+
35+
Bootstrap Vue 3 uses [release-please](https://github.com/googleapis/release-please) to automate releases using workflows. The `.github/workflows/release-please.yaml` workflow will auto generate releases when using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). We encourage your commit message to follow conventional commit guidelines to keep commits clean and automate releases
36+
37+
The workflow `.github/workflows/npm-publish.yaml` will then auto-publish at <https://www.npmjs.com/package/bootstrap-vue-3>
38+
39+
## Manual releases
40+
41+
One could also manually create a release PR using the cli, directions [here](https://github.com/googleapis/release-please/blob/main/docs/cli.md#running-release-please-cli). Follow the directions for bootstrapping and creating a release, then it will auto generate a PR containing the new release notes
42+
43+
It will then auto-publish as stated before
44+
45+
Collaborators can also manually release by:
46+
47+
increase version in package.json, commit
48+
<https://github.com/cdmoro/bootstrap-vue-3/releases/new> (create new tag)

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -77,20 +77,3 @@ Or if you prefer you can make a one-time donation through these channels:
7777
# License
7878

7979
Released under the MIT [Licence](./LICENSE). Copyright (c) BootstrapVue3.
80-
81-
# Making a new release
82-
83-
Bootstrap Vue 3 uses [release-please](https://github.com/googleapis/release-please) to automate releases using workflows. The `.github/workflows/release-please.yaml` workflow will auto generate releases when using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). We encourage your commit message to follow conventional commit guidelines to keep commits clean and automate releases
84-
85-
The workflow `.github/workflows/npm-publish.yaml` will then auto-publish at <https://www.npmjs.com/package/bootstrap-vue-3>
86-
87-
## Manual releases
88-
89-
One could also manually create a release PR using the cli, directions [here](https://github.com/googleapis/release-please/blob/main/docs/cli.md#running-release-please-cli). Follow the directions for bootstrapping and creating a release, then it will auto generate a PR containing the new release notes
90-
91-
It will then auto-publish as stated before
92-
93-
Collaborators can also manually release by:
94-
95-
increase version in package.json, commit
96-
<https://github.com/cdmoro/bootstrap-vue-3/releases/new> (create new tag)

0 commit comments

Comments
 (0)