Skip to content

ci: improve the release template#1038

Merged
tbouffard merged 1 commit into
mainfrom
ci/improve_release_notes_template
Apr 1, 2026
Merged

ci: improve the release template#1038
tbouffard merged 1 commit into
mainfrom
ci/improve_release_notes_template

Conversation

@redfish4ktc

@redfish4ktc redfish4ktc commented Apr 1, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member
  • Add bundle size tables (maxGraph repo + integration examples)
  • Move resources section to the end (not the most important part for end user)

Summary by CodeRabbit

  • Documentation
    • Enhanced release notes template with improved structure and organization.
    • Added bundle size reduction tracking to release information.
    • Streamlined resource references in release documentation.

@redfish4ktc
ci: improve the release template
be4e91f 
- Add bundle size tables (maxGraph repo + integration examples)
- Move resources section to the end (not the most important part for end user)
@redfish4ktc redfish4ktc added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Apr 1, 2026
@coderabbitai

coderabbitai Bot commented Apr 1, 2026 •
edited
Loading

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14122658-b23e-44ce-a9f0-6d8f46adda40

📥 Commits

Reviewing files that changed from the base of the PR and between 50cb652 and be4e91f.

📒 Files selected for processing (1)
  • .github/workflows/create-github-release.yml

Walkthrough

The GitHub release workflow template was restructured to reorganize the release notes format. The "Resources" section was relocated, and new "Bundle size reduction" sections with per-example size tables were added. The release note admonition block was replaced with plain text reference formatting.

Changes

Cohort / File(s) Summary
GitHub Workflow Configuration
.github/workflows/create-github-release.yml		 Restructured release note template by relocating the "Resources" section, replacing an admonition block with plain text, and adding new "Bundle size reduction" sections with placeholder tables for size metrics from maxGraph and maxgraph-integration-examples repositories.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • PR #593: Modifies the same workflow file with overlapping changes to the release-notes template structure and milestone-related content.
  • PR #996: Updates the same workflow with new jobs to build and attach website and examples artifacts to releases.
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is incomplete. It lacks required sections: PR Checklist, detailed Overview explaining the problem/benefit, and issue reference. Only brief bullet points are provided. Complete the PR description by filling in the PR Checklist, providing a detailed Overview section explaining why these template changes improve the release process, and referencing the related issue.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'ci: improve the release template' directly relates to the main change: restructuring the GitHub release template by adding bundle size tables and reordering sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud

sonarqubecloud Bot commented Apr 1, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@tbouffard
tbouffard merged commit ad12da6 into main Apr 1, 2026
6 checks passed
@tbouffard
tbouffard deleted the ci/improve_release_notes_template branch April 1, 2026 14:38
@coderabbitai coderabbitai Bot mentioned this pull request Jul 8, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@redfish4ktc @tbouffard