Skip to content

Commit

Permalink
Better RELEASE_HOWTO.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosame committed Aug 19, 2023
1 parent 91a1d98 commit c13647c
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions RELEASE_HOWTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,38 +17,41 @@ Maven repository currently used by css4j-dom4j.

## Steps

1) In the `master` branch of your local copy of the css4j-dom4j Git repository,
bump the `version` in the [`build.gradle`](build.gradle) file or remove the
`-SNAPSHOT` suffix as necessary. Commit the change to the Git repository.

2) If there is an issue tracking the release, close it (could be done adding a
'closes...' to the message in the previously described commit).

3) If your local copy of the css4j-dom4j Git repository exactly matches the current
1) If your local copy of the css4j-dom4j Git repository exactly matches the current
`master` HEAD, use that copy to execute the `gradlew` commands shown later,
otherwise create a new clone of the `git@github.com:css4j/css4j-dom4j.git`
repository with `git clone` and use it.

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

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

```shell
cd /path/to/css4j-dom4j
./gradlew build
./changes.sh 4.1
```

5) Use `changes.sh <new-version>` to create a `CHANGES.txt` file with the
changes from the latest tag. For example if you are releasing `4.1`:
Edit the resulting `CHANGES.txt` as convenient and use it as the basis to update
the `RELEASE_NOTES.md` document. Paste the list of changes in under the
`## Detail of changes` section.

3) In the `master` branch of your local copy of the css4j-dom4j Git repository,
bump the `version` in the [`build.gradle`](build.gradle) file or remove the
`-SNAPSHOT` suffix as necessary.

Commit the changes (`build.gradle` + `RELEASE_NOTES.md`) to the Git repository.

4) If there is an issue tracking the release, close it (could be done adding a
'closes...' to the message in the previously described commit).

5) To check that everything is fine, build the code:

```shell
./changes.sh 4.1
cd /path/to/css4j-dom4j
./gradlew build
```

Edit the resulting `CHANGES.txt` as convenient, to use it as the basis for the
detailed list of changes when you create the new release in Github.

6) Clone the `git@github.com:css4j/css4j.github.io.git` repository (which
contains a bare-bones Maven repository) and let `/path/to/css4j.github.io` be
its location.
Expand Down

0 comments on commit c13647c

Please sign in to comment.