https://github.com/thclark/coolname-generator-action

Generates coolnames like 'crazy-red-baboon' for use in tagging things with Github Actions
https://github.com/thclark/coolname-generator-action

Last synced: 26 days ago
JSON representation

Generates coolnames like 'crazy-red-baboon' for use in tagging things with Github Actions

• Host: GitHub
• URL: https://github.com/thclark/coolname-generator-action
• Owner: thclark
• License: mit
• Created: 2022-01-20T17:38:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-17T03:57:37.000Z (10 months ago)
• Last Synced: 2024-09-13T16:05:43.436Z (about 2 months ago)
• Language: JavaScript
• Size: 757 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# coolname-generator-action

Generates coolnames like 'crazy-red-baboon' for use in tagging things with Github Actions

[unique-names-generator](https://github.com/andreasonny83/unique-names-generator) is used to generate the names.

## Parameters

### Inputs

| Parameter   | Default     | Description                             |

| ----------- | ----------- | --------------------------------------- |

| `separator` | `-`         | What separator to use.                  |

| `length`    | `2`         | How many words in the name, `2` or `3`. |

| `style`     | `lowerCase` | Name output case style.                 |

### Outputs

| Parameter | Description               |

| --------- | ------------------------- |

| `name`    | The generated random name |

## Example usage

```yml

uses: thclark/[email protected]

```

```yml

uses: thclark/[email protected]

id: generator

with:

  separator: "_"

  length: "4"

  style: "upperCase"

name: test generator output

run: echo "latest,${{ steps.generator.outputs.name }}"

```

## Development

See the [build instructions](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#commit-tag-and-push-your-action-to-github)

for node based actions in order to build `index.js` to `dist/index.js`