/c4builder-action

Run C4Builder to generate documentation website

Primary LanguageDockerfileMIT LicenseMIT

C4builder GitHub Action

Run C4Builder in GitHub Actions to generate a documentation website from Markdown and PlantUML files.

Usage

Put the following step in your workflow:

      - name: C4Builder
        uses: clippings/c4builder-action@v1

Workflow example:

name: Build

on:
  pull_request:
    types: [open, synchronize]
  push:
    branches:
      - master

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1

      - name: C4Builder
        uses: clippings/c4builder-action@v1

Configuration

The only available configuration is the path where the .c4builder file is located. Defaults to the root of your repoository.

You can change it via the path input like this:

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1

      - name: C4Builder
        uses: clippings/c4builder-action@v1
        with:
          path: 'doc/architecture'

All the remaining configuration like source and destination folder is read from your C4Builder configuration file found in the path.

License

Licensed under the MIT license. See LICENSE.