mirror of
https://github.com/joaquinjsb/gitea-release-please-action
synced 2026-05-13 21:01:37 +02:00
docs: document major/minor tagging (#121)
This commit is contained in:
4
.github/workflows/release-please.yaml
vendored
4
.github/workflows/release-please.yaml
vendored
@@ -59,7 +59,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: [build]
|
needs: [build]
|
||||||
steps:
|
steps:
|
||||||
- uses: GoogleCloudPlatform/release-please-action@v2.8.1
|
- uses: GoogleCloudPlatform/release-please-action@v2
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.ACTIONS_BOT_TOKEN }}
|
token: ${{ secrets.ACTIONS_BOT_TOKEN }}
|
||||||
release-type: node
|
release-type: node
|
||||||
@@ -70,7 +70,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: [build]
|
needs: [build]
|
||||||
steps:
|
steps:
|
||||||
- uses: GoogleCloudPlatform/release-please-action@v2.8.1
|
- uses: GoogleCloudPlatform/release-please-action@v2
|
||||||
id: release
|
id: release
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|||||||
53
README.md
53
README.md
@@ -20,7 +20,7 @@ Automate releases with Conventional Commit Messages.
|
|||||||
release-please:
|
release-please:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: GoogleCloudPlatform/release-please-action@v2.8.0
|
- uses: GoogleCloudPlatform/release-please-action@v2
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
release-type: node
|
release-type: node
|
||||||
@@ -116,7 +116,7 @@ To output more commit information in the changelog, a JSON formatted String can
|
|||||||
release-please:
|
release-please:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: GoogleCloudPlatform/release-please-action@v2.8.0
|
- uses: GoogleCloudPlatform/release-please-action@v2
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
release-type: node
|
release-type: node
|
||||||
@@ -139,7 +139,7 @@ jobs:
|
|||||||
release-please:
|
release-please:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: GoogleCloudPlatform/release-please-action@v2.8.0
|
- uses: GoogleCloudPlatform/release-please-action@v2
|
||||||
id: release
|
id: release
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@@ -166,6 +166,53 @@ jobs:
|
|||||||
> So that you can keep 2FA enabled for npm publications, we recommend setting
|
> So that you can keep 2FA enabled for npm publications, we recommend setting
|
||||||
`registry-url` to your own [Wombat Dressing Room](https://github.com/GoogleCloudPlatform/wombat-dressing-room) deployment.
|
`registry-url` to your own [Wombat Dressing Room](https://github.com/GoogleCloudPlatform/wombat-dressing-room) deployment.
|
||||||
|
|
||||||
|
|
||||||
|
## Creating major/minor tags
|
||||||
|
|
||||||
|
If you are using release-please to publish a GitHub acton, you will
|
||||||
|
likely want to tag a major and minor tag during a release, i.e., if you
|
||||||
|
are releasing `v2.8.3`, you will also want to update tags `v2` and `v2.8`. This allows your
|
||||||
|
users to pin to `v2`, and get updates to your library without updating their
|
||||||
|
workflows.
|
||||||
|
|
||||||
|
The `release-please-action` has the outputs `major`, `minor`, and
|
||||||
|
`release_created` to facilitate this. These outputs can be used conditionally,
|
||||||
|
like so:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
name: release-please
|
||||||
|
jobs:
|
||||||
|
release-please:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: GoogleCloudPlatform/release-please-action@v2
|
||||||
|
id: release
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
release-type: node
|
||||||
|
package-name: ${{env.ACTION_NAME}}
|
||||||
|
command: github-release
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: tag major and patch versions
|
||||||
|
if: ${{ steps.release.outputs.release_created }}
|
||||||
|
run: |
|
||||||
|
git config user.name github-actions[bot]
|
||||||
|
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
||||||
|
git remote add gh-token "https://${{ secrets.GITHUB_TOKEN}}@github.com/google-github-actions/release-please-action.git"
|
||||||
|
git tag -d v${{ steps.release.outputs.major }} || true
|
||||||
|
git tag -d v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
|
||||||
|
git push origin :v${{ steps.release.outputs.major }} || true
|
||||||
|
git push origin :v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
|
||||||
|
git tag -a v${{ steps.release.outputs.major }} -m "Release v${{ steps.release.outputs.major }}"
|
||||||
|
git tag -a v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} -m "Release v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}"
|
||||||
|
git push origin v${{ steps.release.outputs.major }}
|
||||||
|
git push origin v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Apache Version 2.0
|
Apache Version 2.0
|
||||||
|
|||||||
Reference in New Issue
Block a user