Skip to content

docs: add AI policy; update setup-python, codeql actions - #353

Merged
richm merged 2 commits into
mainfrom
update-20261029
Oct 29, 2026
Merged

richm merged 2 commits into
mainfrom
update-20261029

Conversation

@richm

@richm richm commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Add AI policy. The summary is that contributions which include a significant
amount of code written or generated by AI should include an attribution in a
code comment and in the git commit message/PR body.

Also include some recent updates to python related github actions.

@richm richm self-assigned this Oct 29, 2026
@github-actions

Copy link
Copy Markdown

CI tests do not run automatically on pull requests. A role repository
maintainer can start them by posting a /citest slash command in a
pull request comment.

See GitHub CI testing using /citest
for details.

Run every available CI workflow:

/citest all

Run the linting and other lightweight checks:

/citest linters

Run the integration tests (QEMU/container and Testing Farm):

/citest integration

Run one or more selected workflows by separating their names with spaces:

/citest ansible-lint
/citest ansible-lint markdownlint
Command Check name Description
/citest all All checks listed below Run every CI test available for this role
/citest linters Lint and lightweight checks Run ansible-lint, ansible-test, ansible-managed-var-comment, codespell, markdownlint, pr-title-lint, test_converting_readme, and codeql, python-unit-test, and shellcheck when those workflows exist
/citest integration QEMU/container and Testing Farm checks Run qemu-kvm-integration-tests and tft
/citest ansible-lint Ansible Lint / ansible_lint (<ansible-lint>, <ansible>, <python>) (pull_request) Lint Ansible content after converting the role to collection format
/citest ansible-managed-var-comment Check for ansible_managed variable use in comments / ansible_managed_var_comment (pull_request) Fail if ansible_managed is used in comments
/citest ansible-test Ansible Test / ansible_test (<ansible>, <python>) (pull_request) Run ansible-test sanity tests
/citest codespell Codespell / Check for spelling errors (pull_request) Check for spelling errors
/citest markdownlint Markdown Lint / markdownlint (pull_request) Lint Markdown files
/citest pr-title-lint PR Title Lint / commit-checks Check that the pull request title follows the required format
/citest qemu-kvm-integration-tests Test / scenario (<image>, <env>) (pull_request) Run role integration tests in QEMU VMs and containers
/citest test_converting_readme Test converting README.md to README.html / test_converting_readme (pull_request) Convert README.md to HTML
/citest tft <platform>|ansible-<version> Run integration tests in Testing Farm
/citest woke Woke / Detect non-inclusive language (pull_request) Detect non-inclusive language

Post another /citest comment at any time to run another selection.

@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
Walkthrough

The pull request adds guidance and prompts for AI-generated code attribution, along with a warning-level custom check. It also updates the Python setup action version in two Ansible workflows.

Changes: AI attribution

Layer / File(s) Summary
AI attribution guidance and check
contributing.md, .github/pull_request_template.md, .coderabbit.yaml
Contributor guidance and the pull request template request attribution for substantially AI-generated code. The custom check specifies attribution placement and format and reports a warning.

Python setup action updates

Layer / File(s) Summary
Update Python setup action versions
.github/workflows/ansible-lint.yml, .github/workflows/ansible-test.yml
Both workflows now use actions/setup-python@v7.1.0 instead of v7.0.0.

Priority: Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Suggested reviewers: baude

Merge Risk: Low · previous review fc99b

The attribution guidance and Python workflow updates have no other established defects, but the malformed configuration prevents the new attribution check from loading normally. Close the quoted name before merging.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the AI policy and Python action updates, which are the main changes. It also mentions CodeQL actions, but no CodeQL change appears in the summary.
Description check Passed The description explains the AI policy and Python action updates and includes a sign-off. It does not use the template headings or provide issue tracker information, but it contains the main required …
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains the AI policy and Python action updates and includes a sign-off. It does not use the template headings or provide issue tracker information, but it contains the main required context.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (5 skipped: 5 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Add AI policy.  The summary is that contributions which include a significant
amount of code written or generated by AI should include an attribution in a
code comment and in the git commit message/PR body.

Also include some recent updates to python related github actions.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔇 Additional comments: 1
.coderabbit.yaml-102-102: 1

102-102: Minor · Potential issue · Quick win

⚠️ Unverified finding
We couldn't verify this from the code. It is shown for review, not as a verified issue.

The new name: "AI Agent Attribution value has no closing double quote, which appears to make .coderabbit.yaml invalid YAML.

CodeRabbit may reject the configuration, disabling the new attribution check and potentially the existing review configuration.

This can occur when: CodeRabbit loads the changed repository configuration.


Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 4d66cad8-5dc7-4b2c-9d38-1186d01149f5
Commits

Reviewing files that changed from the base of the PR and between 55c6de8 and fc99b53.

Files ignored due to path filters: 1
  • .github/workflows/actions.lock is excluded by !**/*.lock
Files selected for processing: 5
  • .coderabbit.yaml
  • .github/pull_request_template.md
  • .github/workflows/ansible-lint.yml
  • .github/workflows/ansible-test.yml
  • contributing.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Add AI policy.  The summary is that contributions which include a significant
amount of code written or generated by AI should include an attribution in a
code comment and in the git commit message/PR body.

Also include some recent updates to python related github actions.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm
richm merged commit d1d23ee into main Oct 29, 2026
1 check passed
@richm
richm deleted the update-20261029 branch October 29, 2026 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant