Skip to content

Conversation

Vishveshwara
Copy link
Contributor

@Vishveshwara Vishveshwara commented Sep 8, 2025

Fixes: #181

Summary by Sourcery

Add CI pipelines to build and deploy Flutter app for Debian, macOS, Windows, and Web platforms

New Features:

  • Add Debian build job for Flutter app
  • Add macOS build job for Flutter app
  • Add Windows build job for Flutter app
  • Add Web build job for Flutter app

Enhancements:

  • Create composite GitHub Actions for Debian, macOS, Windows, and Web builds

CI:

  • Extend push and pull_request workflows with new platform build jobs
  • Upload build artifacts and auto-push platform-specific builds to the app branch

Copy link
Contributor

sourcery-ai bot commented Sep 8, 2025

Reviewer's Guide

This PR extends both push and pull_request GitHub workflows to support cross-platform Flutter builds for Windows, macOS, Debian, and Web by introducing new CI jobs, composite actions for each platform, artifact uploads, and automated publishing to the 'app' branch.

Flow diagram for new build and publish process for each platform

flowchart TD
  checkout["Checkout Source Code"] --> setup_flutter["Set up Flutter"]
  setup_flutter --> build_app["Build App (platform-specific)"]
  build_app --> upload_artifact["Upload Build Artifact"]
  upload_artifact --> push_app_branch["Push Build to 'app' branch"]
Loading

File-Level Changes

Change Details Files
Added platform-specific build jobs to the push workflow
  • Defined new jobs for Debian, macOS, Windows, and Web runs
  • Invoked corresponding composite actions with version inputs
  • Uploaded build artifacts via upload-artifact
  • Automated cloning and force-pushing artifacts to the app branch
.github/workflows/push.yml
Extended pull_request workflow to preview platform builds
  • Added macOS, Windows, Debian, and Web build steps
  • Referenced the new composite actions for each platform
.github/workflows/pull_request.yml
Introduced composite GitHub Actions for each platform build
  • Set up Flutter environment in each action
  • Installed Linux dependencies in Debian action
  • Executed flutter build commands per platform
.github/actions/debian/action.yml
.github/actions/macos/action.yml
.github/actions/windows/action.yml
.github/actions/web/action.yml

Possibly linked issues


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 - here's some feedback:

Blocking issues:

  • An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
  • An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
  • An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
  • An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)

General comments:

  • Extract the repeated “Push Build to app branch” shell logic into a reusable composite action or step to reduce duplication across all platforms.
  • The Web build job’s push step is missing the final git push --force origin app—add it to keep consistency with the other platform workflows.
  • Consider using a matrix strategy for your per-platform jobs instead of copying identical steps to DRY up the workflow file.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Extract the repeated “Push Build to app branch” shell logic into a reusable composite action or step to reduce duplication across all platforms.
- The Web build job’s push step is missing the final `git push --force origin app`—add it to keep consistency with the other platform workflows.
- Consider using a matrix strategy for your per-platform jobs instead of copying identical steps to DRY up the workflow file.

## Security Issues

### Issue 1
<location> `.github/actions/debian/action.yml:17` </location>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

### Issue 2
<location> `.github/actions/macos/action.yml:17` </location>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

### Issue 3
<location> `.github/actions/web/action.yml:17` </location>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

### Issue 4
<location> `.github/actions/windows/action.yml:17` </location>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

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.

Copy link
Contributor

github-actions bot commented Sep 8, 2025

Build Status

Build successful. APKs to test: https://github.com/fossasia/magic-epaper-app/actions/runs/17798026080/artifacts/4034570206.

Screenshots

Android Screenshots
iPhone Screenshots
iPad Screenshots

Copy link
Collaborator

@AsCress AsCress left a comment

Choose a reason for hiding this comment

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

We shouldn't just plainly push the files to the app branch. We should instead package them into installers and then push them.
See for example, in Windows: fossasia/pslab-app#2896.

You can figure out similarly for Linux packages (.deb, .rpm). For macOS, pushing the .app should be enough.

@Vishveshwara
Copy link
Contributor Author

We shouldn't just plainly push the files to the app branch. We should instead package them into installers and then push them. See for example, in Windows: fossasia/pslab-app#2896.

You can figure out similarly for Linux packages (.deb, .rpm). For macOS, pushing the .app should be enough.

Oh okay will do it, thanks.

@Vishveshwara Vishveshwara changed the title chore: Added app builds for Windows, macOS, Debian, Web chore: Added app builds for Windows, macOS, Linux Sep 16, 2025
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.

New security issues found

@hpdang
Copy link
Member

hpdang commented Oct 15, 2025

@Dhruv1797 please test this, thank you

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.

Add automated app builds for all supported platforms

4 participants