Skip to content

Commit

Permalink
feat(ops): Update readme to reflect how gorgians should use
Browse files Browse the repository at this point in the history
  • Loading branch information
FlipEnergy committed Aug 21, 2024
1 parent 80c0371 commit d252546
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ permissions:
jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
runs-on: gh-actions-small-runner-set
steps:
- uses: amannn/action-semantic-pull-request@v5
- uses: gorgias/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down Expand Up @@ -134,9 +134,9 @@ permissions:
jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
runs-on: gh-actions-small-runner-set
steps:
- uses: amannn/action-semantic-pull-request@v5
- uses: gorgias/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
Expand All @@ -145,7 +145,7 @@ jobs:

### Legacy configuration for validating single commits

When using "Squash and merge" on a PR with only one commit, GitHub will suggest using that commit message instead of the PR title for the merge commit. As it's easy to commit this by mistake this action supports two configuration options to provide additional validation for this case.
When using "Squash and merge" on a PR with only one commit, GitHub will suggest using that commit message instead of the PR title for the merge commit. As it's easy to commit this by mistake this action supports two configuration options to provide additional validation for this case.

```yml
# If the PR only contains a single commit, the action will validate that
Expand Down Expand Up @@ -191,9 +191,9 @@ permissions:
jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
runs-on: gh-actions-small-runner-set
steps:
- uses: amannn/action-semantic-pull-request@v5
- uses: gorgias/action-semantic-pull-request@v5
id: lint_pr_title
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -206,19 +206,19 @@ jobs:
header: pr-title-lint-error
message: |
Hey there and thank you for opening this pull request! 👋🏼
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
Details:
```
${{ steps.lint_pr_title.outputs.error_message }}
```

# Delete a previous comment when the issue has been resolved
- if: ${{ steps.lint_pr_title.outputs.error_message == null }}
uses: marocchino/sticky-pull-request-comment@v2
with:
with:
header: pr-title-lint-error
delete: true
```
Expand Down

0 comments on commit d252546

Please sign in to comment.