autopas/doc-check
A tool to check if a PR touches code but not the corresponding documentation.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| githubToken | GitHub token to authenticate the action to interact with the repository. | yes | — |
| userDocsDirs | The paths to the directories where the user doc files are, relative to the repository root. | yes | docs |
| recurseUserDocDirs | Whether to also look for user doc files in all subdirectories of the given directories. | no | false |
| dirTagSectionRegex | The regular expression that is used to identify the section of a documentation file where the tool starts looking for directory tags. | no | /Related Files and Folders/i |
| docFileExtensions | File extensions that are considered for doc files. | no | md |
| srcFileExtensions | File extensions that are considered for source files. | no | cpp h txt |
Outputs
| name | description |
|---|---|
| warnings | All produced warnings. |