https://github.com/calkit/run-action

A GitHub Action to run a Calkit project's pipeline and optionally push results back to Git and DVC.
https://github.com/calkit/run-action

Last synced: 4 months ago
JSON representation

A GitHub Action to run a Calkit project's pipeline and optionally push results back to Git and DVC.

• Host: GitHub
• URL: https://github.com/calkit/run-action
• Owner: calkit
• License: mit
• Created: 2025-08-21T12:37:00.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-08-21T13:32:23.000Z (5 months ago)
• Last Synced: 2025-08-21T15:44:22.473Z (5 months ago)
• Size: 3.91 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Calkit run GitHub Action

A GitHub Action to run a Calkit project's pipeline and optionally save results

(commit and push) to Git and DVC.

## Usage

The example workflow below shows how to run a Calkit project, saving results.

Note the permissions, concurrency, and checkout options.

The action will also require a `dvc_token` input,

which should be set in the repository's Actions secrets.

```yaml

name: Run pipeline

on:

  push:

    branches:

      - main

  pull_request:

permissions:

  contents: write

# Make sure we only ever run one per branch so we don't have issues pushing

# after running the pipeline

concurrency:

  group: calkit-run-${{ github.ref }}

  cancel-in-progress: false

jobs:

  main:

    name: Run

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

        with:

          # For PRs, checkout the head ref to avoid detached HEAD

          ref: ${{ github.head_ref || github.ref_name }}

          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Configure Git credentials

        run: |

          git config user.name github-actions[bot]

          git config user.email 41898282+github-actions[bot]@users.noreply.github.com

      - name: Setup uv

        uses: astral-sh/setup-uv@v5

      - name: Install Calkit

        run: uv tool install calkit-python

      - name: Run Calkit

        uses: calkit/run-action@v1

        with:

          dvc_token: ${{ secrets.CALKIT_DVC_TOKEN }}

```

## Configuration

If simply running the pipeline is desired, the `save` option can be set to

`false`.

Additionally, caching DVC data can be disabled with `cache_dvc: false`.