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

fix: add wrapper for nix run .#guardian-ui #556

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Conversation

hensg
Copy link
Contributor

@hensg hensg commented Oct 3, 2024

Add a bash script to handle the execution of nix run .#guardian-ui.

*please, give it a try:

nix build github:hensg/ui/nix-run#guardian-ui
nix run github:hensg/ui/nix-run#guardian-ui

Summary by CodeRabbit

  • New Features

    • Enhanced the guardian-ui package with a new executable script for serving the built application.
    • Improved build process by restructuring output directory and directly copying static files.
  • Bug Fixes

    • Streamlined installation process by removing unnecessary subdirectories.

@hensg hensg requested a review from a team as a code owner October 3, 2024 20:31
Copy link

vercel bot commented Oct 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 8:31pm

Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the flake.nix file, specifically for the guardian-ui package. Key changes include the addition of nodePackages.serve to nativeBuildInputs, a restructuring of the installPhase, and the creation of a new executable script for serving the built application. The output directory is simplified, and static files are copied directly to the output without an intermediate subdirectory. Comments regarding the sha256 hash update process have also been reformatted for clarity.

Changes

File Change Summary
flake.nix - Added nodePackages.serve to nativeBuildInputs.
- Changed mkdir -p $out/scripts to mkdir -p $out.
- Updated cp command to copy files directly to $out.
- Added mkdir -p $out/bin.
- Created executable script guardian-ui in $out/bin to serve the application.
- Reformatted comments regarding sha256 hash update process.

Possibly related PRs

  • fix: NixOS package build #555: The changes in this PR also involve modifications to the flake.nix file, specifically related to the guardian-ui package, including updates to the installPhase and handling of dependencies, which are directly relevant to the changes made in the main PR.

Suggested reviewers

  • dpc
  • Kodylow

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 25da553 and 70c90a2.

📒 Files selected for processing (1)
  • flake.nix (3 hunks)
🔇 Additional comments (1)
flake.nix (1)

95-98: LGTM: Wrapper script implementation looks correct.

The new executable script correctly implements the wrapper for "nix run .#guardian-ui" as intended.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Comment on lines -92 to -93
cp -r scripts/replace-react-env.js $out/scripts/replace-react-env.js
cp -r scripts/write-config-from-env.js $out/scripts/write-config-from-env.js
Copy link
Contributor Author

@hensg hensg Oct 3, 2024

Choose a reason for hiding this comment

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

These files works for docker by replacing config.json with envs here:

ui/Dockerfile

Lines 35 to 37 in 25da553

COPY scripts/write-config-from-env.js scripts/write-config-from-env.js
RUN yarn global add serve
CMD node scripts/write-config-from-env.js build && serve -s build

However, it doesn't make sense for NixOS (read-only filesystem). It should be generated via nix, ref:
https://github.com/fedimint/nixos-deployment/blob/master/configuration.nix#L168-L176

Copy link
Contributor

@dpc dpc left a comment

Choose a reason for hiding this comment

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

Best thing ever.

@dpc dpc merged commit c609b2e into fedimint:master Oct 4, 2024
3 checks passed
@hensg hensg deleted the nix-run branch October 4, 2024 10:51
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