-
Notifications
You must be signed in to change notification settings - Fork 28
simplified the release notes workflow to update docs #710
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 To request another review, post a new comment with "/windsurf-review".
Changelist by BitoThis pull request implements the following key changes.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review Agent Run #f13f51
Actionable Suggestions - 4
-
.github/workflows/01_update_release_notes.yaml - 2
- Removed parameter without replacing its functionality · Line 18-28
- Missing check for release tag existence · Line 52-53
-
.github/workflows/02_backfill_docs.yaml - 2
- Fragile previous tag identification logic · Line 48-49
- Shell compatibility issue with mapfile command · Line 84-85
Additional Suggestions - 2
-
.github/workflows/02_backfill_docs.yaml - 2
-
Missing directory existence check before writing · Line 86-86The workflow exits early if no versions are found, but doesn't check if the archives directory exists before attempting to write to it. This could lead to failures if the directory doesn't exist.
code suggestion
@@ -86,6 +86,9 @@ mapfile -t ALL_VERSIONS < <(find docs/src/content/docs/release_docs -name "v*.md" -printf "%f\n" | sed -e 's/^v//' -e 's/\.md$//' | sort -V) mapfile -t TOP_5_ARRAY < <(printf '%s\n' "${ALL_VERSIONS[@]}" | tail -n 5) if [ ${#TOP_5_ARRAY[@]} -eq 0 ]; then exit 0; fi + + # Ensure archives directory exists + mkdir -p docs/src/content/docs/archives echo "Keeping Top 5 versions:"; printf 'v%s\n' "${TOP_5_ARRAY[@]}" -
Inconsistent heading level conversion in archiving · Line 95-95The `awk` command for archiving release notes modifies markdown heading levels but doesn't handle potential nested headings correctly. This could lead to inconsistent heading levels in the archived document.
code suggestion
@@ -94,7 +94,7 @@ if [ -f "$FILE_TO_PROCESS" ]; then echo "Archiving and deleting: v${v}.md" - awk 'BEGIN { in_yaml=0 } /^---$/ { in_yaml = !in_yaml; next } in_yaml { if ($1 == "title:") { sub(/^title:[[:space:]]*v/, "## v"); print; }; next; } { sub(/^##/, "###"); print }' "$FILE_TO_PROCESS" >> docs/src/content/docs/archives/release_notes.md + awk 'BEGIN { in_yaml=0 } /^---$/ { in_yaml = !in_yaml; next } in_yaml { if ($1 == "title:") { sub(/^title:[[:space:]]*v/, "## v"); print; }; next; } { sub(/^##([#]*)/, "###\1"); print }' "$FILE_TO_PROCESS" >> docs/src/content/docs/archives/release_notes.md rm "$FILE_TO_PROCESS"
-
Review Details
-
Files reviewed - 2 · Commit Range:
8dba7d0..8dba7d0- .github/workflows/01_update_release_notes.yaml
- .github/workflows/02_backfill_docs.yaml
-
Files skipped - 0
-
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- Eslint (Linter) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Default Agent You can customize the agent settings here or contact your Bito workspace admin at mithil@platform9.com.
Documentation & Help
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review Agent Run #d7b023
Actionable Suggestions - 1
-
.github/workflows/01_update_release_notes.yaml - 1
- Shell script logical OR operator misuse · Line 62-62
Review Details
-
Files reviewed - 2 · Commit Range:
8dba7d0..93fed2b- .github/workflows/01_update_release_notes.yaml
- .github/workflows/02_backfill_docs.yaml
-
Files skipped - 0
-
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Default Agent You can customize the agent settings here or contact your Bito workspace admin at mithil@platform9.com.
Documentation & Help
|
@sarika-p9 Add testing notes and cases that have been tested. |
Code Review Agent Run #d5bbf8Actionable Suggestions - 0Additional Suggestions - 1
Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help |
dc762f3 to
7b53ca7
Compare
|
Bito Review Skipped - Source Branch Not Found |
What this PR does / why we need it
Which issue(s) this PR fixes
(optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged)fixes #712
Special notes for your reviewer
Testing done
Triggered on release
Manual Trigger
Summary by Bito
This PR simplifies release notes and documentation workflows by standardizing release tag handling across GitHub Actions. It consolidates redundant commands, improves commit message clarity, and enhances error handling for both automated and manual processes. The changes streamline version reference updates, introduce a manual backfill process, and ensure a more robust and maintainable documentation flow.