Skip to content

Commit d83ce65

Browse files
authored
Merge pull request #202 from masatake/update-docs
maint: update the document for describing the steps for making a new …
2 parents 07c848f + 4841041 commit d83ce65

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

HOW_TO_RELEASE.rst

+31-13
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,26 @@ e.g.
3737
In this case, you can use 4.94.0 as the version number. If the
3838
condition doesn't meet, use 4.94.1 (or 4.95.0).
3939

40+
3. Put a tag with Git
41+
=======================================================
42+
43+
NOTE: this step is an optional if the commit for releasing is already
44+
tagged via another dialect.
45+
46+
The tag you will put should have the same name as the version given in
47+
the step 2.
48+
49+
Do "git tag" like::
50+
51+
$ git tag 4.95.0-this-is-an-example
52+
$ git push upstream 4.95.0-this-is-an-example
53+
54+
If you took a mistake, you can delete the tag like::
55+
56+
$ git tag -d 4.95.0-this-is-an-example
57+
$ git push upstream :4.95.0-this-is-an-example
4058

41-
3. Make the source archive for the release
59+
4. Make the source archive for the release
4260
=======================================================
4361
::
4462

@@ -61,49 +79,49 @@ e.g.
6179
$ make
6280
$ make check (if your dialect support the target)
6381

64-
4. Visit https://github.com/lsof-org/lsof/releases
82+
5. Visit https://github.com/lsof-org/lsof/releases
6583
========================================================================
6684

67-
4.1 Click [Draft new release]
85+
5.1 Click [Draft new release]
6886
------------------------------------------------------------------------
6987

70-
4.2 Fill the fields
88+
5.2 Fill the fields
7189
------------------------------------------------------------------------
7290

73-
4.2.1 Fill "Tag version"
91+
5.2.1 Choose a tag
7492
........................................................................
7593

76-
Fill with the version number given in the step 2.
94+
Choose with the tag given in the step 3.
7795

78-
4.2.2 Fill "Release title"
96+
5.2.2 Fill "Release title"
7997
........................................................................
8098

8199
Use the following form lsof-${theVersionNumber}-${dialect}.
82100

83101
e.g. lsof-4.94.0-linux
84102

85-
4.2.3 Fill "Describe this release"
103+
5.2.3 Fill "Describe this release"
86104
........................................................................
87105

88106
Copy and paste the changes described in 00DIST since the last release in
89107
your dialect.
90108

91-
4.2.4 Put the source archive generated step in 3.
109+
5.2.4 Put the source archive generated step in 4.
92110
........................................................................
93111

94112
Click "Attach binaries by dropping them here or selecting them. ", then
95113
specify the archive file.
96114

97-
4.2.5 Check "This is a pre-release"
115+
5.2.5 Check "This is a pre-release"
98116
........................................................................
99117

100-
4.2.6 Click [Publish release]
118+
5.2.6 Click [Publish release]
101119
........................................................................
102120

103-
5. Verify the release
121+
6. Verify the release
104122
========================================================================
105123

106-
After step 4.2.6, the browser may show the page for the release. You can
124+
After step 5.2.6, the browser may show the page for the release. You can
107125
re-read the description and the source code archives. You can verify
108126
what you did here.
109127

0 commit comments

Comments
 (0)