Ensure docs gen inserts at correct place in file #18250
Merged
+1
−1
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
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found.
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
|
This pull request does not have a backport label. Could you fix it @donoghuc? 🙏
|
donoghuc
commented
Oct 1, 2025
| coming_tag_index = release_notes.find_index {|line| line.match(/^## #{current_release} \[logstash-#{current_release}-release-notes\]$/) } | ||
| coming_tag_index += 1 if coming_tag_index | ||
| release_notes_entry_index = coming_tag_index || release_notes.find_index {|line| line.match(/\[logstash-\d+-release-notes\]$/) } | ||
| release_notes_entry_index = coming_tag_index || release_notes.find_index {|line| line.match(/^## .*\[logstash-.*-release-notes\]$/) } |
There was a problem hiding this comment.
This is a "fallback" when the current version does not have an entry yet (IE no coming_tag_index). I quote "fallback" because this is actually the most likely case given our workflows. See below for irb session showing the bug and the fix
irb(main):025:0> release_notes.find_index {|line| line.match(/\[logstash-\d+-release-notes\]$/) }
=> 291
irb(main):030:0> release_notes.find_index {|line| line.match(/^## .*\[logstash-.*-release-notes\]$/) }
=> 23
donoghuc
added
the
backport-active-all
💛 Build succeeded, but was flaky
Failed CI Steps |
|
@Mergifyio backport 8.18 8.19 9.0 9.1 9.2 |
✅ Backports have been created
|
mergify bot
pushed a commit
that referenced
this pull request
Oct 2, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2) # Conflicts: # tools/release/generate_release_notes_md.rb
mergify bot
pushed a commit
that referenced
this pull request
Oct 2, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2)
mergify bot
pushed a commit
that referenced
this pull request
Oct 2, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2) # Conflicts: # tools/release/generate_release_notes_md.rb
mergify bot
pushed a commit
that referenced
this pull request
Oct 2, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2)
mergify bot
pushed a commit
that referenced
this pull request
Oct 2, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2)
This was referenced Oct 2, 2025
donoghuc
added a commit
that referenced
this pull request
Oct 6, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2) Co-authored-by: Cas Donoghue <[email protected]>
donoghuc
added a commit
that referenced
this pull request
Oct 6, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2) Co-authored-by: Cas Donoghue <[email protected]>
donoghuc
added a commit
that referenced
this pull request
Oct 6, 2025
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found. (cherry picked from commit a3228e2) Co-authored-by: Cas Donoghue <[email protected]>
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.
The regex for finding the latest release (as a fallback when current is not in the file) had a bug. This caused the generated docs to be inserted at the wrong place in the file (the end of the file) instead of the top. This commit fixes the logic such that we find the last release when the current is not found.
Closes #17952