https://github.com/fregante/daily-version-action

Creates a new tag using the format Y.M.D, but only if HEAD isn’t already tagged
https://github.com/fregante/daily-version-action

Last synced: 3 days ago
JSON representation

Creates a new tag using the format Y.M.D, but only if HEAD isn’t already tagged

• Host: GitHub
• URL: https://github.com/fregante/daily-version-action
• Owner: fregante
• License: mit
• Created: 2020-05-30T16:36:21.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-25T09:28:50.000Z (4 months ago)
• Last Synced: 2024-10-26T10:43:38.642Z (8 days ago)
• Language: JavaScript
• Homepage:
• Size: 520 KB
• Stars: 21
• Watchers: 3
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# daily-version-action



Creates a new tag using the format `Y.M.D` (using [daily-version](https://github.com/fregante/daily-version)), but only if `HEAD` isn’t already tagged.

Ideally used on schedule, but you could also change the suggested condition to only make it run on `main`.

See usage real-world [example on Refined GitHub’s repo](https://github.com/refined-github/refined-github/blob/5cda3447bf80cca0c64ae5eb79779ecd62fec18e/.github/workflows/release.yml#L30-L32)

## Usage

It expects `git` to be configured to push to the same repo. The `v2` and later of `actions/checkout` automatically sets required token and, if not set, this action will use the git user `daily-version-action ` to create the tag. This can be customized with something like [setup-git-token](https://github.com/fregante/setup-git-token).

See [action.yml](action.yml)

```yaml

  Version:

    steps:

    - uses: actions/checkout@v4

    - name: Create tag if necessary

      uses: fregante/daily-version-action@v2

```

You can use the `DAILY_VERSION_CREATED` and `DAILY_VERSION` environment variables created by this action to test whether a new version has been created:

```yaml

    - name: Create tag if necessary

      uses: fregante/daily-version-action@v2

    - name: Created?

      if: env.DAILY_VERSION_CREATED

      runs: echo "Yes, created $DAILY_VERSION"

```

If you prefer, you can use its outputs too, which can also work [across jobs](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjobs_idoutputs):

```yaml

    - name: Create tag if necessary

      id: version

      uses: fregante/daily-version-action@v2

    - name: Created?

      if: steps.version.outputs.created

      runs: echo "Created ${{ steps.version.outputs.version }}"

```

## Inputs

- `prefix` - Optional. You can specify what to prefix the tag name with. For example:

```yaml

  Version:

    steps:

    - uses: actions/checkout@v4

    - name: Create tag if necessary

      uses: fregante/daily-version-action@v2

      with:

        prefix: v # This will cause the tags to start with v, like "v20.12.31`

```

## Outputs

- `created` - If this output exists, this action created a new tag.

- `version` - The latest tag, whether it already existed or if it just created one.

Outputs can be [used across jobs](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjobs_idoutputs) as well.

## Examples

### Nightly release

Here's a complete workflow to create a nightly release, when necessary: ([original here](https://github.com/fregante/ghatemplates#webextreleaseyml))

```yml

on:

  schedule:

    - cron: '59 23 * * *'

jobs:

  Tag:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v4

    - uses: fregante/daily-version-action@v2

      name: Create tag if necessary

      id: daily-version

    outputs: # Shares the action’s outputs to the Next jobs

      created: ${{ steps.daily-version.outputs.created }}

      version: ${{ steps.daily-version.outputs.version }}

  Next:

    needs: Tag

    if: needs.Tag.outputs.created

    runs-on: ubuntu-latest

    steps:

      - run: echo It looks like ${{ needs.Tag.outputs.version }} was created!

```

## Related

- 🛕 [action-release](https://github.com/fregante/ghatemplates/blob/main/readme.md#action-release) - A workflow to help you release your actions.

- [title-to-labels-action](https://github.com/fregante/title-to-labels-action) - Cleans up the titles of issues and PRs from common opening keywords.

- [setup-git-user](https://github.com/fregante/setup-git-user) - GitHub Action that sets git user and email to enable committing.