[ci] Use pipeline to update gather-docs.yaml during releases #7546
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
|
Maybe calling this script in core-build.yaml instead could be better? Then the condition would just be to run this script as long as the package publish step runs? I think I like that idea better than running the script in the release pipeline, but not entirely sold on either. |
| const currentBranch = "refs/heads/release/1.2.x"; | ||
| // Test for when file needs to be updated | ||
| let filePath = createTempFile("should-change.txt", "branchName: refs/heads/release/0.0.x"); | ||
| console.assert(checkFile(filePath, currentBranch) === true, "File should be updated"); |
There was a problem hiding this comment.
Maybe should check that the file contains the proper branch 'branchName: refs/heads/release/1.2.x'
|
|
||
| function main() { | ||
| const filePath = path.normalize("./common/config/azure-pipelines/templates/gather-docs.yaml") | ||
| const currentBranch = process.env.CURRENT_BRANCH; |
There was a problem hiding this comment.
Should we also add a quick sanity check here to make sure the new branchName also follows 'refs/heads/release/\d+.\d+.x/gi' before we update it?
There was a problem hiding this comment.
Good idea, this should be an easy way to make sure its not master branch or something
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.
Use a script to find and replace the branchName in gather-docs.ymal file.
We would want to run this script whenever we publish build artifacts on a release branch, this is because the first time we build on a new release branch we target the previous release branch. Once that build publishes artifacts we want to update the yml file to the current release branch.
I created a new yaml file to trigger this, which runs every time we publish an artifact during the itwin.js builds. Don't know if this is the best way to call the script. Maybe just putting it at the end of the release pipeline which has a similar trigger, however that lives in the imodeljs-build-pipeline-scripts repo.