generated from actions/typescript-action
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add workflow for DocTagChecker * Use the current state of the repo as action
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |