Update post-release-updates GitHub Actions workflow to delete all trailing newlines from Release-testing-instructions.md before adding new entries. #8719
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
…iling newlines from Release-testing-instructions.md before adding new entries.
Test the buildOption 1. Jetpack Beta
Option 2. Jurassic Ninja - available for logged-in A12s🚀 Launch a JN site with this branch 🚀 ℹ️ Install this Tampermonkey script to get more options. Build info:
Note: the build is updated when a new commit is pushed to this PR. |
|
Size Change: 0 B Total Size: 1.25 MB ℹ️ View Unchanged
|
marcinbot
approved these changes
Apr 26, 2024
| @@ -155,8 +155,10 @@ jobs: | |||
| echo ":warning: File "$NEXT_RELEASE_VERSION_INSTRUCTIONS_FILENAME.md" already exists. No action needed." >> $GITHUB_STEP_SUMMARY | |||
| fi | |||
|
|
|||
| # If an entry for the next version doesn't exist yet | |||
| # Check if this release version exists in Release-testing-instructions.md | |||
| # If not, remove all trailing newlines and add the new version for this release | |||
There was a problem hiding this comment.
Nitpick: let's move this comment closer to the perl command below.
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.
Fixes #6816
Context of the issue
The Release Testing Instructions are automatically updated after every release thanks to the Handle post-release steps GitHub Actions workflow.
If we look at the document history, we can see some versions where the bullet list format looks wrong. Examples:
This happened when there was a line break between the list and the new item added:
[line break]
The initial thought was that the script that adds a new entry with the new release version to Release Testing Instructions had a bug that added a double line break somewhere, but after a deeper investigation, it seems the script works well - it doesn't add any double line break - but the line break was added as part of manual updates on the page.
If we take a closer look at the page history, we can see 2 different kinds of titles:
The format issue appeared inconsistently, but we can spot a pattern there: It appeared once the process was automated and only on the upcoming of certain manual updates. We can see a manual update in ba27137 and then the wrong format in the following automated update in 389d121. Therefore, we can confirm that this format issue appeared when a manual updated added a line break and then the script continue adding entries to the document. We can see this pattern repeated multiple times, and you can check that the line breaks are indeed in the document if you clone the wiki locally and check the history.
Changes proposed in this Pull Request
Even though the script is fine and the problem is caused by manual updates, there is a way to make the script more robust and avoid this problem from happening again.
This PR updates the
post-release-updates.ymlworkflow to make sure theupdate-wikijob trims any trailing line breaks at the bottom of theRelease-testing-instructionsdocument before adding an entry for the new release.Testing instructions
In order to improve the testability of this PR - as GitHub Actions can be tricky to test - I've created a Dockerfile that you can use locally to simulate the behaviour of these changes running on GitHub Actions. In order to be as similar as possible to the GitHub Actions set up, this Dockerfile runs on
ubuntu:latestand usesbash.Release-testing-instructions.md.Dockerfileand place it in the same path as the markdown above.docker build -t update-md ..docker run --rm -v "$(pwd)":/app update-md.Updated-Release-testing-instructions.md.Release-testing-instructions.mdandUpdated-Release-testing-instructions.md. Check thatUpdated-Release-testing-instructions.mdno longer has the trailing line breaks fromRelease-testing-instructions.mdat the bottom of the file and instead it has a new release entry:* [v9.9.9](https://github.com/Automattic/woocommerce-payments/wiki/Release-testing-instructions-for-WC-Payments-9.9.9)npm run changelogto add a changelog file, choosepatchto leave it empty if the change is not significant. You can add multiple changelog files in one PR by running this command a few times.Post merge