Skip to content

Minor fixes to release checklist generator #6976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

albertteoh
Copy link
Contributor

@albertteoh albertteoh commented Apr 4, 2025

Description of the changes

  • Discovered some small issues while running the scripts/release/start.sh script.

How was this change tested?

Checklist

  • I have signed all commits

@albertteoh albertteoh requested a review from a team as a code owner April 4, 2025 22:28
@albertteoh albertteoh requested a review from jkowall April 4, 2025 22:28
Copy link

codecov bot commented Apr 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.97%. Comparing base (3ac7317) to head (8d06339).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6976   +/-   ##
=======================================
  Coverage   95.97%   95.97%           
=======================================
  Files         345      345           
  Lines       20377    20377           
=======================================
  Hits        19556    19556           
  Misses        618      618           
  Partials      203      203           
Flag Coverage Δ
badger_v1 10.53% <ø> (ø)
badger_v2 2.18% <ø> (ø)
cassandra-4.x-v1-manual 15.84% <ø> (ø)
cassandra-4.x-v2-auto 2.17% <ø> (ø)
cassandra-4.x-v2-manual 2.17% <ø> (ø)
cassandra-5.x-v1-manual 15.84% <ø> (ø)
cassandra-5.x-v2-auto 2.17% <ø> (ø)
cassandra-5.x-v2-manual 2.17% <ø> (ø)
elasticsearch-6.x-v1 20.76% <ø> (ø)
elasticsearch-7.x-v1 20.84% <ø> (ø)
elasticsearch-8.x-v1 21.02% <ø> (ø)
elasticsearch-8.x-v2 2.18% <ø> (ø)
grpc_v1 11.61% <ø> (ø)
grpc_v2 8.47% <ø> (ø)
kafka-3.x-v1 10.82% <ø> (ø)
kafka-3.x-v2 2.18% <ø> (ø)
memory_v2 2.18% <ø> (ø)
opensearch-1.x-v1 20.89% <ø> (ø)
opensearch-2.x-v1 20.89% <ø> (ø)
opensearch-2.x-v2 2.18% <ø> (ø)
tailsampling-processor 0.59% <ø> (ø)
unittests 94.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.


if $dry_run; then
echo "${issue_body}"
else
gh issue create --title "Prepare Jaeger Release ${new_version}" --body "$issue_body"
gh issue create -R jaegertracing/jaeger --title "Prepare Jaeger Release ${new_version}" --body "$issue_body"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was presented with the option of creating the issue on my fork or on jaegertracing. This should remove that additional friction.

@@ -59,12 +59,15 @@ echo "Using new version: ${new_version}"
TMPFILE=$(mktemp "/tmp/DOC_RELEASE.XXXXXX")
wget -O "$TMPFILE" https://raw.githubusercontent.com/jaegertracing/documentation/main/RELEASE.md

issue_body=$(python scripts/utils/formatter.py "${TMPFILE}" "${user_version_v1}" "${user_version_v2}")
# Ensure the UI Release checklist is up to date.
make init-submodules
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a very old version of the jaeger-ui submodule, missing the BEGIN_CHECKLIST comment.
Moreover, this ensures we pick up any changes to the Jaeger UI release process.

# Ensure the UI Release checklist is up to date.
make init-submodules

issue_body=$(python scripts/release/formatter.py "${TMPFILE}" "${user_version_v1}" "${user_version_v2}")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatter.py path had changed from utils to release.

Copy link
Member

@yurishkuro yurishkuro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

We need one more fix to the release/notes.py script to recognize changelog:refactoring label that we recently started using. I'd recommend ⚙️ emoji for it.

@yurishkuro yurishkuro added this pull request to the merge queue Apr 4, 2025
Merged via the queue into jaegertracing:main with commit 622cc37 Apr 4, 2025
56 of 57 checks passed
@albertteoh albertteoh mentioned this pull request Apr 4, 2025
1 task
@albertteoh
Copy link
Contributor Author

Thanks!

We need one more fix to the release/notes.py script to recognize changelog:refactoring label that we recently started using. I'd recommend ⚙️ emoji for it.

Thanks @yurishkuro, added here: #6977

github-merge-queue bot pushed a commit that referenced this pull request Apr 5, 2025
## Which problem is this PR solving?
- Fast follow to this comment:
#6976 (review)

## Checklist
- [x] I have signed all commits

Signed-off-by: albertteoh <[email protected]>
amilbcahat pushed a commit to amilbcahat/jaeger that referenced this pull request May 4, 2025
## Description of the changes
- Discovered some small issues while running the
`scripts/release/start.sh` script.

## How was this change tested?
- Able to successfully create the checklist from a cold start with these
fixes in place: jaegertracing#6975

## Checklist
- [x] I have signed all commits

Signed-off-by: albertteoh <[email protected]>
amilbcahat pushed a commit to amilbcahat/jaeger that referenced this pull request May 4, 2025
## Which problem is this PR solving?
- Fast follow to this comment:
jaegertracing#6976 (review)

## Checklist
- [x] I have signed all commits

Signed-off-by: albertteoh <[email protected]>
amilbcahat pushed a commit to amilbcahat/jaeger that referenced this pull request May 4, 2025
## Description of the changes
- Discovered some small issues while running the
`scripts/release/start.sh` script.

## How was this change tested?
- Able to successfully create the checklist from a cold start with these
fixes in place: jaegertracing#6975

## Checklist
- [x] I have signed all commits

Signed-off-by: albertteoh <[email protected]>
Signed-off-by: amol-verma-allen <[email protected]>
amilbcahat pushed a commit to amilbcahat/jaeger that referenced this pull request May 4, 2025
## Which problem is this PR solving?
- Fast follow to this comment:
jaegertracing#6976 (review)

## Checklist
- [x] I have signed all commits

Signed-off-by: albertteoh <[email protected]>
Signed-off-by: amol-verma-allen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants