https://github.com/avides/actions-action-configuration-autoupdate

https://github.com/avides/actions-action-configuration-autoupdate

actions github-action-javascript github-actions nodejs

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/avides/actions-action-configuration-autoupdate
• Owner: avides
• License: mit
• Created: 2020-06-12T13:56:44.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-05-15T16:31:51.000Z (about 1 year ago)
• Last Synced: 2025-07-12T15:14:45.037Z (12 months ago)
• Topics: actions, github-action-javascript, github-actions, nodejs
• Language: JavaScript
• Size: 384 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# actions-action-configuration-autoupdate

This actions updates the local GitHub Actions configuration `yml`-files. You need an extra Github repository as source for your GitHub Actions configuration. To auto-commit the changes within the action run you can use the [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) action.

## Requirements

- GitHub repository that contains your personal GitHub Actions configuration files

## Inputs

### `token`

**Required** The repository token is used to request the remote GitHub Actions configuration-files from the [GitHub API](https://developer.github.com/v3/repos/contents/#get-contents)

### `actions-configuration-files`

**Required** Comma separated list of GitHub Action configuration filenames with path to the location in your remote repository

### `source-repository`

**Required** GitHub repository where your GitHub Action configuration is located

### `source-ref`

Branch/Commit/Tag from source repository where to get updated GitHub Actions configuration files (default: master)

## Outputs

### `updated`

Is set to `true` if one configuration file is changed. Usage:

``` yaml

- uses: avides/actions-action-configuration-autoupdate@v2.0.0

  id: actions_action_configuration_autoupdate

  with:

    token: ${{ secrets.PAT }}

    actions-configuration-files: path/to/files/workflow1.yml,path/to/files/workflow2.yml

    source-repository: your/workflow-configuration-repository

- name: action-configuration-updated

  if: ${{ steps.actions_action_configuration_autoupdate.outputs.updated }} == 'true'

  run: exit 1

```

## Example usage

``` yaml

- name: action-configuration-autoupdate

  uses: avides/actions-action-configuration-autoupdate@v2.0.0

  with:

    token: ${{ secrets.PAT }}

    actions-configuration-files: path/to/files/workflow1.yml,path/to/files/workflow2.yml

    source-repository: your/workflow-configuration-repository

```

## Example usage with auto-commit

``` yaml

- name: checkout

  uses: actions/checkout@v3

  with:

    ref: ${{ github.head_ref }}

    token: ${{ secrets.PAT }}

- name: action-configuration-autoupdate

  uses: avides/actions-action-configuration-autoupdate@v2.0.0

  with:

    token: ${{ secrets.PAT }}

    actions-configuration-files: path/to/files/workflow1.yml,path/to/files/workflow2.yml

    source-repository: your/workflow-configuration-repository

- uses: stefanzweifel/git-auto-commit-action@v5

  with:

    file_pattern: .github/workflows/*.yml

    commit_message: Update GitHub Action configuration

```