-
Notifications
You must be signed in to change notification settings - Fork 17
Open
Labels
featureFeature requestFeature request
Description
Problem Statement
Users who want to use swamp in their CI/CD pipelines (GitHub Actions) currently have no standardized way to install swamp and authenticate with swamp.club. Each user must write their own installation and authentication steps, leading to inconsistency and duplicated effort.
Proposed Solution
Create a setup-swamp GitHub Action that:
- Downloads and installs swamp — Downloads the appropriate swamp binary for the runner's platform and adds it to
PATH - Optionally authenticates with swamp.club — If the user provides an API token input, the action authenticates the user to swamp.club
- Optionally initializes the repo — If
repo-initis enabled, runsswamp repo initto set up the repository
Action Inputs
| Input | Required | Description |
|---|---|---|
version |
No | Swamp version to install (default: latest) |
api-token |
No | API token for authenticating with swamp.club |
repo-init |
No | Run swamp repo init after setup (default: false) |
Example Usage
- uses: systeminit/setup-swamp@v1
with:
version: latest
api-token: ${{ secrets.SWAMP_API_TOKEN }}
repo-init: trueImplementation Summary
This feature would require creating a new GitHub Action repository (or directory within this repo) with:
- action.yml — Action metadata defining inputs, branding, and the composite/JS entry point
- Download logic — Fetch the correct swamp binary for the runner OS/arch from GitHub releases
- PATH setup — Add the downloaded binary to the runner's PATH
- Authentication step — If
api-tokenis provided, run the appropriate swamp auth command to authenticate with swamp.club - Repo init step — If
repo-initis true, runswamp repo initto initialize the repository - Caching (optional) — Cache the downloaded binary to speed up subsequent runs
The action should support Linux and macOS runners at minimum.
Alternatives Considered
- Documenting manual installation steps in a wiki — less ergonomic, more error-prone
- A shell script users curl and pipe — less discoverable, harder to version
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
featureFeature requestFeature request