https://github.com/amutake/setup-satysfi

Set up your GitHub Actions workflow with a specific version of SATySFi
https://github.com/amutake/setup-satysfi

github-actions saphe satysfi satysfi-typesetting

Last synced: about 2 months ago
JSON representation

Set up your GitHub Actions workflow with a specific version of SATySFi

• Host: GitHub
• URL: https://github.com/amutake/setup-satysfi
• Owner: amutake
• License: mit
• Created: 2024-01-19T12:12:33.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-20T04:50:12.000Z (about 1 year ago)
• Last Synced: 2024-10-28T09:09:07.001Z (3 months ago)
• Topics: github-actions, saphe, satysfi, satysfi-typesetting
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# setup-satysfi

[![ci](https://github.com/amutake/setup-satysfi/actions/workflows/ci.yml/badge.svg)](https://github.com/amutake/setup-satysfi/actions/workflows/ci.yml)

Set up your GitHub Actions workflow with a specific version of SATySFi.

> [!IMPORTANT]

> This is an Action for SATySFi version 0.1.0 and later. Currently, it is only compatible with the `dev-0-1-0-separate-saphe-from-satysfi` branch.

## Usage

### Example workflow for document

```yaml

name: CI

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: amutake/setup-satysfi@v0

      # optional but recommended:

      - uses: actions/cache@v4

        with:

          path: ~/.saphe

          key: ${{ runner.os }}-saphe-${{ hashFiles('./main.saphe.lock.yaml') }}

          restore-keys: |

            ${{ runner.os }}-saphe-

      - run: saphe update main.saty

      - run: saphe solve main.saty

      - run: saphe build main.saty

      # optional:

      - uses: actions/upload-artifact@v4

        with:

          name: pdf

          path: main.pdf

```

### Example workflow for library

```yaml

name: CI

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: amutake/setup-satysfi@v0

      # optional but recommended:

      - uses: actions/cache@v4

        with:

          path: ~/.saphe

          key: ${{ runner.os }}-saphe-${{ hashFiles('./saphe.lock.yaml') }}

          restore-keys: |

            ${{ runner.os }}-saphe-

      - run: saphe update .

      - run: saphe solve .

      - run: saphe build .

      - run: saphe test .

```