Skip to content

Commit 7c6ba11

Browse files
committed
cleanup
1 parent 7ecb395 commit 7c6ba11

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

.github/workflows/npm-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
33

4-
name: Node.js Package
4+
name: npm-publish
55

66
on:
77
release:

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,11 @@ Released under the MIT [Licence](./LICENSE). Copyright (c) BootstrapVue3.
7575

7676
# Making a new release
7777

78-
`.github/workflows/release-please.yml` will auto generate releases. Googleapi states `creates a release pull request after it notices the default branch contains "releasable units"` -- one who's commit follows conventional commits guidelines. You may have noticed that https://github.com/cdmoro/bootstrap-vue-3/pull/443 did not come with a bot release, but https://github.com/cdmoro/bootstrap-vue-3/pull/445 did (in terms of this https://github.com/cdmoro/bootstrap-vue-3/pull/444 , it was the bot activating from 443 and seeing a previous 'releasable unit' in May, not creating a PR _for_ rather _because of_). I also think the bot would rebase and merge two of it's own release PR requests keeping it's own prs clean.
78+
`.github/workflows/release-please.yml` will auto generate releases. Googleapi states `creates a release pull request after it notices the default branch contains "releasable units"` -- one who's commit follows conventional commits guidelines. You may have noticed that https://github.com/cdmoro/bootstrap-vue-3/pull/443 did not come with a bot release, but https://github.com/cdmoro/bootstrap-vue-3/pull/445 did. I also think the bot would rebase and merge two of it's own release PR requests keeping it's own prs clean.
79+
80+
`.github/workflows/npm-publish.yml` run when a release is created and will auto-publish at https://www.npmjs.com/package/bootstrap-vue-3
81+
82+
## Manual releases
7983

8084
One could however, remove the bot automation and use https://github.com/googleapis/release-please/blob/main/docs/cli.md#creatingupdating-release-prs for manually (but auto generating) creating a release PR. If you feel manually releasing is preferable, simply remove the workflow. You would need to manually configure a few things to get the release-please cli to work, but once figured out it should be fairly easy to create new releases.
8185

@@ -84,5 +88,4 @@ Another way to manual release:
8488
1. increase version in `package.json`, commit
8589
2. https://github.com/cdmoro/bootstrap-vue-3/releases/new (create new tag)
8690

87-
`bootstrap-vue-3/.github/workflows/npm-publish.yml` will auto-publish at https://www.npmjs.com/package/bootstrap-vue-3
8891
TODO: publish runs 2 times

0 commit comments

Comments
 (0)