[MINOR] release workflows corrected also added publish workflows #226
Conversation
Signed-off-by: Vedansh Saini <[email protected]>
Reviewer's GuideStreamlines release automation: refactors the release-drafter workflow with automated changelog commits, standardizes the release-drafter config template, and adds a new workflow to publish the extension to the Chrome Web Store. Flow diagram for automated release and changelog update processflowchart TD
PR[Pull Request Merged to master]
RD[Release Drafter Action]
CL[Update Changelog]
CP[Commit & Push Changelog]
TG[Create Tag]
PR --> RD
RD --> CL
CL --> CP
CP --> TG
Flow diagram for Chrome Web Store publish workflowflowchart TD
Release[Release Published]
CO[Checkout Code]
ZIP[Create ZIP of src/]
UP[Upload to Chrome Web Store]
Release --> CO
CO --> ZIP
ZIP --> UP
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @vedansh-5 - I've reviewed your changes - here's some feedback:
- Your changelog commit is pushed back to master and will retrigger the
release-drafterjob, creating a loop—consider addingpaths-ignore: ['CHANGELOG.md']underon.pushto prevent recursion. - The
exclude-labels:key in.github/release-drafter.ymlis empty—either remove it or provide values to avoid a malformed config file. - To guard against unintended breakages, pin third-party actions to full SHAs or specific patch versions rather than loose tags like
@v6or@v5.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Your changelog commit is pushed back to master and will retrigger the `release-drafter` job, creating a loop—consider adding `paths-ignore: ['CHANGELOG.md']` under `on.push` to prevent recursion.
- The `exclude-labels:` key in `.github/release-drafter.yml` is empty—either remove it or provide values to avoid a malformed config file.
- To guard against unintended breakages, pin third-party actions to full SHAs or specific patch versions rather than loose tags like `@v6` or `@v5`.
## Individual Comments
### Comment 1
<location> `.github/workflows/release-drafter.yml:60` </location>
<code_context>
+ mv new_changelog_entry.md CHANGELOG.md
+
+ # Commits the updated CHANGELOG.md and creates a tag for the new version
+ - name: Commit and Push Changelog
+ uses: stefanzweifel/git-auto-commit-action@v5
+ with:
+ commit_message: 'docs: Update CHANGELOG.md for ${{ steps.release_drafter.outputs.tag_name }}'
+ file_pattern: 'CHANGELOG.md'
+ tagging_message: ${{ steps.release_drafter.outputs.tag_name }}
+
+
</code_context>
<issue_to_address>
Automatically committing and tagging from within the workflow may create tags that conflict with those created by the release-drafter action.
Coordinate tag creation between this step and the release-drafter action to avoid duplicate tags or push errors. Consider adding logic to skip tag creation if the tag already exists.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| uses: stefanzweifel/git-auto-commit-action@v5 | ||
| with: | ||
| commit_message: 'docs: Update CHANGELOG.md for ${{ steps.release_drafter.outputs.tag_name }}' | ||
| file_pattern: 'CHANGELOG.md' | ||
| tagging_message: ${{ steps.release_drafter.outputs.tag_name }} |
There was a problem hiding this comment.
issue (bug_risk): Automatically committing and tagging from within the workflow may create tags that conflict with those created by the release-drafter action.
Coordinate tag creation between this step and the release-drafter action to avoid duplicate tags or push errors. Consider adding logic to skip tag creation if the tag already exists.
Signed-off-by: Vedansh Saini <[email protected]>
|
@hpdang @Preeti9764 Please add MAJOR, MINOR and PATCH in the titles of all the PRs that we have been merged or are still open, details on the same in readme changes in this PR. Thankyou :> |
Signed-off-by: Vedansh Saini <[email protected]>
|
@hpdang This branch can be force-merged successfully, the failing job is a result of the current workflow, I have fixed the concerning code in this PR. thankyou |
@vedansh-5 I think having the PR title with these labels are not so ideal. According to your README, I assume we can use GitHub label instead? I can create a new set of GitHub label. I am thinking to add also "release:none", so we will have the following labels:
And do we need to enforce PR labels on each single PR? I am also concerned that newcomers might not know which label is appropriate. What is your opinion? |
|
And in the README, could you please also add a section explaining the release process? |
Signed-off-by: Vedansh Saini <[email protected]>
Signed-off-by: Vedansh Saini <[email protected]>
Signed-off-by: Vedansh Saini <[email protected]>
I have made changes in the workflow to prioritize using the same labels you mentioned here and use the older MAJOR, MINOR, PATCH method as a fallback. |
|
@hpdang I think adding a contributing guide for this project will be a good idea, I have created a draft for the same, lmk if you'd like to see it, I can raise a PR. Thankyou |
📌 Fixes
Fixes #85
📝 Summary of Changes
In this Pull Request I have added workflows that corrects the releases and draft notes, On each PR merge a new release will be drafted and tags will be updated based on semantic versioning and when we manually publish the release it will also be published to chrome web store.
📸 Screenshots / Demo (if UI-related)
Add screenshots, video, or link to deployed preview if applicable
✅ Checklist
👀 Reviewer Notes
Add any special notes for the reviewer here
Summary by Sourcery
Streamline release process by correcting release-drafter workflow to draft and tag new releases, automating CHANGELOG.md updates, and adding a publish workflow to deploy the extension to the Chrome Web Store
New Features:
Bug Fixes:
Enhancements:
CI: