[CI] Added job adding preview links #2561
Merged
Conversation
This file contains hidden or 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
mnocon
force-pushed
the
preview-links-comment
branch
from
f45d0fd to
c47f2fe
Compare
mnocon
force-pushed
the
preview-links-comment
branch
from
c47f2fe to
3cf1b26
Compare
adriendupuis
requested changes
Dec 4, 2024
adriendupuis
reviewed
Dec 4, 2024
Comment on lines
33
to
34
There was a problem hiding this comment.
I manage to generate the whole link list in one go:
git diff --name-only HEAD "origin/master" | grep -E "^docs\/.*\.md$" | sed -E "s|^docs/(.*)\.md$|- [docs/\1.md](${build_url}\1/)|"
There was a problem hiding this comment.
Thank you, this is like magic 😄
I've reworked it a bit to avoid harcoding master and added a new line as it didn't work in Github Actions (it didn't create a list):
comment=$(git diff --name-only HEAD "origin/$GITHUB_BASE_REF" | grep -E "^docs\/.*\.md$" | sed -E "s|^docs/(.*)\.md$|- [docs/\1.md](${build_url}\1/)\n|")
mnocon
force-pushed
the
preview-links-comment
branch
from
2c4364a to
c271bac
Compare
|
Thank you @adriendupuis for the suggestions, it looks much better now! |
|
Preview of modified Markdown: no Markdown change to preview. |
adriendupuis
reviewed
Feb 6, 2025
Co-authored-by: Adrien Dupuis <[email protected]>
adriendupuis
approved these changes
Feb 6, 2025
julitafalcondusza
approved these changes
Feb 7, 2025
mnocon
added a commit
that referenced
this pull request
Feb 11, 2025
* Applied review suggestion * [TMP] Add change * [TMP] Random change 2 * Fixed hardcoded master * Fix? * Fix? * Removed newline * Refactoring * Revert "[TMP] Add change" This reverts commit d9f9ffd. * Revert "[TMP] Random change 2" This reverts commit baa535d. * Removed file filter from the job * Refined message * Applied review wording suggestion Co-authored-by: Adrien Dupuis <[email protected]> --------- Co-authored-by: Adrien Dupuis <[email protected]>
mnocon
added a commit
that referenced
this pull request
Feb 11, 2025
* Applied review suggestion * [TMP] Add change * [TMP] Random change 2 * Fixed hardcoded master * Fix? * Fix? * Removed newline * Refactoring * Revert "[TMP] Add change" This reverts commit d9f9ffd. * Revert "[TMP] Random change 2" This reverts commit baa535d. * Removed file filter from the job * Refined message * Applied review wording suggestion Co-authored-by: Adrien Dupuis <[email protected]> --------- Co-authored-by: Adrien Dupuis <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Target: master, 4.6, 3.3 and user doc as a follow-up.
Adding a job to automatically generate preview links for all the changed Markdown files, so that we don't have to do this manually. See the comment below.
Option 1: No Markdown changes in the
docsdirectoryComment saying "No Markdown changes to preview" (#2561 (comment))
Option 2: Markdown changes
Bot adds a comment with links to all modified previews (without the diff coloring)
Option 3: Too many changes
I've chosen an arbitrary limit of 100 files - we can adjust it if needed. Bot adds a comment that too many files were modified to generate a list of links.