Skip to content

Conversation

@AsCress
Copy link
Contributor

@AsCress AsCress commented Feb 3, 2025

Summary by Sourcery

CI:

  • Zip the release artifact before uploading.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 3, 2025

Reviewer's Guide by Sourcery

This pull request modifies the release process to correctly upload the release asset and exclude the 'dependencies' label from the release drafter.

Sequence diagram for the updated release asset upload process

sequenceDiagram
    participant GH as GitHub Actions
    participant R as GitHub Release

    GH->>GH: Create ZIP archive of firmware
    Note over GH: Zip ESP01Firmware.ino.bin
    GH->>R: Upload ZIP as release asset
    Note over R: Using --clobber to overwrite if exists
Loading

Flow diagram for the modified release drafting process

flowchart LR
    A[PR Merged] --> B[Release Drafter]
    B --> C{Check Labels}
    C -->|dependencies label| D[Exclude from Release Notes]
    C -->|Other labels| E[Include in Release Notes]
    E --> F[Draft Release]
    D --> F
Loading

File-Level Changes

Change Details Files
The release asset is now zipped before being uploaded.
  • Added a step to zip the binary before uploading it.
  • Modified the upload command to upload the zip file.
.github/workflows/compile.yml
The 'dependencies' label is now excluded from the release drafter.
  • Changed the 'Dependencies' label to 'dependencies' in the exclude-labels section.
.github/release-drafter.yml

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@AsCress AsCress requested a review from bessman February 3, 2025 10:46
Copy link

@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 @AsCress - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@AsCress AsCress added the fix label Feb 3, 2025
@bessman
Copy link
Contributor

bessman commented Feb 3, 2025

This PR is labelled 'Fix'. We should standardize whether labels are lower-case or upper-case. I suggest lower-case, since Github's default labels are lower-case.

@AsCress
Copy link
Contributor Author

AsCress commented Feb 3, 2025

@bessman Right. Let's follow lowercase then. I'll update the labels and this PR.

@AsCress AsCress merged commit d108294 into fossasia:main Feb 3, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants