rwx/update-packages-github 2.2.0

Update RWX packages for GitHub repositories

Source Code
https://github.com/rwx-cloud/packages/tree/main/rwx/update-packages-github
Issue Tracker
https://github.com/rwx-cloud/packages/issues

Parameters

Parameter
Required
Default
Description
repository
*
GitHub HTTPS repository URL
ref
*
The ref to check out of the git repository
github-token
*
The GitHub token to a private app
allow-major-version-change
false
Allow updating across major versions
branch-prefix
rwx-update-
Branch prefix for opened pull requests
label
Label for opened pull requests
label-color
298F21
Label color if not yet created
rwx-file
Scope updates to a specific file or single glob pattern of files
draft
false
Create or update the pull request as a draft
enable-auto-merge
false
Enable auto-merge on the pull request (requires repository auto-merge support)

README.md

Update the versions of RWX packages used in a GitHub repository. When updates are available, create or update a pull request.

The provided github-token should be for a private GitHub App with repository permissions for:

  • Contents: read and write
  • Pull Requests: read and write

If you would like to automatically create the label, additionally provide:

To update minor versions (recommended):

tasks:
  - key: update-rwx-packages
    call: rwx/update-packages-github 2.2.0
    with:
      repository: https://github.com/YOUR-ORG/YOUR-REPO.git
      ref: ${{ init.commit-sha }}
      github-token: ${{ vaults.your-vault.github-apps.your-github-app.token }}

Customize the label:

tasks:
  - key: update-rwx-packages
    call: rwx/update-packages-github 2.2.0
    with:
      repository: https://github.com/YOUR-ORG/YOUR-REPO.git
      ref: ${{ init.commit-sha }}
      github-token: ${{ vaults.your-vault.github-apps.your-github-app.token }}
      label: rwx-updates
      label-color: "298F21"

Create a draft pull request:

By default, the pull request is ready for review. Set draft to true to create it as a draft. If a matching pull request is already open, the package changes it to the configured state.

tasks:
  - key: update-rwx-packages
    call: rwx/update-packages-github 2.2.0
    with:
      repository: https://github.com/YOUR-ORG/YOUR-REPO.git
      ref: ${{ init.commit-sha }}
      github-token: ${{ vaults.your-vault.github-apps.your-github-app.token }}
      draft: true

Enable auto-merge:

Enables auto-merge on the pull request. The PR will automatically merge once all requirements are met: status checks pass, approvals are received, and branch protection rules are satisfied. Requires repository auto-merge support.

tasks:
  - key: update-rwx-packages
    call: rwx/update-packages-github 2.2.0
    with:
      repository: https://github.com/YOUR-ORG/YOUR-REPO.git
      ref: ${{ init.commit-sha }}
      github-token: ${{ vaults.your-vault.github-apps.your-github-app.token }}
      enable-auto-merge: true