Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rlespinasse/drawio-export-action
GitHub Action To Export Draw.io Files
https://github.com/rlespinasse/drawio-export-action
drawio drawio-tools github-actions hacktoberfest
Last synced: 3 months ago
JSON representation
GitHub Action To Export Draw.io Files
- Host: GitHub
- URL: https://github.com/rlespinasse/drawio-export-action
- Owner: rlespinasse
- License: mit
- Created: 2021-04-06T20:18:09.000Z (almost 4 years ago)
- Default Branch: v2.x
- Last Pushed: 2024-04-29T22:34:10.000Z (9 months ago)
- Last Synced: 2024-05-02T01:19:54.617Z (9 months ago)
- Topics: drawio, drawio-tools, github-actions, hacktoberfest
- Language: Shell
- Homepage:
- Size: 128 KB
- Stars: 33
- Watchers: 4
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Drawio Export Action
This GitHub Action will export Drawio Files based on [drawio-export][1] docker image.
## Example usage
> Export draw.io files inside folders tree of `folder/of/drawio/files` to png files using transparent background
```yaml
uses: rlespinasse/drawio-export-action@v2
with:
path: folder/of/drawio/files
format: png
transparent: true
```
> `.github/workflows/drawio-export.yml` - Workflow to keep your draw.io export synchronized
```yaml
name: Keep draw.io export synchronized
on:
push:
branches:
- main
paths:
- "**.drawio"
- .github/workflows/drawio-export.yml
concurrency:
group: drawio-export-${{ github.ref }}
cancel-in-progress: true
jobs:
drawio-export:
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v3
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
- name: Export drawio files to asciidoctor and png files
uses: rlespinasse/drawio-export-action@v2
with:
format: adoc
transparent: true
output: drawio-assets
- name: Get author and committer info from HEAD commit
uses: rlespinasse/git-commit-data-action@v1
if: github.ref == 'refs/heads/main'
- name: Commit changed files
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "docs: sync draw.io exported files"
commit_user_name: "${{ env.GIT_COMMIT_COMMITTER_NAME }}"
commit_user_email: "${{ env.GIT_COMMIT_COMMITTER_EMAIL }}"
commit_author: "${{ env.GIT_COMMIT_AUTHOR }}"
if: github.ref == 'refs/heads/main'
```
## Inputs
### `path`
Path to the drawio files to export. Default `"."`.
### `format`
Exported format. Default `"pdf"`.
Possible values: `adoc`, `md`, `jpg`, `pdf`, `png`, `svg`, `vsdx`, `xml`
### `output`
Exported folder name. Default `"export"`.
> **Relative from the exported drawio file**
>
> A file from `/path/to/file.drawio` will be exported to `/path/to/export/file-{page}.{ext}` by default.
### `remove-page-suffix`
Remove page suffix when possible (in case of single page file)
### `border`
Sets the border width around the diagram. Default `"0"`.
### `scale`
Scales the diagram size
### `width`
Fits the generated `image/pdf` into the specified width, preserves aspect ratio
### `height`
Fits the generated `image/pdf` into the specified height, preserves aspect ratio
### `crop`
crops PDF to diagram size
### `embed-diagram`
Includes a copy of the diagram for PNG or PDF
### `transparent`
Set transparent background for PNG
### `quality`
Output image quality for JPEG. Default `"90"`.
### `uncompressed`
Uncompressed XML output
### `action-mode`
Export mode for this action. Default: auto
Possible values:
- **recent** export only the changed files since a calculated reference
- previously pushed commit on `push` event
- base commit on `pull request` event
- **all** export all drawio files without any filter
- **reference** export since the reference from `since-reference` option
- **auto** will choose the more appropriated mode
- **reference** if `since-reference` option is set,
- **recent** if the reference can be calculated,
- **all** otherwise
CAUTION: When using a mode other than `all`, you need to checkout all the history.
```yaml
- uses: actions/checkout@v3
with:
fetch-depth: 0
```
### `since-reference`
Git Reference serving as base for export. Only when action-mode is set to 'reference'.
## Miscellaneous
- [Additional fonts are available][2]
[1]: https://github.com/rlespinasse/drawio-export
[2]: https://github.com/rlespinasse/drawio-export#additional-fonts