Add verify-docs job #3672
Add verify-docs job #3672
Conversation
geyslan
force-pushed
the
verify-docs-job
branch
from
1cda20e
to
5474434
Compare
geyslan
force-pushed
the
verify-docs-job
branch
from
5474434
to
fdee7e0
Compare
|
Cancelled jobs since the one related to this PR passed: https://github.com/aquasecurity/tracee/pull/3672/checks |
| man_files=$(echo "${{ steps.changed-files.outputs.man_files_all_changed_files }}" | xargs -n 1 basename | sed 's/\.1$//') | ||
|
|
||
| missing_updates=() | ||
| for base_name in $md_files; do |
There was a problem hiding this comment.
The script assumes that for every .1.md file, there is a corresponding .1 file that needs to be updated, and vice versa. If this is not strict (like a new file added), the script may raise false positives, no ?
There was a problem hiding this comment.
Well observed. I need to change it to any_modified in the if and to all_modified_files in the assignments. Going to, hold on.
There was a problem hiding this comment.
Updated Makefile to ensure that any change (addition, modification, deletion) in the .md will reflect in the man pages.
There was a problem hiding this comment.
This error should be ignored, as it was a remnant caused precisely by the lack of checking (checking introduced by this PR).
To ensure that 'make man' will be 1:1 to the source .md files, clean man path and rebuild all man pages.
geyslan
force-pushed
the
verify-docs-job
branch
from
fdee7e0
to
d063f5e
Compare
1. Explain what the PR does
fdee7e0 chore(ci): add verify-docs job
2. Explain how to test it
3. Other comments