Skip to content

Feature/arkode sts #886

Feature/arkode sts

Feature/arkode sts #886

Workflow file for this run

name: Checks - spelling
on:
pull_request:
workflow_dispatch:
issue_comment:
types: [created]
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
cancel-in-progress: true
jobs:
spelling_check:
if: ${{ github.event_name != 'issue_comment' || (github.event_name == 'issue_comment' && startsWith(github.event.comment.body, '/autofix')) }}
runs-on: ubuntu-latest
steps:
- name: Install python3-pip
run: |
sudo apt update
sudo apt install -y --no-install-recommends python3-pip
- name: Install codespell
run: pip install codespell
- name: Print codespell version
run: codespell --version
- name: Check out repository code
if: github.event_name != 'issue_comment'
uses: actions/checkout@v4
with:
submodules: true
- name: Check out repository code
if: github.event_name == 'issue_comment'
uses: actions/checkout@v4
with:
ref: refs/pull/${{ github.event.issue.number }}/head
fetch-depth: 0
- name: Run codespell
run: |
./scripts/spelling.sh
- name: Run git diff to see if anything changed
run: /usr/bin/git diff --name-only --exit-code
- name: Run git diff if we failed
if: failure()
run: /usr/bin/git diff > spelling.patch
- name: Archive diff as a patch if we failed
uses: actions/upload-artifact@v4
if: failure()
with:
name: spelling.patch
path: |
${{ github.workspace }}/spelling.patch
apply_spelling:
if: ${{ always() && contains(join(needs.*.result, ','), 'failure') && (github.event_name == 'issue_comment' && startsWith(github.event.comment.body, '/autofix')) }}
needs: spelling_check
runs-on: ubuntu-latest
steps:
# Checkout the GitHub created reference for the PR.
# The only way to do this is by using the "issue" number
# but that is really the PR number in this context.
# This is due to using an `issue_comment` event which
# is due to the GitHub Actions API that does not have
# a `pull_request_comment` event or something similar.
# This leaves us in a detached head state which is corrected
# in `apply-style/checkout.sh`
- name: Checkout repository code
uses: actions/checkout@v4
with:
ref: refs/pull/${{ github.event.issue.number }}/head
fetch-depth: 0
- name: Checkout the right git ref
run: ./.github/actions/apply-style/checkout.sh
- name: Download the git diff from spelling_check
uses: actions/download-artifact@v4
with:
name: spelling.patch
- name: Apply patch
run: |
git apply spelling.patch
rm spelling.patch
- name: Commit fixes
run: |
git config user.name "format-robot"
git config user.email "[email protected]"
if [ -n "$(git status --porcelain)" ]; then
git commit -am 'apply spelling updates'
git push
fi