GitHub Action
Couscous Generate
v1
Latest version
Couscous turns Markdown documentation into websites. http://couscous.io/
This is a GitHub Action to generate couscous websites. View : https://couscousphp.github.io/GitHub-Action/
Add your workflow file, the following step
- uses: CouscousPHP/GitHub-Action@v1
name: Couscous GithubPage
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v1
- uses: CouscousPHP/GitHub-Action@v1
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./.couscous/generated
Generate zip artefact with the generate website.
name: Couscous Artefact
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v1
- uses: CouscousPHP/GitHub-Action@v1
- name: Upload artifact
uses: actions/[email protected]
with:
# Artifact name
name: Couscous
# Directory containing files to upload
path: .couscous/generated
Couscous is released under the MIT License.