Skip to content

Commit c13647c

Browse files
committed
Better RELEASE_HOWTO.md
1 parent 91a1d98 commit c13647c

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

RELEASE_HOWTO.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,38 +17,41 @@ Maven repository currently used by css4j-dom4j.
1717

1818
## Steps
1919

20-
1) In the `master` branch of your local copy of the css4j-dom4j Git repository,
21-
bump the `version` in the [`build.gradle`](build.gradle) file or remove the
22-
`-SNAPSHOT` suffix as necessary. Commit the change to the Git repository.
23-
24-
2) If there is an issue tracking the release, close it (could be done adding a
25-
'closes...' to the message in the previously described commit).
26-
27-
3) If your local copy of the css4j-dom4j Git repository exactly matches the current
20+
1) If your local copy of the css4j-dom4j Git repository exactly matches the current
2821
`master` HEAD, use that copy to execute the `gradlew` commands shown later,
2922
otherwise create a new clone of the `[email protected]:css4j/css4j-dom4j.git`
3023
repository with `git clone` and use it.
3124

3225
For reference, let your copy of the css4j-dom4j release code be at
3326
`/path/to/css4j-dom4j`.
3427

35-
4) To check that everything is fine, build the code:
28+
2) Execute `./changes.sh <new-version>` to create a `CHANGES.txt` file with the
29+
changes from the latest tag. For example if you are releasing `4.1`:
3630

3731
```shell
38-
cd /path/to/css4j-dom4j
39-
./gradlew build
32+
./changes.sh 4.1
4033
```
4134

42-
5) Use `changes.sh <new-version>` to create a `CHANGES.txt` file with the
43-
changes from the latest tag. For example if you are releasing `4.1`:
35+
Edit the resulting `CHANGES.txt` as convenient and use it as the basis to update
36+
the `RELEASE_NOTES.md` document. Paste the list of changes in under the
37+
`## Detail of changes` section.
38+
39+
3) In the `master` branch of your local copy of the css4j-dom4j Git repository,
40+
bump the `version` in the [`build.gradle`](build.gradle) file or remove the
41+
`-SNAPSHOT` suffix as necessary.
42+
43+
Commit the changes (`build.gradle` + `RELEASE_NOTES.md`) to the Git repository.
44+
45+
4) If there is an issue tracking the release, close it (could be done adding a
46+
'closes...' to the message in the previously described commit).
47+
48+
5) To check that everything is fine, build the code:
4449

4550
```shell
46-
./changes.sh 4.1
51+
cd /path/to/css4j-dom4j
52+
./gradlew build
4753
```
4854

49-
Edit the resulting `CHANGES.txt` as convenient, to use it as the basis for the
50-
detailed list of changes when you create the new release in Github.
51-
5255
6) Clone the `[email protected]:css4j/css4j.github.io.git` repository (which
5356
contains a bare-bones Maven repository) and let `/path/to/css4j.github.io` be
5457
its location.

0 commit comments

Comments
 (0)