Skip to content
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.

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

Use DocTagChecker in CI #12

Merged
merged 14 commits into from
Feb 9, 2024
30 changes: 30 additions & 0 deletions .github/workflows/DocTagChecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: DocTagChecker

on:
pull_request

jobs:
DocTagCheck:
runs-on: ubuntu-latest
env:
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Check for missing userdoc updates
# Use the DocTagChecker version from the branch that triggered the workflow
# This is the repo relative path to actions.yml
uses: ./
with:
githubToken: ${{ secrets.GITHUB_TOKEN }}
# multiple paths are separated by whitespace or ','
userDocsDirs: __tests__/testData/
# Optional inputs with defaults:
# DON'T use '/other stuff/i' as it contains intentional fakes
# dirTagSectionRegex:
# Check userDocsDirs recursively.
recurseUserDocDirs: true
# File extensions for files to be considered documentation.
docFileExtensions: md
# File extensions for files to be considered source code.
srcFileExtensions: ts
Loading