sbotools2

Maintenance fork of the original sbotools version 2
git clone git://git.server.ky/slackcoder/sbotools2
Log | Files | Refs | README

README.md (1908B)


      1 # sbotools2
      2 
      3 **sbotools2** provides a ports-like interface to [slackbuilds.org](http://www.slackbuilds.org/).
      4 
      5 This is the maintenance fork of the [original sbotools](https://https://pink-mist.github.io/sbotools/)
      6 version 2 by a new maintainer.  Changes are listed in the [ChangeLog](ChangeLog.md).
      7 
      8 Another has taken over [sbotools](https://pghvlaans.github.io/sbotools/) for version 3.
      9 
     10 ## Project To Do's
     11 
     12 Planned improvements and known bugs are listed on the project's
     13 [todo branch](https://git.server.ky/slackcoder/sbotools2/tree?h=todo).
     14 
     15 ## Auditing Changes
     16 
     17 You can audit the forked changes by asking git to show commits since the last known official commit.
     18 
     19 ```sh
     20 git remote add pink-mist https://github.com/pink-mist/sbotools
     21 git fetch pink-mist
     22 git show pink-mist/master..
     23 ```
     24 
     25 The latest changes on the master branch can be verified using the maintainer's
     26 [GPG Key](GPG-KEY) included in the project.  The 'FINGERPRINT' should not
     27 change unless the maintainer does.
     28 
     29 ```sh
     30 FINGERPRINT=D0CFFD1075CAB8DA329975078D147EEA19EFF029
     31 
     32 if ! gpg2 --list-keys | grep "$FINGERPRINT" >/dev/null; then
     33   gpg2 --import ./GPG-KEY
     34 fi
     35 
     36 if git verify-commit origin/master; then
     37   echo "verification ok"
     38 else
     39   echo "verification failed"
     40 fi
     41 ```
     42 
     43 ## Testing
     44 
     45 Unit tests are defined under 't/'.  Note some tests require environmental flags
     46 resulting in modifying your slackware system.  You should run them under docker
     47 as described below.
     48 
     49 ```
     50 prove -v t
     51 ```
     52 
     53 You can use the Dockerfile to remove the headache for setting up the test
     54 environment.  You will need to build the docker image before being able to use
     55 it.
     56 
     57 Test categories are enabled via environment variables enabled via docker's '--env' parameter.
     58 
     59 ```
     60 docker build -t sbotools2-test:15.0 --file docker/sbotools2-test:15.0.dockerfile .
     61 docker run --rm -v $(realpath .):/root/sbotools2 --env TEST_INSTALL=1 --env TEST_ONLINE=1 -t sbotools2-test:15.0
     62 ```