https://github.com/srz-zumix/icon-badge-action

Adds various badges to icon files based on user-defined inputs.
https://github.com/srz-zumix/icon-badge-action

actions badge github-actions icon

Last synced: about 2 months ago
JSON representation

Adds various badges to icon files based on user-defined inputs.

• Host: GitHub
• URL: https://github.com/srz-zumix/icon-badge-action
• Owner: srz-zumix
• Created: 2024-04-18T14:26:37.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T11:02:33.000Z (8 months ago)
• Last Synced: 2024-05-22T12:25:38.440Z (8 months ago)
• Topics: actions, badge, github-actions, icon
• Language: Shell
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# icon-badge-action

Adds various badges to icon files based on user-defined inputs.

This action processes icons using [HazAT/badge](https://github.com/HazAT/badge)

## Supported runner

* Linux

* macOS

## Usage

```yaml

- uses: srz-zumix/icon-badge-action@v1

  with:

    glob: test/assets/*_shield.png

    shield: "icon--badge--action-${{ github.head_ref }}-blue"

```

If the runner you are running is Linux only, you can also use the docker-action version.

```yaml

- uses: srz-zumix/icon-badge-action/docker@v1

  with:

    glob: test/assets/*_shield.png

    shield: "icon--badge--action-${{ github.head_ref }}-blue"

```

## Inputs

### `glob`

Specifies the glob pattern for icon file paths. Default is an empty string.

If it is an empty string, it will be `CURRENT_PATH/**/*.appiconset/*.{png,PNG}`.

### `dark`

Enables dark mode. Default is `false`.

### `grayscale`

Makes the icon grayscale. Default is `false`.

### `alpha_channel`

Keeps the alpha channel. Default is `false`.

### `alpha`

Adds an alpha badge. Default is `false`.

### `beta`

Adds a beta badge. Default is `false`.

### `shield`

Adds a shield static badge string. Default is an empty string.

### `shield_geometry`

Adds a shield static badge geometry. Default is an empty string.

### `shield_scale`

Adds a shield static badge scale. Default is an empty string.

### `shield_no_resize`

Disables resizing of the shield static badge. Default is `false`.

### `cache`

Cache Docker image. Default is `true`.