Skip to content

Conversation

@vedansh-5
Copy link
Member

@vedansh-5 vedansh-5 commented Sep 8, 2025

Summary Of Changes

The changes in this PR intends to create a draft whenever a new PR is merged into master and draft a release based on that, which can be published manually. Along with the publish of release it would be automatically zipped and pushed to the Chrome web store.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 8, 2025

Reviewer's Guide

Automates draft release creation and CHANGELOG generation in the release-drafter workflow, commits and tags releases, and enhances the Chrome Web Store publish workflow to use release tags, validate zip contents (including manifest.json), and automatically upload and publish extensions.

Sequence diagram for automated release and Chrome Web Store publish process

sequenceDiagram
  participant Dev as Developer
  participant GH as GitHub
  participant RD as Release Drafter Workflow
  participant PT as Publish to Chrome Workflow
  participant CWS as "Chrome Web Store"

  Dev->>GH: Merge PR to master
  GH->>RD: Trigger release-drafter workflow
  RD->>GH: Create draft release
  RD->>GH: Generate/Prepend CHANGELOG
  RD->>GH: Commit CHANGELOG & create tag
  RD->>GH: Push tag to origin
  GH->>PT: Trigger publish-to-chrome workflow (on release tag)
  PT->>GH: Checkout code at release tag
  PT->>GH: Create ZIP (validate manifest.json)
  PT->>CWS: Upload & publish extension
Loading

Flow diagram for enhanced Chrome Web Store publish workflow

flowchart TD
  A["Release Tag Created"] --> B["Checkout Code at Tag"]
  B --> C["Create ZIP from src/"]
  C --> D["Validate manifest.json at ZIP root"]
  D --> E["Upload & Publish to Chrome Web Store"]
  E --> F["Extension Available on Chrome Web Store"]
Loading

File-Level Changes

Change Details Files
Extend release-drafter workflow to generate and commit CHANGELOG entries and tag releases
  • Add debug step to output release-drafter tag and body
  • Create/prepend new CHANGELOG entries based on draft release body and date
  • Commit updated CHANGELOG and push tags/releases via git actions
.github/workflows/release-drafter.yml
Refine Chrome Web Store workflow to use release tags and validate packaging
  • Checkout code at release.tag_name with full history
  • Ensure src directory exists before zipping
  • Suppress zip output, list and validate contents for manifest.json at root
  • Rename upload step to Upload and Publish to Chrome Web Store
.github/workflows/publish-to-chrome.yml
Update CHANGELOG with initial draft entry
  • Prepend v0.1.2 section with placeholder changes
CHANGELOG.md

Possibly linked issues

  • #0: The PR automates creating the changelog, tagging releases, and publishing to the Chrome Web Store as part of the release process outlined in the issue.
  • Option for setting TRUE/FALSE in the title #1: The PR implements automatic deployment to Chrome Web Store by updating GitHub workflows for release and publishing.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `.github/workflows/publish-to-chrome.yml:27` </location>
<code_context>
+                zip -r ../scrum-helper.zip . >/dev/null
+                echo "Created zip:"
+                unzip -l ../scrum-helper.zip
+                if unzip -l ../scrum-helper.zip | awk '{print $4}' | grep -q '^manifest.json$'; then
+                  echo "mannifest.json is at zip root"
+                else
+                  echo "ERROR: manifest.json NOT at zip root; zip will fail on Chrome Web Store"
</code_context>

<issue_to_address>
Typo in echo statement: 'mannifest.json' should be 'manifest.json'.

Please update the echo statement to use the correct spelling: 'manifest.json'.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
                  echo "mannifest.json is at zip root"
=======
                  echo "manifest.json is at zip root"
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@vedansh-5 vedansh-5 requested a review from hpdang September 8, 2025 09:59
@vedansh-5 vedansh-5 self-assigned this Sep 8, 2025
vedansh-5 and others added 5 commits September 8, 2025 15:29
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Signed-off-by: Vedansh Saini <[email protected]>
Signed-off-by: Vedansh Saini <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: Vedansh Saini <41898282+github-actions[bot]@users.noreply.github.com>
@hpdang hpdang merged commit 2813c7a into fossasia:master Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants