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

feat: customize application configuration #7693

Closed
wants to merge 10 commits into from

Conversation

LucasXu0
Copy link
Collaborator

@LucasXu0 LucasXu0 commented Apr 7, 2025

Feature Preview

Allow self-hosters to customize the application information, including the app name, app icon, and application id.

  • Shared
    • i18n
    • icon
    • font
  • Windows
    • Runner.rc
    • app_icon.ico
    • CMakeLists.txt
    • main.cpp
  • macOS
  • Linux
  • iOS
  • Android

PR Checklist

  • My code adheres to AppFlowy's Conventions
  • I've listed at least one issue that this PR fixes in the description above.
  • I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
  • All existing tests are passing.

Copy link

sourcery-ai bot commented Apr 7, 2025

Reviewer's Guide by Sourcery

This pull request introduces a shell script to customize the application configuration for Windows builds, including the application name, identifier, company name, copyright, and icon. It also updates the default binary name in the CMakeLists.txt file.

Sequence diagram for customizing Windows application configuration

sequenceDiagram
    participant S as Shell Script
    participant RC as Runner.rc
    participant CML as CMakeLists.txt
    participant CPP as main.cpp
    participant ICO as Icon File

    S->>RC: Update CompanyName, FileDescription, InternalName, OriginalFilename, LegalCopyright, ProductName
    S->>CML: Update BINARY_NAME
    S->>CPP: Update Mutex Name, Window Title, App Link
    S->>ICO: Copy new icon
Loading

File-Level Changes

Change Details Files
Introduces a shell script for white-labeling Windows Flutter applications, allowing customization of application name, identifier, company name, copyright, and icon.
  • Added a new shell script scripts/white_label/windows_white_label.sh.
  • The script parses command-line arguments for customization options.
  • The script updates the application name, company name, copyright information in Runner.rc.
  • The script copies the provided icon to the resources directory.
  • The script updates the binary name in CMakeLists.txt.
  • The script updates the mutex name and window name in main.cpp.
scripts/white_label/windows_white_label.sh
frontend/appflowy_flutter/windows/runner/Runner.rc
frontend/appflowy_flutter/windows/CMakeLists.txt
frontend/appflowy_flutter/windows/main.cpp
Updates the default binary name in the CMakeLists.txt file.
  • Changed the default binary name from "AppFlowy" to "MyProduct" in CMakeLists.txt.
frontend/appflowy_flutter/windows/CMakeLists.txt

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

@LucasXu0 LucasXu0 marked this pull request as draft April 7, 2025 03:50
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 @LucasXu0 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a rollback mechanism to the script to revert changes in case of errors.
  • The script should check if the sed command was successful and exit if it fails.
Here's what I looked at during the review
  • 🟡 General issues: 4 issues found
  • 🟢 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.

@LucasXu0 LucasXu0 force-pushed the self_hosted_logo_name branch from d3ab621 to 6ec5707 Compare April 7, 2025 03:54
Copy link

github-actions bot commented Apr 7, 2025

🥷 Ninja i18n – 🛎️ Translations need to be updated

Project /project.inlang

lint rule new reports level link
Identical pattern 4 warning contribute (via Fink 🐦)
Missing translation 136 warning contribute (via Fink 🐦)

@LucasXu0 LucasXu0 force-pushed the self_hosted_logo_name branch from 2fcf41d to a0faeba Compare April 7, 2025 06:46
@LucasXu0
Copy link
Collaborator Author

LucasXu0 commented Apr 8, 2025

#7706

@LucasXu0 LucasXu0 closed this Apr 8, 2025
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.

1 participant