Skip to content

Commit

Permalink
ci: test ci change
Browse files Browse the repository at this point in the history
  • Loading branch information
stdavis committed Aug 14, 2024
1 parent 6bdccbb commit 4bd73e6
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

[![Push Events](https://github.com/agrc/release-composite-action/actions/workflows/push.yml/badge.svg)](https://github.com/agrc/release-composite-action/actions/workflows/push.yml)

Automated releases based on the [Angular preset for Conventional Commits](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).
This action is a wrapper around Google's [release-please](https://github.com/googleapis/release-please) that adds some UGRC-specific conventions and enhancements.

## Usage

```yml
# push.yml
name: Push Events

on:
Expand All @@ -15,12 +16,6 @@ on:
- dev
- main

permissions:
contents: write
id-token: write
deployments: write
pull-requests: write

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
Expand All @@ -29,6 +24,9 @@ jobs:
release:
name: Create release
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write

steps:
- uses: agrc/release-composite-action@v1
Expand All @@ -42,6 +40,21 @@ jobs:
github-app-email: ${{ secrets.UGRC_RELEASE_BOT_EMAIL }}
```
## How should I write my commits?
Release please auto-generates a changelog based on commits using the [Angular preset for Conventional Commits](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).
The following commit message prefixes are supported. "*" denotes that the prefix triggers a build. Everything but `feat` will be considered a patch release.

| Prefix | Description | Release Type | Changelog Section |
| --- | --- | --- | --- |
| `feat` | A new feature | Minor | Features |
| `fix` | A bug fix | Patch | Bug Fixes |
| `docs` | Documentation updates | Patch | Documentation |
| `style` | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | Patch | Styles |
| `deps` | A dependency update | Patch | Dependency Updates |
| `chore` | Any sort of change that does not affect the deployed project | n/a | n/a |

## Development

### Act Test Runner
Expand Down

0 comments on commit 4bd73e6

Please sign in to comment.