docs: improve official black action notice #74
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Test | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| jobs: | |
| test-check: | |
| name: runner / black-format | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: ./ | |
| id: black_format | |
| with: | |
| fail_on_error: "false" | |
| - name: Check if code is left untouched (not formatted) | |
| run: | | |
| changed_files=$(git status --porcelain | wc -l) | |
| if [[ ${changed_files} -eq 0 ]]; then | |
| echo "No changes detected!" | |
| else | |
| echo "Changes detected!" | |
| exit 1 | |
| fi | |
| - name: Check 'is_formatted' output value | |
| run: | | |
| formatted=${{ steps.black_format.outputs.is_formatted }} | |
| if [[ ${formatted} != "false" ]]; then | |
| echo "'is_formatted' output invalid!" | |
| exit 1 | |
| else | |
| echo "'is_formatted' output valid." | |
| fi | |
| test-format: | |
| name: runner / black-format (format) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: ./ | |
| id: black_format | |
| with: | |
| black_args: "." | |
| fail_on_error: "false" | |
| - name: Check if formatting was successful | |
| run: | | |
| changed_files=$(git status --porcelain | wc -l) | |
| if [[ ${changed_files} -eq 0 ]]; then | |
| echo "No changes detected!" | |
| exit 1 | |
| else | |
| echo "Changes detected!" | |
| fi | |
| - name: Check 'is_formatted' output value | |
| run: | | |
| formatted=${{ steps.black_format.outputs.is_formatted }} | |
| if [[ ${formatted} == "false" ]]; then | |
| echo "'is_formatted' output invalid!" | |
| exit 1 | |
| else | |
| echo "'is_formatted' output valid." | |
| fi |