diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml index c04b279f..254a2d35 100644 --- a/.github/workflows/docker.yaml +++ b/.github/workflows/docker.yaml @@ -11,13 +11,13 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up QEMU - uses: docker/setup-qemu-action@v1 + uses: docker/setup-qemu-action@v2 - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v1 + uses: docker/setup-buildx-action@v2 - name: Build and push - uses: docker/build-push-action@v2 + uses: docker/build-push-action@v3 with: context: . push: false diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index f48f66e2..046194ff 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -6,6 +6,7 @@ on: # branches to consider in the event; optional, defaults to all branches: - main + - v2 jobs: update_release_draft: diff --git a/.github/workflows/updatecli.yaml b/.github/workflows/updatecli.yaml index 22ec76c0..7f28cdbe 100644 --- a/.github/workflows/updatecli.yaml +++ b/.github/workflows/updatecli.yaml @@ -19,10 +19,10 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Diff - uses: updatecli/updatecli-action@v1.22.0 + uses: updatecli/updatecli-action@v1.33.0 with: command: diff flags: "--config ./updatecli/updatecli.d" @@ -31,7 +31,7 @@ jobs: UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Apply - uses: updatecli/updatecli-action@v1.22.0 + uses: updatecli/updatecli-action@v1.33.0 with: command: apply flags: "--config ./updatecli/updatecli.d" diff --git a/Dockerfile b/Dockerfile index 9d583ef0..e22b96d9 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -ARG UPDATECLI_VERSION=v0.19.2 +ARG UPDATECLI_VERSION=v0.25.0 FROM ghcr.io/updatecli/updatecli:$UPDATECLI_VERSION diff --git a/README.md b/README.md index ec4bbbb2..5632c0a9 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,39 @@ -# Updatecli Github Action +# Updatecli Action -* [Usage](#usage) - * [Workflow](#workflow) -* [License](#license) +> GitHub Action that runs [Updatecli](https://www.updatecli.io). + + +Updatecli is an automation engine that allows you to define custom update pipelines. + +A Quick-start is available on [www.updatecli.io/docs/prologue/quick-start](https://www.updatecli.io/docs/prologue/quick-start/) ## Usage -Run updatecli from GitHub Action +Add the following steps to your worfkow + + +```yaml +- name: Run Updatecli pipeline + uses: updatecli/updatecli-action@v1 + with: + command: "diff --config updatecli.d --values values.yaml" + env: + UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + +## Inputs + +| Name | Description | Default | +|------------------ |------------------------------------------ |----------------- | +| command | The updatecli command | apply | +| flags | The flags provided to an updatecl command | nil | + ### Workflow -WARNING: Dont enable --debug mode in Github Action as it may leak information. +More detailed documentation is available on [updatecli/docs/automate/github_action](https://www.updatecli.io/docs/automate/github_action/) + +WARNING: Do not enable --debug mode in Github Action as you may leak credentials. ```yaml name: updatecli @@ -19,12 +42,13 @@ on: workflow_dispatch: schedule: # * is a special character in YAML so you have to quote this string - # Run once a day + # Run once a day - cron: '0 0 * * *' +# Different write permission may be needed permissions: contents: write - pull-requests: write + pull-requests: write jobs: updatecli: @@ -46,6 +70,18 @@ jobs: UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +## Contributing + +This is a community-oriented project, all contributions are greatly appreciated. + +Here is a non-exhaustive list of contributions: + +* ⭐️ our main GitHub repository [updatecli/updatecli](https://github.com/updatecli/updatecli/stargazers) +* Propose a new feature request on any of [updatecli](https://github.com/updatecli/) repositories. +* Highlight an existing feature request with ":thumbsup:" on any of the [updatecli](https://github.com/updatecli/) repositories. +* Contribute to any repository in the [updatecli](https://github.com/updatecli/) organization +* Share the love + ## License MIT. See `LICENSE` for more details.