https://github.com/matheusvellone/labels-as-parameters

Github Action to load labels as parameters
https://github.com/matheusvellone/labels-as-parameters

actions labels parameters

Last synced: 29 days ago
JSON representation

Github Action to load labels as parameters

• Host: GitHub
• URL: https://github.com/matheusvellone/labels-as-parameters
• Owner: matheusvellone
• Created: 2021-11-22T16:23:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T18:29:39.000Z (over 1 year ago)
• Last Synced: 2024-07-27T00:10:37.660Z (4 months ago)
• Topics: actions, labels, parameters
• Language: JavaScript
• Homepage:
• Size: 501 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Labels as parameters



  



Use this action to use your Pull Request labels as parameters in you workflow.

## Usage

```yml

jobs:

  deploy:

    name: Deploy Application

    runs-on: ubuntu-latest

    steps:

      - name: Extract labels

        uses: matheusvellone/[email protected]

        id: parameters

        with:

          separator: "=" # Optional

          requiredParameters: environment, project # Optional

      - name: Deploy API

        if: ${{ contains(steps.parameters.outputs.project, 'api') }} # Be careful with this! Read below

        run: |

          ./deploy-api.sh --environment ${{ steps.parameters.outputs.environment }}

      - name: Deploy Internal API

        if: ${{ contains(steps.parameters.outputs.project, 'internal-api') }}

        run: |

          ./deploy-api-internal.sh --environment ${{ steps.parameters.outputs.environment }}

```

You can also add multiple labels to the Pull Request, and both `contains` would evaluate to `true` if the Pull Request had both labels.

Just be careful when using `contains` like in the example, because if a Pull Request had **only** one `project:*api*`-like label (like `project:internal-api`), the "Deploy API" would also be triggered.

## Inputs

The action takes two optional inputs: separator and requiredParameters.

### separator

The separator to be used to separate the key name from the value like.

Default value is `:`.

A label `environment:production` would generate the `environment` variable with the `production` value.

### requiredParameters

A list required parameters, separated by `,`. If any of the required parameters is not found, the action will fail.

Default value is an empty list.

## Limitations

Currently, the project cannot execute the action after the merge on a branch (`push` event on a workflow) if the Pull Request the merge strategy is `rebase` or if the message of the commit does not contain the Pull Request number.

This is because the action will not be able to retrieve Pull Request labels.

A default message for merge, or squash, action on a Pull Request should work fine.

## TODOs

### Project

- Fix "Check dist" workflow

- Add test badge

- Add coverage (+ badge)

### Features

- Parse keys with "separator" in the key

- Parse values with "separator" in the value

- Parse multiple labels from the same parameter and output them as an array

- Parse multiple parameters and specify the output format: number, boolean, string. In a case where a single label is used and the output type is specified.