feat : Update docs-build to include PR link rewrites #6391
Merged
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
|
@Garanas do we include snippets for these sorts of PRs? |
|
Not yet - when it is in a releasable state then we'll create a snippet about it. |
|
Can you add a (MIT) license to the file? |
Garanas
approved these changes
Aug 4, 2024
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.
Closes #6376
This PR updates the docs-build.yml workflow to update md files that include PR references.
It will loop through all files in the
docs/patches
docs/_posts
directories and rewrite any PR references using the #xxxxx expression and add the PR link.
The script takes 4 parameters. This is so it can be used with other repositories / environments in the future.
FOLDER_NAME - Where the md files are located
ORG_NAME - The github org name
REPO_NAME - The repository name
BASE_HOSTNAME - github.com