Skip to content

Commit

Permalink
Document libtool versioning process
Browse files Browse the repository at this point in the history
  • Loading branch information
ZoltanFridrich authored and radosroka committed Nov 5, 2020
1 parent 1aa215d commit 6f620c0
Show file tree
Hide file tree
Showing 3 changed files with 5,239 additions and 15 deletions.
40 changes: 30 additions & 10 deletions RELEASE_PROCESS.md
@@ -1,25 +1,45 @@
# USBGuard Release Process

1. Clean up any artifact from your local repository.
1. Clean up any artifacts from your local repository.

```
$ git clean -x -f -d
$ git clean -xfd
```

2. Run the test suite. All the tests must pass.
2. Setup build directory.

```
$ ./autogen.sh
$ mkdir build; cd build
$ mkdir build && cd build
$ ../configure --enable-full-test-suite --with-crypto-library=gcrypt --with-ldap
$ make
```

3. Run the test suite. All the tests must pass.

```
$ sudo make check
$ cd ..; rm -rf build
```

3. Update the `VERSION` file and `CHANGELOG.md`. Commit your changes.
4. Compare previous lib version with current.

```
$ abidiff --stat ../abi-ref/libusbguard.so.abi .libs/libusbguard.so
$ cd ..
```

5. Update the lib version (CURRENT, REVISION, AGE) in `configure.ac` according to comments.

6. Update ABI reference.

```
$ abidw --out-file abi-ref/libusbguard.so.abi build/.libs/libusbguard.so
$ sudo rm -rf build
```

7. Update the `VERSION` file and `CHANGELOG.md`. Commit your changes.

4. Build the final release tarball.
8. Build the final release tarball.

```
$ ./autogen.sh
Expand All @@ -28,22 +48,22 @@ $ ../configure --with-crypto-library=gcrypt
$ make dist
```

5. Tag the release with a signed tag.
9. Tag the release with a signed tag.

```
$ git tag -s -m "usbguard-0.x.y" usbguard-0.x.y
$ git push origin usbguard-0.x.x
```

6. Hash and sign the release.
10. Hash and sign the release.

```
$ sha256sum usbguard-0.x.y.tar.gz > usbguard-0.x.y.tar.gz.sum
$ gpg --armor --detach-sign usbguard-0.x.y.tar.gz
$ gpg --clearsign usbguard-0.x.y.tar.gz.sum
```

7. Create a new GitHub release using the associated tag; add the relevant section from CHANGELOG.md. Upload:
11. Create a new GitHub release using the associated tag; add the relevant section from CHANGELOG.md. Upload:

* usbguard-0.x.y.tar.gz
* usbguard-0.x.y.tar.gz.asc
Expand Down

0 comments on commit 6f620c0

Please sign in to comment.