mirror of
https://github.com/joaquinjsb/gitea-release-please-action
synced 2026-05-05 02:27:48 +02:00
docs: flesh out docs a bit more (#7)
This commit is contained in:
49
README.md
49
README.md
@@ -1,14 +1,10 @@
|
||||
# Release Please Action
|
||||
|
||||
Automate releases based on Conventional Commit Messages.
|
||||
[](https://conventionalcommits.org)
|
||||
|
||||
## How release please works
|
||||
Automate releases with Conventional Commit Messages.
|
||||
|
||||
### How should I write my commits?
|
||||
|
||||
### What's a release PR?
|
||||
|
||||
## Configuring this action
|
||||
## Setting up this action
|
||||
|
||||
1. If you haven't already done so, create a `.github/workflows` folder in your
|
||||
repository (_this is where your actions will live_).
|
||||
@@ -24,7 +20,7 @@ Automate releases based on Conventional Commit Messages.
|
||||
release-please:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: bcoe/release-please-action@9291b92aca4939d0cc2781f26504c638ce1ba534
|
||||
- uses: bcoe/release-please-action@v1.0.1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
release-type: node
|
||||
@@ -36,6 +32,43 @@ Automate releases based on Conventional Commit Messages.
|
||||
convention, [release-please](https://github.com/googleapis/release-please)
|
||||
will start creating Release PRs for you.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Variable | Description |
|
||||
| --------------- | ------------------------------------------------ |
|
||||
| token | A GitHub secret token, you will most likely want to use the special `secrets.GITHUB_TOKEN` |
|
||||
| release-type | What type of project is this a release for? Currently we support `node`, `ruby`, `python`, `terraform-module`, new types of releases can be [added here](https://github.com/googleapis/release-please/tree/master/src/releasers) |
|
||||
| package-name | A name for the artifact releases are being created for (this might be the `name` field in a `setup.py` or `package.json`) |
|
||||
|
||||
## How release please works
|
||||
|
||||
Release Please automates CHANGELOG generation, the creation of GitHub releases,
|
||||
and version bumps for your projects. Release Please does so by parsing your
|
||||
git history, looking for [Conventional Commit messages](https://www.conventionalcommits.org/),
|
||||
and creating release PRs.
|
||||
|
||||
### What's a Release PR?
|
||||
|
||||
Rather than continuously releasing what's landed to your default branch,
|
||||
release-please maintains Release PRs:
|
||||
|
||||
<img width="400" src="/screen.png">
|
||||
|
||||
These Release PRs are kept up-to-date as additional work is merged. When you're
|
||||
ready to tag a release, simply merge the release PR.
|
||||
|
||||
### How should I write my commits?
|
||||
|
||||
Release Please assumes you are using [Conventional Commit messages](https://www.conventionalcommits.org/).
|
||||
|
||||
The most important prefixes you should have in mind are:
|
||||
|
||||
* `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
|
||||
patch.
|
||||
* `feat:` which represents a new feature, and correlates to a SemVer minor.
|
||||
* `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
|
||||
(indicated by the `!`) and will result in a SemVer major.
|
||||
|
||||
## License
|
||||
|
||||
Apache Version 2.0
|
||||
|
||||
BIN
screen.png
Normal file
BIN
screen.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 95 KiB |
Reference in New Issue
Block a user