https://github.com/puppetlabs/relaysh-docker-update-workflow

https://github.com/puppetlabs/relaysh-docker-update-workflow

action actions github-actions relay

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/puppetlabs/relaysh-docker-update-workflow
• Owner: puppetlabs
• Created: 2020-09-27T21:37:15.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-17T19:09:14.000Z (over 2 years ago)
• Last Synced: 2024-10-08T11:08:19.826Z (about 1 month ago)
• Topics: action, actions, github-actions, relay
• Language: Python
• Homepage:
• Size: 34.2 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# relaysh-docker-action

## Usage

To use it, add a GitHub Actions workflow in the repository where you keep your Relay workflows.

```yaml

name: update-and-run-workflow-on-commit

on:

  push:

    branches: [ main ]

  update:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v2

      with:

        fetch-depth: 0

    - uses: puppetlabs/relaysh-docker-update-workflow@main

      with:

        RELAY_API_TOKEN: ${{ secrets.RELAY_API_TOKEN }}

        RELAY_WORKFLOW: "relay-workflow-name"

        RELAY_WORKFLOW_FILE: "relay.yaml"

```

The action's behavior is configurable based on the presence of a `workflow_mappings.yaml` configuration file in the root of the repository. This file's purpose is to map filenames inside the repository to workflow names as they exist in Relay. As such, it should be a list of maps, each with a `name` and `file` key, where `name` is the user-visible workflow name in Relay (i.e. displayed by `relay workflow list`) and `file` is the path and filename of the workflow YAML, relative to the repository root. See the [workflow_mappings.yaml](workflow_mappings.yaml) in this directory for an example.