python-semantic-release/action.yml at master · fabienric/python-semantic-release · 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
---
name: "Python Semantic Release"

description: "Automatic Semantic Versioning for Python projects"

inputs:
  root_options:
    description: "Additional options for the main command. Example: -vv --noop"
    required: false
    default: "-v"

  directory:
    description: "Sub-directory to cd into before running semantic-release"
    default: "."
    required: false

  github_token:
    description: "GitHub token used to push release notes and new commits/tags"
    required: true

  git_committer_name:
    description: "The human name for the “committer” field"
    default: "github-actions"
    required: false

  git_committer_email:
    description: "The email address for the “committer” field"
    default: "github-actions@github.com"
    required: false

  ssh_public_signing_key:
    description: "The ssh public key used to sign commits"
    required: false

  ssh_private_signing_key:
    description: "The ssh private key used to sign commits"
    required: false

  # `semantic-release version` command line options
  prerelease:
    type: string
    required: false
    description: |
      Force the next version to be a prerelease. Set to "true" or "false".

  prerelease_token:
    type: string
    required: false
    description: "Force the next version to use this prerelease token, if it is a prerelease"

  force:
    type: string
    required: false
    description: |
      Force the next version to be a major release. Must be set to
      one of "prerelease", "patch", "minor", or "major".

  commit:
    type: string
    required: false
    description: Whether or not to commit changes locally. Defaults are handled
      by python-semantic-release internal version command.

  tag:
    type: string
    required: false
    description: |
      Whether or not to make a local version tag. Defaults are handled
      by python-semantic-release internal version command.

  push:
    type: string
    required: false
    description: |
      Whether or not to push local commits to the Git repository. See
      the configuration page for defaults of `semantic-release version`
      for how the default is determined between push, tag, & commit.

  changelog:
    type: string
    required: false
    description: |
      Whether or not to update the changelog.

  vcs_release:
    type: string
    required: false
    description: |
      Whether or not to create a release in the remote VCS, if supported

  build_metadata:
    type: string
    required: false
    description: |
      Build metadata to append to the new version

outputs:
  released:
    description: |
      "true" if a release was made, "false" otherwise

  version:
    description: |
      The newly released version if one was made, otherwise the current version

  tag:
    description: |
      The Git tag corresponding to the version output

runs:
  using: "docker"
  image: "Dockerfile"