Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
VeryStrongFingers committed Jul 7, 2021
0 parents commit 94b167e
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 0 deletions.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Satis - composer repository
Used for building your own composer repository using [composer/satis](https://github.com/composer/satis).

## Inputs

| Input | Description | Required |
|--------------|---------------------------------------------------------------------------------------------------------|------------------------------|
| token | GitHub token that will be used for composer when invoked by satis.<br/>Currently auth is static for "github-oauth" | Yes |
| satis_config | Path to your satis configuration file | No.<br/>Default = `./satis.json` |

## Outputs
None

## Usage
**Note:** Your `satis.json` **must** contain `"output-dir": ""`

Example `.github/workflow/composer-build.yaml`
```yaml
# eg. Can be used to host your internal composer package registry on github pages.
name: Composer repository

on:
- push

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dev-this/satis-build@v1
with:
token: ${{ GITHUB_TOKEN }} # App/OAuth token, PAT
- env:
GIT_EMAIL: [email protected]
GIT_NAME: cool-bot
run: |
git config user.name $GIT_NAME
git config user.email $GIT_EMAIL
git add docs/
git commit -m "Re-built repository assets"
git push
```
Example `satis.json`
```json
{
"name": "my-cool/repository",
"homepage": "https://where-are-you/",
"repositories": [
{
"packagist.org": false
},
{
"type": "vcs",
"url": "https://github.com/my-cool-org/the-repository"
}
],
"require-all": true,
"output-dir": "docs"
}
```
30 changes: 30 additions & 0 deletions action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 'Satis build - composer repository'
description: 'Build a static composer repository using satis'

inputs:
token:
description: 'Token to use (ie. GITHUB_TOKEN, App token or a PAT)'
required: true
satis_config:
description: 'Path to satis configuration file (default: ./satis.json)'
required: false
default: 'satis.json'

runs:
using: "composite"
steps:
- env:
COMPOSER_AUTH: '{"github-oauth": {"github.com": "${{ inputs.token }}"}}'
run: |
echo '{"require": {"composer/satis": "dev-main"}}' > composer.json
composer require composer/satis --prefer-dist \
--no-progress --no-interaction -o \
--ignore-platform-reqs
php vendor/bin/satis build ${{ inputs.satis_config }} -n
shell: bash

branding:
icon: 'download-cloud'
color: 'gray-dark'

0 comments on commit 94b167e

Please sign in to comment.