release-drafter/action.yml at main · step-security/release-drafter · 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
name: 'Release Drafter'
description:
  'Drafts your next release notes as pull requests are merged into your
  branch(es).'
author: step-security
branding:
  icon: edit-2
  color: orange
runs:
  using: node24
  main: dist/actions/drafter/run.js

inputs:
  config-name:
    description: |
      If your workflow requires multiple release-drafter configs it be helpful to override the config-name.
      The config should still be located inside `.github` as that's where we are looking for config files.
    required: false
    default: 'release-drafter.yml'
  token:
    description: >
      Access token used to make requests against the GitHub API. Defaults to
      github.token.
    default: ${{ github.token }}
  name:
    description: |
      The name that will be used in the GitHub release that's created or updated.
      This will override any `name-template` specified in your `release-drafter.yml` if defined.
    required: false
  tag:
    description: |
      The tag name to be associated with the GitHub release that's created or updated.
      This will override any `tag-template` specified in your `release-drafter.yml` if defined.
    required: false
  version:
    description: |
      The version to be associated with the GitHub release that's created or updated.
      This will override any version calculated by the release-drafter.
    required: false
  publish:
    description: |
      A boolean indicating whether the release being created or updated should be immediately published.
    required: false
    default: ''
  latest:
    description: |
      A boolean indicating whether the release being created or updated should be marked as latest.
    required: false
    default: ''
  prerelease:
    description: |
      Whether to draft a prerelease, with changes since another prerelease (if applicable). Default `false`.
    required: false
    default: ''
  prerelease-identifier:
    description: |
      A string indicating an identifier (alpha, beta, rc, etc), to increment the prerelease version. This automatically enables `prerelease` when both values come from the same config location; explicit action inputs still take precedence.
    required: false
    default: ''
  'include-pre-releases':
    description: |
      When looking for the last published release to scan changes up-to, include pre-releases. Has no effect if using `prerelease: true` (already enabled). Default `false`.
    required: false
    default: ''
  commitish:
    description: |
      The release target, i.e. branch, commit SHA, or fully qualified tag or pull request ref it should point to.
      Tag and pull request refs are resolved to commit SHAs.
      Pull request merge refs force dry-run mode and disable publishing because they point to ephemeral merge commits.
      Defaults to the branch that release-drafter runs for, e.g. `main` when configured to run on pushes to `main`.
    required: false
    default: ''
  header:
    description: |
      A string that would be added before the template body.
    required: false
    default: ''
  footer:
    description: |
      A string that would be added after the template body.
    required: false
    default: ''
  dry-run:
    description: |
      A boolean indicating whether to run without performing any write operations.
      When enabled, the action logs what it would have done instead of creating or updating releases.
    required: false
    default: ''
  filter-by-range:
    description: |
      Filter releases that satisfies this semver range. Evaluates the tag name againts node's semver.satisfies().
    required: false
    default: ''

outputs:
  id:
    description: The ID of the release that was created or updated.
  name:
    description: The name of the release
  tag_name:
    description: The name of the tag associated with the release.
  body:
    description: The body of the drafted release.
  html_url:
    description: The URL users can navigate to in order to view the release
  upload_url:
    description:
      The URL for uploading assets to the release, which could be used by GitHub
      Actions for additional uses, for example the @actions/upload-release-asset
      GitHub Action.
  major_version:
    description:
      The next major version number. For example, if the last tag or release was
      v1.2.3, the value would be v2.0.0.
  minor_version:
    description:
      The next minor version number. For example, if the last tag or release was
      v1.2.3, the value would be v1.3.0.
  patch_version:
    description:
      The next patch version number. For example, if the last tag or release was
      v1.2.3, the value would be v1.2.4.
  resolved_version:
    description: The next resolved version number, based on GitHub labels.