actions/create-release-action
3
0
Fork 0
Code Issues Pull Requests Actions Releases 2 Activity

fix(readme): correct readme

Browse Source
This commit is contained in:
Luke Tainton 2025-01-12 19:32:59 +00:00
parent 3a7e1bddfb
commit 456386a67d
Signed by: luke
SSH Key Fingerprint: SHA256:D34npKT7UaiT/7gULqu7EPSLWWVAjTjXf4kKfJ/fQBo
1 changed files with 21 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -1,50 +1,36 @@
# Conventional Commits Check Action
# Create Release Action
A [GitHub Action](https://github.com/features/actions) / [Gitea Action](https://docs.gitea.com/usage/actions/overview) for enforcing adherance to [Conventional Commits](https://pypi.org/project/conventional-pre-commit/).
A [Gitea Action](https://docs.gitea.com/usage/actions/overview) to create a release in a Gitea repository.
You can use the Action as follows:
```yaml
name: Validate PR Title
name: Create Release
on:
pull_request_target:
types:
- opened
- edited
- synchronize
- reopened
- labeled
- unlabeled
schedule:
- cron: "0 9 * * 0"
jobs:
validate:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: https://git.tainton.uk/actions/conventional-commits-check-action@v1.0.0
- uses: https://git.tainton.uk/actions/create-release-action@v1.0.0
with:
commit-message: ${{ github.event.pull_request.title }}
```
```yaml
name: Validate Commit Message
on:
push:
branches:
- main
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: https://git.tainton.uk/actions/conventional-commits-check-action@v1.0.0
with:
commit-message: ${{ github.event.head_commit.message }}
release_name: "v1.2.3"
tag: "v1.2.3"
draft: "false"
prerelease: "false"
```
## Properties
The Conventional Commits Check Action has a property which is passed to the underlying script. These are passed to the action using `with`.
| Property | Description |
| -------------- | ---------------------------------------------- |
| commit-message | The commit message you would like to validate. |
| Property | Required | Description |
| -------------- | -------- | ------------------------------------------------------------------- |
| `release_name` | **Yes** | Name of the release. |
| `tag` | **Yes** | Name of the tag to bind to the release. |
| `body` | No | Main body of the release. |
| `draft` | No | If the release should be a draft. Defaults to `"false"`. |
| `prerelease` | No | If the release should be a prerelease. Defaults to `"false"`. |
| `server_url` | No | The URL of the Gitea server. Defaults to `${{ gitea.server_url }}`. |
| `repository` | No | The name of the repository. Defaults to `${{ gitea.repository }}`. |
| `token` | No | Gitea API token. Defaults to `${{ gitea.token }}`. |