https://github.com/grayespinoza/typstyle-action
GitHub action for typstyle
https://github.com/grayespinoza/typstyle-action
formatter typst
Last synced: 5 months ago
JSON representation
GitHub action for typstyle
- Host: GitHub
- URL: https://github.com/grayespinoza/typstyle-action
- Owner: grayespinoza
- License: mit
- Created: 2025-03-25T01:00:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T03:07:02.000Z (about 1 year ago)
- Last Synced: 2025-03-25T03:29:22.654Z (about 1 year ago)
- Topics: formatter, typst
- Language: Dockerfile
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typstyle GitHub Action
GitHub Action to run [typstyle](https://github.com/Enter-tainer/typstyle), a Typst formatter.
## Usage
1. Create `.github/workflows/ci.yml`
2. Configure `ci.yml`
3. Commit and push `ci.yml`
### Examples
The following formats all `.typ` files in branch `main` on pushes, then pushes the changes.
`.github/workflows/ci.yml`
```yml
name: CI
on:
push:
branches: main
jobs:
typstyle:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@main
with:
ref: ${{ github.head_ref }}
- name: Run typstyle
uses: typstyle-rs/typstyle-action@main
- name: Push
uses: stefanzweifel/git-auto-commit-action@master
with:
commit_message: "style: format using typstyle"
```
## Reporting Issues
Please use [GitHub Issues](https://github.com/typstyle-rs/typstyle-action/issues) to report bugs, crashes, and other issues.
## License
typstyle-action is under the [MIT License](https://github.com/typstyle-rs/typstyle-action/blob/main/LICENSE).