Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(ci): add reference check for all markdown files #14

Closed
wants to merge 3 commits into from
Closed

feat(ci): add reference check for all markdown files #14

wants to merge 3 commits into from

Conversation

see7e
Copy link
Contributor

@see7e see7e commented Mar 25, 2025 •
edited
Loading

Closes #7

Summary

The previous PR had an issue when calling the script path:

python: can't open file '/home/runner/work/magma-documentation/magma-documentation/scripts/check_doc_references.py': [Errno 2] No such file or directory

Now the script checks all the files if no new document is detected.

Test Plan

Tested localy with new files.

Additional Information

  • This change is backwards-breaking

Security Considerations

see7e added 2 commits March 25, 2025 12:14
@see7e
feat(ci): add workflow to check Markdown file references
e06ce5c 
Signed-off-by: Gabryel Nóbrega <gabryelster@gmail.com>
@see7e
fix(ci): Refactor Markdown reference checking to include all Markdown…
cd33d79 
… files and resolve workflow path

Signed-off-by: Gabryel Nóbrega <gabryelster@gmail.com>
@pull-request-size pull-request-size bot added size/S and removed size/L labels Mar 25, 2025
@see7e see7e mentioned this pull request Mar 25, 2025
Open
@lucaaamaral lucaaamaral changed the title fix(ci): Resolve file path and refactor script feat(ci): add reference check for all markdown files Mar 25, 2025
@see7e
Copy link
Contributor Author

see7e commented Mar 26, 2025

To be replaced with Docusaurus sanity checks

@see7e see7e closed this Mar 26, 2025
@see7e see7e deleted the chore/track-referenced-files branch March 26, 2025 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucaaamaral lucaaamaral lucaaamaral left review comments

Assignees
No one assigned
Labels
size/S
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

chore(ci): create workflow to check the FrontMatter information in markdown
2 participants
@see7e @lucaaamaral