File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change 5
5
6
6
7
7
def main ():
8
+ """
9
+ Parses the command-line arguments release.py has been called with and
10
+ runs the respective command.
11
+
12
+ Valid commands:
13
+ - release.py check-changelog --tag <GIT TAG>
14
+ Checks whether the Git tag provided in the --tag option exists
15
+ in the changelog. If it doesn't, release.py will error.
16
+ - release.py print-changelog --tag <GIT TAG>
17
+ Prints the changelog for the Git tag provided in the --tag option
18
+ to Stdout. The output will be empty if the tag isn't in the
19
+ changelog.
20
+
21
+ release.py expects the Git tag to start with `v`, e.g. `v0.1.2`. In the
22
+ changelog however, only the release numbers are expected, e.g. `0.1.2`.
23
+ Headings for releases need to be in the syntax `## [0.1.2]`.
24
+ """
8
25
parser = argparse .ArgumentParser ()
9
26
parser .add_argument ("run" , type = str , help = "the task to run" )
10
27
parser .add_argument ("--tag" , type = str , help = "the Git tag to work with" )
You can’t perform that action at this time.
0 commit comments