Skip to content

added readme check #41

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
Nick-Andreano wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added readme check #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions .github/workflows/role-readme-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .github/workflows/role-readme-check.yml
#
# Ansible Galaxy requires every role to have its own README. This job fails the build
# (blocking merge to main) if any directory under roles/ is missing one.
name: role-readme-check
on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
jobs:
check-role-readmes:
name: Role READMEs # Naming the build is important to use it as a status check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Verify every role has a README
run: |
missing=0
for dir in roles/*/; do
role=$(basename "$dir")
if ! ls "$dir" 2>/dev/null | grep -qi '^readme'; then
echo "::error::Role '$role' is missing a README (required by Ansible Galaxy)"
missing=1
fi
done
exit "$missing"
Loading