There are supposed to be multiple ways to install sspak:
a) composer.json
b) composer global require silverstripe/sspak
c) installation script - curl -sS http://silverstripe.github.io/sspak/install | php -- /usr/local/bin
d) direct download - sudo mv sspak.phar /usr/local/bin/sspak
a) works to the best of my knowledge, though this should be confirmed
b) requires suffixing :dev-master i.e. composer global require silverstripe/sspak:dev-master. You also need to have ~/.config/composer/vendor/bin in your $PATH for it work seamlessly e.g. sspak <commands>
Some time ago, the binary in bin/sspak stopped being updated, presumably because a github token was revoked. That binary is now out of date, therefore c) and d) do not function as expected. This is very bad, since it means people may be installing an out of date version.
My personal recommendation is that we should remove options c) and d) and force the use of composer, which is the standard way to install all things php. This is my view simply because I do not want this silently breaking again. Others may have a different view though.
Acceptance criteria
[ ] Audit the 4 installation methods to see if they function properly
[ ] Release 1.0.0 so that the :dev-master suffix isn't required for b)
[ ] Investigate if Silverstripe Ltd platform uses sspak at all for extracting sspak files, and if so if it relies on either c) or d)
[ ] Investigate the amount of work required to get the sspak to regularly update via github actions on the tag github event (OR simply decide that we wish to only use composer) - if it's non-trivial then strongly recommended we just drop functionality
[ ] Remove the github pages - all documentation should be in the README.md instead
[ ] Update documentation to reflect the recommended ways to install sspak
There are supposed to be multiple ways to install sspak: a) composer.json b) composer global require silverstripe/sspak c) installation script -
curl -sS http://silverstripe.github.io/sspak/install | php -- /usr/local/bind) direct download -sudo mv sspak.phar /usr/local/bin/sspaka) works to the best of my knowledge, though this should be confirmed
b) requires suffixing :dev-master i.e.
composer global require silverstripe/sspak:dev-master. You also need to have~/.config/composer/vendor/binin your$PATHfor it work seamlessly e.g.sspak <commands>Some time ago, the binary in
bin/sspakstopped being updated, presumably because a github token was revoked. That binary is now out of date, therefore c) and d) do not function as expected. This is very bad, since it means people may be installing an out of date version.My personal recommendation is that we should remove options c) and d) and force the use of composer, which is the standard way to install all things php. This is my view simply because I do not want this silently breaking again. Others may have a different view though.
Acceptance criteria
:dev-mastersuffix isn't required for b)