Skip to content

Editorial: Change failures to warnings for RFC2119 keywords #2651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Editorial: Change failures to warnings for RFC2119 keywords #2651

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a24efc
Change failures to warnings for RFC2119 keywords
daniel-montalvo Oct 10, 2025
6f2bfb4
Merge branch 'main' into rfc2119-warnings
daniel-montalvo Oct 10, 2025
8dc9066
Merge branch 'main' into rfc2119-warnings
daniel-montalvo Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions .github/workflows/RFC-2119-usage.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,20 @@ jobs:
check_pr:
runs-on: ubuntu-latest
steps:
- name: Check PR
- name: Check PR diff for RFC-2119 keywords
id: rfc_check
uses: JJ/github-pr-contains-action@releases/v10
continue-on-error: true
with:
github-token: ${{github.token}}
github-token: ${{secrets.GITHUB_TOKEN}}
Copy link

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change from ${{github.token}} to ${{secrets.GITHUB_TOKEN}} is unnecessary. The github.token context provides the same automatic token and is the preferred approach for workflow actions.

Suggested change
github-token: ${{secrets.GITHUB_TOKEN}}
github-token: ${{github.token}}

Copilot uses AI. Check for mistakes.
diffDoesNotContain: " must | must not | shall | shall not | should | should not | may"

- name: Warning if check found keywords
if: always()
run: |
# If the previous step failed (return code != 0), throw a workflow warning but don't fail
if [ "${{ steps.rfc_check.outcome }}" != "success" ]; then
echo "::warning::PR diff contains RFC-2119 keywords (must, shall, should or may). Please review."
else
echo "No RFC-2119 keywords found."
fi