feat: Add a step to validate the filename #138
Merged
+284
−5
Conversation
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
* check if the filename follow the convention (kebab-case)
benjaminParisel
force-pushed
the
feat/check_file_name
branch
from
dd1dc01
to
d74930a
Compare
|
Tested with bonitasoft/bonita-documentation-site#791 PR.
|
tbouffard
approved these changes
Oct 7, 2024
There was a problem hiding this comment.
LGTM, great work! 🎉
I haven't approved the PR yet, because I'd first like to talk about the current situation:
- the warning message about eventual alias creation
- if we do a manual rename operations in all repositories prior merging/releasing this new feature. This is what was planned in Tool: enforce file name to use kebab-case in documentation content bonita-documentation-site#589
| }); | ||
| commentBody += ` | ||
| > [!warning] | ||
| > Additionally, don't forget to add the \`:page-aliases:\` attribute after renaming the **existing files** to avoid broken links or references. `; |
There was a problem hiding this comment.
suggestion: Here the warning applies to file that previously existed prior the PR creation.
If the file is a new file created in the PR, there is no need to add an alias (and it shouldn't be added).
Let's talk in person to find a more convenient message.
...s/doc-contribs/pr-antora-content-guidelines-checker/__tests__/steps/PageFilenameStep.test.ts
Show resolved
Hide resolved
11 tasks
Answering to my own questions:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Covers bonitasoft/bonita-documentation-site#589