https://github.com/cpcloud/flake-update-action

A GitHub action to automatically update nix flake dependencies
https://github.com/cpcloud/flake-update-action

actions dependencies flakes github-actions nix

Last synced: 19 days ago
JSON representation

A GitHub action to automatically update nix flake dependencies

• Host: GitHub
• URL: https://github.com/cpcloud/flake-update-action
• Owner: cpcloud
• License: apache-2.0
• Created: 2021-12-26T16:16:09.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T18:06:41.000Z (7 months ago)
• Last Synced: 2024-05-01T20:35:09.228Z (7 months ago)
• Topics: actions, dependencies, flakes, github-actions, nix
• Language: Nix
• Homepage:
• Size: 123 KB
• Stars: 16
• Watchers: 4
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Update flake dependencies

This action will create PRs that update flake dependencies.

## Usage in a GitHub workflow

```yaml

jobs:

  update-deps:

    runs-on: ubuntu-latest

    strategy:

      fail-fast: false

      matrix:

        dependency:

          - nixpkgs

          - poetry2nix

    steps:

      - name: Update ${{ matrix.dependency }}

        uses: cpcloud/flake-update-action@*

        with:

          dependency: ${{ matrix.dependency }}

          pull-request-token: ${{ secrets.ANOTHER_TOKEN }}

          pull-request-author: "Me "

          github-token: ${{ secrets.GITHUB_TOKEN }}

```

## Inputs

```yaml

inputs:

  dependency:

    required: true

    description: "The flake dependency to update"

  pull-request-token:

    required: true

    description: "Access token used to create pull requests"

  pull-request-author:

    required: true

    description: "The author of the pull request"

  pull-request-merge-method:

    required: false

    description: "The merge method for automerging pull requests"

    default: "rebase"

  delete-branch:

    required: false

    default: "false"

    description: "Delete branch upon merge"

  github-token:

    required: false

    description: "Access token to increase the rate limit for GitHub API requests"

  pull-request-branch-prefix:

    required: false

    default: "create-pull-request/update-"

    description: "Prefix of the branch for the pull request"

  pull-request-labels:

    required: false

    description: "Labels to attach to the pull request"

    default: ""

  include-merge-commits:

    required: false

    description: "Whether to show merge commits in the log"

    default: "false"

  automerge:

    required: false

    description: "Whether to set the pull request to automatically merge on success. Requires that the automerge feature is enabled on GitHub."

    default: "false"

```