PHP composer/satis application extended with the hability to automate SATIS configuration according to GITLAB projects containing a composer.json
file.
It also provides a way to mirror PHP dependencies to allow offline builds.
git clone https://github.com/mborne/satis-gitlab
cd satis-gitlab
# PHP 7.x
composer install
# PHP 5.6 (downgrading versions refered in composer.lock is required)
composer update
# add --archive if you want to mirror tar archives
bin/satis-gitlab gitlab-to-config \
--homepage https://satis.example.org \
--output satis.json \
https://gitlab.example.org [GitlabToken]
bin/satis-gitlab build satis.json web
Use you're favorite tool to expose web
directory as https://satis.example.org
.
satis.json should not be exposed, it contains the GitlabToken by default (see --no-token
)
SATIS web page suggests to add the following configuration to composer.json in all your projects :
{
"repositories": [{
"type": "composer",
"url": "https://satis.example.org"
}]
}
Alternatively, composer can be configured globally to use SATIS :
composer config --global repo.satis.example.org composer https://satis.example.org
(it makes a weaker link between your projects and your SATIS instance(s))
If you rely on gitlab.com, you will probably need to find projects according to groups and users :
bin/satis-gitlab gitlab-to-config https://gitlab.com $SATIS_GITLAB_TOKEN -vv --users=mborne --orgs=drutopia
github supports allows to perform :
bin/satis-gitlab gitlab-to-config https://github.com $SATIS_GITHUB_TOKEN --orgs=symfony --users=mborne
bin/satis-gitlab build --skip-errors satis.json web
(Note that GITHUB_TOKEN is required to avoid rate request limitation)
Note that --archive
option allows to download tar
archives for each tag and each branch in web/dist
for :
- The gitlab projects
- The dependencies of the gitlab projects
Note that GitlabToken
is optional so that you can generate a SATIS instance only for you're public repositories.
Note that gitlab-to-config
saves the GitlabToken
to satis.json
configuration file (so far you expose only the web
directory, it is not a problem).
You may disable this option using --no-token
option and use the following composer command to configure $COMPOSER_HOME/auth.json
file :
composer config -g gitlab-token.satis.example.org GitlabToken
Some command line options provide a basic customization options. You may also use --template my-satis-template.json
to replace the default template :
## Supported PHP versions
PHP 7.2 version is recommanded as it is the current LTS with the longest support (see PHP - Supported Versions)
Meanwhile 5.6, 7.1, 7.2 and 7.3 are tested throw Travis CI
export SATIS_GITLAB_TOKEN=AnyGitlabToken
export SATIS_GITHUB_TOKEN=AnyGithubToken
make test
Note that an HTML coverage report is generated to output/coverage/index.html
- GITLAB API v4
satis-gitlab is licensed under the MIT License - see the LICENSE file for details