Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional seed input #85

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ A Github action to create consistent and unique names for PR based environments.

Uses [unique-names-generator](https://github.com/andreasonny83/unique-names-generator)
and a "seed" based on the repo owner, name and issue (PR) number to generate a
unique and consistent name. This makes it easy to deploy and clean up ephemaral
environments on PR open, close or merge without needing to keep track of a
unique and consistent name.
This makes it easy to deploy and clean up ephemaral environments on PR open, close or merge without needing to keep track of a
non-deterministic unique name.
The seed can be overriden also with `seed` input.

## Inputs
None.
### `seed`
String. Not required.

## Outputs
### `name`
Expand Down
3 changes: 3 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ description: 'Generate a consistent, unique name based on PR'
branding:
icon: 'anchor'
color: 'blue'
inputs:
seed:
description: 'The seed to generate the name'
outputs:
name:
description: 'The generated unique and consistent name'
Expand Down
Loading