Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add build scripts #2572

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Conversation

AsCress
Copy link
Contributor

@AsCress AsCress commented Nov 8, 2024

Adds build scripts to the flutter branch.

Screenshots / Recordings

N/A

Checklist:

  • No hard coding: I have used resources from strings.xml, dimens.xml and colors.xml without hard coding any value.
  • No end of file edits: No modifications done at end of resource files strings.xml, dimens.xml or colors.xml.
  • Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
  • No extra space: My code does not contain any extra lines or extra spaces than the ones that are necessary.

Summary by Sourcery

Build:

  • Add a script to decrypt and extract secrets for the build process.

Copy link

sourcery-ai bot commented Nov 8, 2024

Reviewer's Guide by Sourcery

This PR adds build scripts to handle decryption and extraction of secret files during the build process. The implementation uses OpenSSL for decryption and tar for file extraction, along with proper gitignore settings.

Sequence diagram for build script execution

sequenceDiagram
    participant Developer
    participant BuildServer
    participant OpenSSL
    participant Tar

    Developer->>BuildServer: Trigger build
    BuildServer->>OpenSSL: Decrypt secrets.tar.enc
    OpenSSL-->>BuildServer: Decrypted secrets.tar
    BuildServer->>Tar: Extract secrets.tar
    Tar-->>BuildServer: Extracted files
    BuildServer-->>Developer: Build complete
Loading

File-Level Changes

Change Details Files
Added script for decrypting and extracting secret files
  • Created a shell script that uses OpenSSL to decrypt secrets using environment variables
  • Implemented tar extraction of decrypted secrets to the scripts directory
  • Added error handling with set -e flag
  • Added gitignore to prevent secret files from being committed
scripts/prep-key.sh
scripts/.gitignore

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

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

Overall Comments:

  • The .gitignore file appears to be empty. Please ensure it includes proper exclusions for sensitive files (*.tar, decrypted secrets, etc) to prevent accidental commits of sensitive data.
  • Consider following standardized environment variable naming conventions for encryption keys/IVs (e.g., prefixed with PROJECT_NAME_). Also, adding basic error messages when decryption fails would improve debugging.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 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.

scripts/prep-key.sh Show resolved Hide resolved
Copy link

github-actions bot commented Nov 8, 2024

@adityastic adityastic merged commit 18ea264 into fossasia:flutter Nov 8, 2024
3 of 4 checks passed
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