ochorocho/gitlab-pages-satis

This package is abandoned and no longer maintained. No replacement package was suggested.

v1.0.0 2018-11-09 12:59 UTC

Requires

• mbo/satis-gitlab: dev-master

GPL-3.0-only

README

bin/gitlab-pages-satis

Specify config

bin/gitlab-pages-satis /path/to/config.yml

Using env variable

export GITLAB_SATIS_CONFIG="
arguments:
  gitlab-url: 'https://gitlab.example.org'
  gitlab-token: 'TOKEN'
options:
  homepage: 'https://satis.example.org'
  output: 'satis.json'
  ignore: '(^knallimall\/typo3-desktop)'
build-dir: './public'
  "

Example config

arguments:
  gitlab-url: 'https://gitlab.example.org'
  gitlab-token: 'TOKEN'
options:
  homepage: 'https://satis.example.org'
  output: 'satis.json'
  # Make sure string is escaped correctly
  ignore: '(^knallimall\/typo3-desktop)'
  template: 'satis-template.example.json'
  use-file-to-include: '.satisinclude'
build-dir: './public'
# .htaccess and .htpasswd file only generated if set
basic-auth:
  auth-name: "Satis Repository"
  auth-file: "/path/to/.htpasswd" # Absolute path required
  username: "admin"
  password: "password"

For satis-json configurations options see https://composer.github.io/satis/config. To use a custom template use twig-template option in your satis template. You'll find the example template in vendor/composer/satis/views

Features

• Config
  • Default: ./config.yml
  • env: GITLAB_SATIS_CONFIG
  • set config gitlab-pages-satis /path/to/config-file.yml
• All values of options-section are passed as --option-key to the command, so all satis/satis-gilab options are available
• All values of arguments-section are passed as argument-key to the command, so all satis/satis-gilab command arguments are available

Development

• git clone https://github.com/ochorocho/gitlab-pages-satis.git
• composer install
• create config file, see config.example.yml
• run it ./bin/gitlab-pages-satis