-
Notifications
You must be signed in to change notification settings - Fork 98
refactor: the install.sh derivation #567
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,112 +1,51 @@ | ||
| { pkgs ? import ../nix { inherit system; } | ||
| , system ? builtins.currentSystem | ||
| , src ? null | ||
| , releaseVersion ? "latest" | ||
| , src ? builtins.fetchGit ../. | ||
| }: | ||
|
|
||
| let | ||
| public = pkgs.lib.noNixFiles (pkgs.lib.gitOnlySource ../. "public"); | ||
| version = releaseVersion; | ||
| gitDir = pkgs.lib.gitDir ../.; | ||
| in | ||
|
|
||
| rec { | ||
| install-sh = | ||
| pkgs.runCommandNoCC "install-sh" { | ||
| inherit public; | ||
| install = | ||
| pkgs.runCommandNoCC "install.sh.template" { | ||
| src = pkgs.lib.gitOnlySource ../. ./install; | ||
| preferLocalBuild = true; | ||
| allowSubstitutes = false; | ||
| nativeBuildInputs = [ pkgs.shfmt pkgs.shellcheck ]; | ||
| allowedReferences = []; | ||
| } '' | ||
| # git describe --abbrev=7 --tags | ||
| mkdir -p $out | ||
| echo "Running shellcheck..." | ||
| shellcheck --shell=sh $src/*.sh \ | ||
| --exclude SC2039 \ | ||
| --exclude SC2154 \ | ||
| --exclude SC2034 | ||
|
|
||
| echo "Running shfmt..." | ||
| shfmt -d -p -i 4 -ci -bn -s $src/*.sh | ||
|
|
||
| cat $public/install/*.sh > $out/install.sh | ||
| echo "Creating output..." | ||
| cat $src/*.sh > $out | ||
|
|
||
| echo "Fixing up..." | ||
| # Get rid of comments that don't start with '##' or '#!'. | ||
| sed -i " | ||
| /#!.*/p | ||
| /##.*/p | ||
| /^ *$/d | ||
| /^ *#/d | ||
| s/ *#.*// | ||
| " $out/install.sh | ||
| " $out | ||
| ''; | ||
|
|
||
| # Check if the install.sh script is well formatted and | ||
| # has no shellcheck issues. We ignore 'local' warning by shellcheck, because | ||
| # any existing sh implementation supports it. | ||
| # TODO: streamline mkRelease and this | ||
| install-sh-lint = | ||
| let | ||
| shfmtOpts = "-p -i 4 -ci -bn -s"; | ||
| shellcheckOpts = "-s sh -S warning"; | ||
| in | ||
| pkgs.runCommandNoCC "install-sh-lint" { | ||
| inherit version public; | ||
| buildInputs = [ install-sh pkgs.shfmt pkgs.shellcheck ]; | ||
| preferLocalBuild = true; | ||
| allowSubstitutes = false; | ||
| } '' | ||
| set -Eeuo pipefail | ||
| # Check if we have an sh compatible script | ||
| shckResult="$(shellcheck -Cnever -f gcc ${shellcheckOpts} "$public/install.sh" | \ | ||
| grep -v "warning: In POSIX sh, 'local' is undefined. \[SC2039\]" | \ | ||
| sed -e "s%^${install-sh}/?%%g" || true)" | ||
|
|
||
| if [ -n "$shckResult" ] ; then | ||
| echo "There are some shellcheck warnings:" | ||
| echo | ||
| echo "$shckResult" | ||
| echo | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Check if the file is properly formatted | ||
| if ! shfmt ${shfmtOpts} -d "${install-sh}/install.sh"; then | ||
| echo "Formatting error. Please run:" | ||
| echo | ||
| echo "shfmt ${shfmtOpts} -w public/install.sh" | ||
| exit 1 | ||
| fi | ||
|
|
||
| if grep source "${install-sh}/install.sh"; then | ||
| echo "Found a source above in the output. There should be none remaining (inlined)." | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Make sure Nix sees the output. | ||
| touch $out | ||
| ''; | ||
|
|
||
| # The following prepares a manifest for copying install.sh | ||
| install-sh-release = | ||
| pkgs.lib.linuxOnly ( | ||
| pkgs.runCommandNoCC "install-sh-release" { | ||
| inherit version; | ||
|
|
||
| # `revision` will be printed by `install.sh` as follows: | ||
| # | ||
| # log "Executing DFINITY SDK install script, commit: @revision@" | ||
| revision = | ||
| if src != null | ||
| then src.rev | ||
| else pkgs.lib.commitIdFromGitRepo (pkgs.lib.gitDir ../.); | ||
|
|
||
| manifest = ./manifest.json; | ||
| buildInputs = [ pkgs.jo install-sh-lint install-sh ]; | ||
| preferLocalBuild = true; | ||
| allowSubstitutes = false; | ||
| } '' | ||
| set -Eeuo pipefail | ||
|
|
||
| mkdir -p $out | ||
|
|
||
| version_manifest_file=$out/manifest.json | ||
|
|
||
| cp $manifest $version_manifest_file | ||
| # we stamp the file with the revision | ||
| substitute "${install-sh}/install.sh" $out/install.sh \ | ||
| --subst-var revision | ||
| '' | ||
| ); | ||
| } | ||
| in | ||
| pkgs.lib.linuxOnly ( | ||
| pkgs.runCommandNoCC "install.sh" { | ||
| # `revision` will be printed by `install.sh` as follows: | ||
| # | ||
| # log "Executing DFINITY SDK install script, commit: @revision@" | ||
| revision = src.rev; | ||
| preferLocalBuild = true; | ||
| allowSubstitutes = false; | ||
| inherit install; | ||
| } '' | ||
| # we stamp the file with the revision | ||
| substitute $install $out --subst-var revision | ||
| chmod +x $out | ||
| '' | ||
| ) |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we still need the
doRelease?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, nothing changed in that regard.
We still only want to build (and thus run) the
publish.dfx.x86_64-linuxjob when there was an actual release.