diff --git a/.github/workflows/DocTagChecker.yml b/.github/workflows/DocTagChecker.yml new file mode 100644 index 0000000..b0e2a07 --- /dev/null +++ b/.github/workflows/DocTagChecker.yml @@ -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