Skip to content

Commit

Permalink
freebsd-relayd: README: Document publishing a tag
Browse files Browse the repository at this point in the history
  • Loading branch information
0mp committed Jun 8, 2023
1 parent b49957e commit 7aed227
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ The latest tested LibreSSL version is 3.7.2.

## FreeBSD relayd release process

### Publishing a new branch

1. Create a new branch called `release`.

```sh
Expand Down Expand Up @@ -102,3 +104,38 @@ The latest tested LibreSSL version is 3.7.2.
```sh
git push --set-upstream freebsd-relayd "OSMAJOR.OSMINOR.LATEST_COMMIT_DATE"
```

### Publish a release from a version branch

1. Make sure that the local repository is clean. Best way is to either work on
a fresh clone or by running `git clean -fdx`, which removes all untracked
files and directories.

2. Tag a release. The tag should follow this format:
`OSMAJOR.OSMINOR.LATEST_COMMIT_DATE-pPATCHLEVEL`, where `PATCHLEVEL` is the
next tag number on the version branch (starting with 0),
e.g., `7.3.2023.05.09-p0`.

```sh
git tag OSMAJOR.OSMINOR.LATEST_COMMIT_DATE-pPATCHLEVEL
```

3. Create `relayd-OSMAJOR.OSMINOR.LATEST_COMMIT_DATE-pPATCHLEVEL.tar.gz`
with `release-relayd.sh`.

```sh
./release-relayd.sh OSMAJOR.OSMINOR.LATEST_COMMIT_DATE-pPATCHLEVEL
```

Make sure that the archive actually contains all the necessary files to
build relayd.

4. Publish the tag.

```sh
git push --tags
```

5. Create a new release on GitHub based on the newly created tag and attach the
`relayd-OSMAJOR.OSMINOR.LATEST_COMMIT_DATE-pPATCHLEVEL.tar.gz` archive to
the release page.

0 comments on commit 7aed227

Please sign in to comment.