Skip to content

Commit

Permalink
Use DocTagChecker in CI (#12)
Browse files Browse the repository at this point in the history
* add workflow for DocTagChecker
* Use the current state of the repo as action
  • Loading branch information
FG-TUM committed Feb 9, 2024
1 parent 68f7cc0 commit cd01956
Showing 1 changed file with 30 additions and 0 deletions.
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

0 comments on commit cd01956

Please sign in to comment.