Allow install_sct to be run standalone (without downloading "Source code" archive)
#4049
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
There are 3 possibilities for how `install_sct` has been run: 1. git clone --> ./install_sct 2. Download "Source code (.zip)" --> ./install_sct 3. Download install_sct by itself --> ./install_sct We want to only run `git clone` ourselves in case 3. So, how do we tell if we already have the source files in the PWD? ANS: We can re-use the existing check for the version.txt file. :) This isn't 100% reliable, but it's hard to imagine a situation where 'spinalcordtoolbox/version.txt' isn't present but the rest of the source isn't. Plus, this minimizes the PR diff.
When `install_sct` is run on its own, it can *never* be an in-place installation, because we don't have access to the source files in the PWD. Because of this, we must force SCT_INSTALL_TYPE=package. So, we move the setting of SCT_INSTALL_TYPE into the earlier if/else block.
joshuacwnewton
force-pushed
the
jn/3545-add-git-clone-to-install_sct
branch
from
55cf487
to
144c0f9
Compare
mguaypaq
reviewed
Feb 23, 2023
mguaypaq
requested changes
Feb 23, 2023
joshuacwnewton
commented
Feb 24, 2023
mguaypaq
approved these changes
Feb 28, 2023
This was referenced Mar 2, 2023
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.
Description
Currently, for Linux/macOS installations of SCT, users must navigate to the Release page, then download a "Source code (.zip)" archive. They must then
cdinto the folder and runinstall_sct.This is a bit unwieldy, and has also prevented us from collecting download statistics for the past several years. Without download statistics, it's more difficult to demonstrate the use and impact of SCT (for the purposes of e.g. grant proposals).
As a test, the Windows installer (
install_sct.bat) was designed to be run standalone. This allowed us to upload the install script to the release as an asset, which does grant us download statistics.As a followup, then, this PR updates
install_sctso that the Linux/macOS installers so that they can be run standalone, and thus uploaded to releases to benefit from the same statistics gathering.Future work
install_sctas a release asset (changing the defaultgit_refvalue frommasterto<release milestone name>)install_scttwice as two separate release artifacts, Linux and macOS, to collect better data on who uses which OS.(This would also make the installation process for each OS a bit more unified, since
install_sct.batgets renamed toinstall_sct-5.8_win.bat. Similarly,install_sctcould becomeinstall_sct-5.8_linux.shandinstall_sct-5.8_macos.sh.)(This could also lead us down a path where we remove all of the OS-specific if/else blocks that pollute
install_sct, since we would maintain dedicated installers for Linux vs. macOS.)gitis now a dependency).~/sct_<version>instead of~/spinalcordtoolbox)Linked issues
Fixes #3545.