Add appName To options for flake. #1993
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mpscholten
reviewed
Jul 26, 2024
flake-module.nix
Outdated
Comment on lines
55
to
62
| appName = lib.mkOption { | ||
| description ='' | ||
| The derivation name. | ||
| Can be omitted if pname and version are set, in which case it is automatically set to ''${pname}-''${version}. | ||
| ''; | ||
| type= lib.types.str; | ||
| default="app"; | ||
| }; |
There was a problem hiding this comment.
The indentation here is messed up.
Also Can be omitted if pname and version are set, in which case it is automatically set to ''${pname}-''${version}. can be removed
flake-module.nix
Outdated
| @@ -139,6 +148,7 @@ ihpFlake: | |||
| pkgs = pkgs; | |||
| rtsFlags = cfg.rtsFlags; | |||
| optimizationLevel = cfg.optimizationLevel; | |||
| appName=cfg.appName; | |||
There was a problem hiding this comment.
Suggested change
| appName=cfg.appName; | |
| appName = cfg.appName; |
flake-module.nix
Outdated
| @@ -152,6 +162,7 @@ ihpFlake: | |||
| pkgs = pkgs; | |||
| rtsFlags = cfg.rtsFlags; | |||
| optimizationLevel = "0"; | |||
| appName=cfg.appName; | |||
There was a problem hiding this comment.
Suggested change
| appName=cfg.appName; | |
| appName = cfg.appName; |
|
Fixed comments, indentation and whitespace. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When hosting multiple ihp apps on a particular server it is helpful for debugging/maintenance/tooling to be able to inspect which binaries are in the production servers /nix/store by their name (not just hash). This is consistent with all other nixpkgs that contain the hash and the package name in the store.
For managed production clusters it is also nice for roll back to be able to give semver names to app packages so that it is easy to instantly roll back to a prev version of app binary on a prod server if required. This PR adds option of appName to ihp flake-modules so users can specify the appName. The appName option gets passed all the way to ihp's (un)optimized-prod-server package
mkDerivation(where it is callednameand is a standard attribute for nix's mkDerivation.). We could call itnameat the top level so it matches specifically but in the context of the app level flake it is probably less ambiguous to call itappName.Furthermore having an appName option at top level flake has been found useful for a number of other IHP production helpers i.e. scripts to synchronize databases and deploy to servers etc. that can leverage the appName variable as well.