Skip to content

feat: improve changelog creation and auto label pr's#1146

Draft
Sim-sat wants to merge 2 commits intoCodeWithCJ:mainfrom
Sim-sat:improve-changelog
Draft

feat: improve changelog creation and auto label pr's#1146
Sim-sat wants to merge 2 commits intoCodeWithCJ:mainfrom
Sim-sat:improve-changelog

Conversation

@Sim-sat
Copy link
Copy Markdown
Contributor

@Sim-sat Sim-sat commented Apr 18, 2026

Description

What problem does this PR solve?
What problem does this PR solve?
The current changelogs are difficult to read because they lack categorization and include technical debt or chores that provide no value to end-users.

How did you implement the solution?
I have improved the native GitHub release auto-generation by adding a release.yml configuration and a workflow that automatically labels PRs based on their titles and selected checkboxes. This automates organized changelogs without requiring manual intervention. I also improved the pr validation to make it a little bit less strict and to post a comment to make it easier to understand errors..

Suggested Label Updates

@CodeWithCJ I suggest creating the following labels to optimize categorization:

  • ​skip-changelog (To hide internal chores/refactors from users)
  • ​mobile
  • ​frontend
  • ​backend
  • ​security
  • ​refactor

    The mobile, frontend, and backend labels would only be used for making it easier for us to keep an overview, because github doesn't support nesting the categories in the changelog template.

Linked Issue: #

How to Test

  1. Check out this branch and run ...
  2. Navigate to...
  3. Verify that...

PR Type

  • Issue (bug fix)
  • New Feature
  • Refactor
  • Documentation

Checklist

All PRs:

  • [MANDATORY - ALL] Integrity & License: I certify this is my own work, free of malicious code, and I agree to the License terms.

New features only:

  • [MANDATORY for new feature] Alignment: I have raised a GitHub issue and it was reviewed/approved by maintainers or it was approved on Discord.

Frontend changes (SparkyFitnessFrontend/ or src/):

  • [MANDATORY for Frontend changes] Quality: I have run pnpm run validate and it passes.
  • [MANDATORY for Frontend changes] Translations: I have only updated the English (en) translation file.

Backend changes (SparkyFitnessServer/):

  • [MANDATORY for Backend changes] Code Quality: I have run typecheck, lint, and tests. New files use TypeScript, new endpoints have Zod schemas, and new endpoints include tests.
  • [MANDATORY for Backend changes] Database Security: I have updated rls_policies.sql for any new user-specific tables.

UI changes (components, screens, pages):

  • [MANDATORY for UI changes] Screenshots: I have attached Before/After screenshots below.

Screenshots

image image image

Notes for Reviewers

Optional — use this for anything that doesn't fit above: known tradeoffs, areas you'd like specific feedback on, qustions you have or context that helps reviewers.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist 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

This pull request introduces a .github/release.yml configuration file to automate the generation of release notes. The review feedback suggests expanding the exclusion list to include non-user-facing labels such as refactor and backend, and adding specific categories for Security, Mobile, and Frontend to better organize the changelog output.

Comment thread .github/release.yml
Comment thread .github/release.yml
@Sim-sat Sim-sat marked this pull request as draft April 18, 2026 19:34
@Sim-sat Sim-sat force-pushed the improve-changelog branch from f786b30 to 63ae43a Compare April 19, 2026 07:13
@Sim-sat Sim-sat force-pushed the improve-changelog branch from 63ae43a to 1a85eeb Compare April 19, 2026 07:16
@Sim-sat Sim-sat force-pushed the improve-changelog branch from 646c0e4 to 03bc5ce Compare April 19, 2026 07:28
@Sim-sat
Copy link
Copy Markdown
Contributor Author

Sim-sat commented Apr 19, 2026

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist 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

This pull request updates the pull request template to include a mobile changes section and standardizes the linked issue format. It also introduces a configuration for automated release changelogs. Feedback points out that the PR description mentions automation workflows that are not included in the changes. Additionally, suggestions were made to add quality and translation checkboxes to the mobile section of the template and to exclude 'chore' and 'dependencies' labels from the release changelog.

Comment thread .github/pull_request_template.md
Comment thread .github/pull_request_template.md
Comment thread .github/release.yml
@CodeWithCJ
Copy link
Copy Markdown
Owner

Is this still in draft?

@Sim-sat
Copy link
Copy Markdown
Contributor Author

Sim-sat commented Apr 19, 2026

Is this still in draft?

It's working, I tested it on my fork, but I wanted to wait until you created the labels. I don't know what happens when they dont exist

@CodeWithCJ
Copy link
Copy Markdown
Owner

My bad. I didn't read the PR completely. Currently on mobile. I'm afraid I can do this only next weekend.

@Sim-sat
Copy link
Copy Markdown
Contributor Author

Sim-sat commented Apr 19, 2026

Yeah don't worry it's not that important. Just tell me that when you add them

My bad. I didn't read the PR completely. Currently on mobile. I'm afraid I can do this only next weekend.

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.

2 participants