Skip to content

Commit

Permalink
docs: test docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
stdavis committed Aug 14, 2024
1 parent 6bdccbb commit 3402c32
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 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,18 @@ 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.

- `feat`*: A new feature
- `fix`*: A bug fix
- `docs`: Documentation only changes
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- `deps`*: A dependency update

## Development

### Act Test Runner
Expand Down

0 comments on commit 3402c32

Please sign in to comment.