release-gen/action.yml at main · agilecustoms/release-gen · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
name: Generate release
description: 'Generate next release version and notes'
author: Alexey Chekulaev
inputs:
  changelog_file:
    description: 'CHANGELOG.md file path. Pass empty string to disable changelog generation'
    required: false
    default: CHANGELOG.md
  changelog_title:
    description: 'Title of the changelog file (first line of the file)'
    required: false
  floating_tags:
    description: 'When next version to be released is 1.2.4, then also release 1, 1.2 and latest. Not desired for public terraform modules'
    required: false
  notes_tmp_file:
    description: 'Temporary file to store release notes'
    required: false
    default: /tmp/release-gen-notes
  release_branches:
    required: false
    description: 'The branches on which releases should happen. It will override the branches attribute in your configuration file'
  release_channel:
    description: 'Basically a tag that moves on each release, primarily used with with input `version`'
    required: false
  release_plugins:
    description: 'Release plugins configuration'
    required: false
  tag_format:
    description: 'Git tag format, applied only to output git_tags. Default: v${version}'
    required: false
  version:
    description: 'Explicit version to use instead of auto-generation'
    required: false
  version_bump:
    description: 'Allows to bump a version w/o semantic commits'
    required: false

runs:
  using: 'node24'
  main: 'dist/index.js'

outputs:
  channel: # 1) used in 'git notes' to power prerelease flow; 2) used in 'npm publish --tag'
    description: 'Release channel such as latest (for main branch), next (for prerelease) or support (for maintenance)'
  version:
    description: 'The next release version (bare semantic version, e.g. 1.2.3, no tag format applied) generated by the action based on commits since last release tag'
  git_tags:
    description: 'Space-separated git tags to create: version and floating versions with tag format applied (v1.2.3 v1.2 v1) + channel'
  notes_tmp_file:
    description: 'Equal to corresponding input, just for convenience'
  prerelease:
    description: 'Whether the release is a prerelease or not'
  tags:
    description: 'Space-separated artifact tags (S3 path, Docker image tag): bare version and floating versions (1.2.3 1.2 1) + channel'