Skip to content

Workflow file for this run

name: Content Compliance Check
on: [pull_request]
jobs:
content-compliance:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '14'
- name: Install dependencies
run: npm install
- name: Check for existing open PRs
id: check-prs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
contributor_login=$(jq -r '.pull_request.user.login' "$GITHUB_EVENT_PATH")
new_pr_branch=$(jq -r '.pull_request.head.ref' "$GITHUB_EVENT_PATH")
echo "Contributor login: $contributor_login"
echo "New PR branch: $new_pr_branch"
# Fetch open PRs from the repository
open_prs=$(gh pr list --state open --json title,author,headRefName --jq '.[] | select(.author.login=="'"$contributor_login"'")')
echo "Open PRs by contributor: $open_prs"
matching_pr=$(echo "$open_prs" | jq -r 'select(.headRefName == "'"$new_pr_branch"'")')
if [ -z "$open_prs" ]; then
echo "::set-output name=has-open-prs::false"
elif [ -n "$matching_pr" ]; then
echo "New PR is related to an existing branch: $matching_pr"
echo "::set-output name=related-to-existing-pr::true"
else
echo "::set-output name=related-to-existing-pr::false"
echo "::set-output name=has-open-prs::true"
fi
- name: Comment and Fail If Contributor Has Unrelated Open PRs
if: steps.check-prs.outputs.has-open-prs == 'true' && steps.check-prs.outputs.related-to-existing-pr != 'true'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr comment ${{ github.event.pull_request.number }} --body "Hi @${{ github.event.pull_request.user.login }}, our policy allows contributors to work on one issue at a time. Please complete or close your existing pull requests before creating a new one. If this PR is related to an existing PR, please ensure it uses the same branch."
exit 1
- name: File Naming and Folder Structure Compliance
run: |
files_invalid=false
for file in $(git diff --name-only origin/main...HEAD)
do
if [[ $file == articles/* || $file == guides/* ]]
then
if ! [[ $file =~ ^(articles|guides)/[0-9]{8}_[a-z0-9_]+\.md$ ]]
then
echo "Error: File \"$file\" does not follow the naming convention YYYYMMDD_title_of_the_article.md in 'articles' or 'guides' folder" >&2
files_invalid=true
fi
fi
if [[ $file == assets/* ]]
then
if ! [[ $file =~ ^assets/[0-9]{8}_[a-z0-9_]+_img[0-9]+\.png$ ]]
then
echo "Error: File \"$file\" does not follow the naming convention YYYYMMDD_title_of_the_article_imgN.png in 'assets' folder" >&2
files_invalid=true
fi
fi
done
if [ $files_invalid = true ]; then
exit 1
fi
- name: Run Markdown Lint
run: npx markdownlint '**/*.md --ignore "node_modules"'