https://github.com/clippings/c4builder-action
Run C4Builder to generate documentation website
https://github.com/clippings/c4builder-action
c4model github-action github-actions
Last synced: about 1 year ago
JSON representation
Run C4Builder to generate documentation website
- Host: GitHub
- URL: https://github.com/clippings/c4builder-action
- Owner: clippings
- License: mit
- Created: 2020-05-26T19:44:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T16:59:53.000Z (over 2 years ago)
- Last Synced: 2025-04-13T03:09:52.764Z (about 1 year ago)
- Topics: c4model, github-action, github-actions
- Language: Dockerfile
- Homepage: https://github.com/marketplace/actions/c4builder
- Size: 15.6 KB
- Stars: 14
- Watchers: 0
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# C4builder GitHub Action
Run [C4Builder](https://adrianvlupu.github.io/C4-Builder/) in GitHub Actions to generate a documentation website from Markdown and PlantUML files.
## Usage
Put the following step in your workflow:
```yml
- name: C4Builder
uses: clippings/c4builder-action@v1
```
Workflow example:
```yml
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 repository.
You can change it via the `path` input like this:
```yml
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](LICENSE).