ci: update version in docs & sec pol on release #1293
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
Stratus3D
reviewed
Jul 12, 2022
| set -euo pipefail | ||
|
|
||
| version=$(cat version.txt) | ||
| sed -i "s/\\(git clone.*--branch \\).*\\(\`.*|\\)/\\1v$version\\2/" docs/guide/getting-started.md |
There was a problem hiding this comment.
Does $version need to be escaped before being used in the sed expression?
There was a problem hiding this comment.
In this case no (works locally 😅), I am no sed expert but perhaps it is because it's in the RHS of the substitution?
There was a problem hiding this comment.
Ah yeah, on the RHS I guess we don't have to worry about . becoming a wildcard.
Stratus3D
approved these changes
Jul 12, 2022
jthegedus
commented
Jul 12, 2022
| if ! grep -q "$version_major_minor_x" SECURITY.md; then | ||
| # prepend new version to the list | ||
| sed -i "s/white_check_mark:/x: /g" SECURITY.md | ||
| sed -i "s/^\\(| -* | -* |\\)$/\\1\\n| $version_major_minor_x | :white_check_mark: |/" SECURITY.md |
There was a problem hiding this comment.
The whitespace for the newline is not perfect, but not too messy and the markdown rendering of GitHub resolves the table correctly regardless of whitespace. It's not perfect as version # character length changes across versions 0.9.0 => 0.10.0 etc.
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.
Summary
sedfor replacing version indocs/guide/getting-startedpage. Move to standalone script for easier dev testingmajor.minorversion is found as the current list does not track patch releases. Exec this script in the same CI pipeline as documentation version update so there is only a single auto-commit and avoid potential git race conditions of multiple updates from different jobs or workflows.scripts/filestest/ymluse Bats version from repo.tool-versionsfile and not hardcoded in tests workflow (we're not installing deps in thetest.ymlworkflow via the asdf GH Action as it conflicts with tests somehow/somewhere. probably worth fixing one day).Other Information
I believe this will fix the issues with auto-docs updating defined in #1000 & trigger fixed in #1232