Skip to content

Commit

Permalink
Update how to release
Browse files Browse the repository at this point in the history
  • Loading branch information
dr0i committed Jan 9, 2025
1 parent 9073421 commit 8f9d15d
Showing 1 changed file with 1 addition and 47 deletions.
48 changes: 1 addition & 47 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,50 +173,4 @@ The *Definition of Done* describes a list of criteria which issues have to meet

### Releasing Metafacture

We use semantic versioning in release numbers `A`.`B`.`C`, i.e. increase `A` when it's a major release breaking backward compatibility; increase `B` when it got new features; increase `C` indicating bug-fixes.

#### Build and publish to GitHub

The following commands trigger a release build.

1. Create a signed tag:
```
git tag -s metafacture-core-A.B.C
```
1. When prompted, add a sensible commit message. For instance, something like:
```
Publish first release of the Metafacture A line
```
1. You can now test the build locally by invoking:
```
./gradlew assemble
```
1. Finally, push the new tag to GitHub to trigger the actual release build:
```
git push --follow-tags metafacture-core-A.B.C
```
#### Publish to Maven Central
Upload archives to sonatype (where they can be released to Maven Central)
1. Make sure to have a clean directory (otherwise only a SNAPSHOT will be built):
```
git status
```
1. You need a `gradle.properties` in the root directory that looks like this:
```
signing.gnupg.executable=gpg
signing.gnupg.useLegacyGpg=true
signing.gnupg.homeDir=$e.g."~/.gnupg"
signing.gnupg.keyName=$yourKeyName
signing.gnupg.passphrase=$keysPassphrase
releaseRepositoryUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/
releaseRepositoryUser=$yourSonatypeUsername
releaseRepositoryPassword=$yourSonatypePassword
```
1. Let the release be built, signed and uploaded:
```
./gradlew publishAllPublicationsToMavenRepository
```
1. Finally, go to oss.sonatype.org , check the `Staging Repositories` when it's finished, and release it by clicking `close`
Follow the [wiki's Maintainer-Guidelines](https://github.com/metafacture/metafacture-core/wiki/Maintainer-Guidelines).

0 comments on commit 8f9d15d

Please sign in to comment.