Skip to content

Conversation

@sarika-pf9
Copy link
Collaborator

@sarika-pf9 sarika-pf9 commented Jul 14, 2025

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

image

Manual Trigger

image

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.

@sarika-pf9 sarika-pf9 requested a review from sharma-tapas July 14, 2025 09:57
Copy link
Contributor

@windsurf-bot windsurf-bot bot left a 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".

@bito-code-review
Copy link
Contributor

bito-code-review bot commented Jul 14, 2025

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Documentation - Enhanced Release Notes Workflow

01_update_release_notes.yaml - Streamlined release notes processing with improved version reference updates, automated archiving of old release documentation, and refined PR creation steps.

New Feature - Implemented Manual Docs Backfill

02_backfill_docs.yaml - Introduced a new workflow that facilitates manual backfilling of missing release notes with robust error handling and automated release tag processing.

Copy link
Contributor

@bito-code-review bito-code-review bot left a 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-86
      The 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-95
      The `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

AI Code Review powered by Bito Logo

Copy link
Contributor

@bito-code-review bito-code-review bot left a 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

AI Code Review powered by Bito Logo

@sharma-tapas
Copy link
Collaborator

@sarika-p9 Add testing notes and cases that have been tested.

@github-actions github-actions bot changed the base branch from main to release-v0.1.13 July 14, 2025 11:46
@sarika-pf9 sarika-pf9 changed the base branch from release-v0.1.13 to main July 15, 2025 05:22
@sarika-pf9 sarika-pf9 requested a review from sharma-tapas July 15, 2025 07:53
@bito-code-review
Copy link
Contributor

bito-code-review bot commented Jul 15, 2025

Code Review Agent Run #d5bbf8

Actionable Suggestions - 0
Additional Suggestions - 1
  • .github/workflows/01_update_release_notes.yaml - 1
    • Redundant duplicate condition in GitHub workflow · Line 129-129
      The condition `steps.process_release.outputs.PROCESSED_ANYTHING` was changed to `steps.process_release.outputs.processed_release`, but this creates a duplicate condition that already exists at line 102 for a different step.
      code suggestion
       @@ -129,1 +129,0 @@
      -        if: steps.process_release.outputs.processed_release == 'true'
Review Details
  • Files reviewed - 1 · Commit Range: 93fed2b..dc762f3
    • .github/workflows/01_update_release_notes.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

AI Code Review powered by Bito Logo

@OmkarDeshpande7 OmkarDeshpande7 enabled auto-merge (squash) July 16, 2025 10:44
@OmkarDeshpande7 OmkarDeshpande7 disabled auto-merge July 16, 2025 10:52
@OmkarDeshpande7 OmkarDeshpande7 merged commit 05d53ee into main Jul 16, 2025
12 checks passed
@OmkarDeshpande7 OmkarDeshpande7 deleted the workflow-change branch July 16, 2025 10:52
@bito-code-review
Copy link
Contributor

bito-code-review bot commented Jul 16, 2025

Bito Review Skipped - Source Branch Not Found

Bito didn’t review this change because the pull request is no longer valid. It may have been merged, or the source/target branch may no longer exist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix Release Notes workflow to update docs automatically

4 participants