This GitHub Action helps mutate Dolt repos in GitHub Action workflows.
name: Test
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: A job to say hello
steps:
- name: Dolt Import
uses: dolthub/dolt-action@v1.0
id: 'dolt_import'
with:
remote: max-hoffman/dolt_action_test
dolthub_credential: ${{ secrets.DOLTHUB_CREDENTIAL }}
message: 'Dolt action commit'
commit_branch: 'master'
commit_user_email: max@dolthub.com
commit_author: 'Max Hoffman'
push: false
before: |
dolt sql -q "insert into aminals (12, 'hummingbird', 61)"
The main parameters are those involveded in configuring, pulling and pushing a Dolt repository.
remote
: DoltHub, S3, GCS remote endpoint. Each has a different authentication technique.branch
: Indicate the branch to shallow-clone.before
: Bash script executed after the pull stage and before commit stage.after
: Bash script executed between commit and push stages.dolthub_credential
: A JWT that grants access to DoltHub remotes.google_credential
: Aservice_account.json
that grants access to Google Cloud remotes.push
: Whether to persist changes or discard at the step conclusion.clear
: Adolt-action
deletes the local database during the cleanup step. If concatenating multipledolt-action
steps,clear=False
will avoid unnecessarily re-cloning the database.commit_
options: Automate a commit following the before script.tag_
options: Tag HEAD or another ref at the end of the workflow.
Outputs:
commit
: If the script persisted a commit, this output stores the associated commit hash.