https://github.com/dolthub/dolt-action

https://github.com/dolthub/dolt-action

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dolthub/dolt-action
• Owner: dolthub
• Created: 2021-05-24T19:28:00.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-19T18:14:59.000Z (almost 3 years ago)
• Last Synced: 2024-05-01T11:28:22.581Z (8 months ago)
• Language: Shell
• Size: 79.1 KB
• Stars: 6
• Watchers: 5
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dolt Action

This GitHub Action helps mutate Dolt repos in GitHub

Action workflows.

## Example Usage

```yml

name: Test

jobs:

  hello_world_job:

    runs-on: ubuntu-latest

    name: A job to say hello

    steps:

      - name: Dolt Import

        uses: dolthub/[email protected]

        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: [email protected]

          commit_author: 'Max Hoffman'

          push: false

          before: |

            dolt sql -q "insert into aminals (12, 'hummingbird', 61)"

```

## Parameters

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`: A `service_account.json` that grants access to

    Google Cloud remotes.

- `push`: Whether to persist changes or discard at the step conclusion.

- `clear` : A `dolt-action` deletes the local database during the

    cleanup step. If concatenating multiple `dolt-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.