shanedell commented on PR #1401:
URL: https://github.com/apache/daffodil-vscode/pull/1401#issuecomment-3281573704
## Enfore Checkbox Workflow
So the workflow would need a little bit more of an update. However, I do
like @stevedlawrence's suggestion to move the wiki documentation files over to
a `docs` folder so users don't need special permissions. So the references to
Wiki for the templates should be removed and just updated to be documentation
in general. @stevedlawrence do you this PR could be used to add the wiki files
to a `docs` folder as well or should be a separate PR?
Moreover, the workflow would need to look something more like
```yaml
name: Enforce Docs Checkbox
on:
push:
branches-ignore:
- "dependabot/**" # dependabot PRs/branches
- "update/**" # scala-steward PRs/branches
pull_request:
types: [opened, edited, synchronize, reopened]
jobs:
enforce-checkbox:
runs-on: ubuntu-latest
steps:
- name: Check required confirmation checkbox
uses: actions/github-script@v7
with:
script: |
const prBody = context.payload.pull_request.body || "";
const checkbox1Text = "- [x] I have determined that no
documentation updates are needed for these changes";
const checkbox2Text = "- [x] I have added documentation for
these changes";
if (!prBody.includes(checkbox1Text) &&
!prBody.includes(checkbox2Text) {
core.setFailed("❌ Required documentation checkbox not checked.
Please check the box before merging.");
} else {
core.info("✅ Required documentation checkbox is checked.");
}
```
## Rat Check
I also noticed you add `file(.github)` to the `project/Rat.scala`. Usually
it is not preferred to add an entire directory to be ignored, in this case it
should not be done because we still want to check for LICENSE headers in those
files. The template MD files should be able to have a header because we have
that in other MD files. However, if it does cause a problem for the templates
for some reason than those files should have individual entries inside of
`project/Rat.scala`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
