diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d6c4f34a06b11c3e604376030cb7215c2841bfa..4a602406b23eef0e1d78decd1f090a95971c4f75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,12 +74,14 @@ Currently, there is one test to test whether the output of RelAST is a valid inp To achieve this, there are two Gradle tasks. The first produces the usual `.ast` and `.jadd` files, whereas the second task takes the `.ast` as input. The test then ensures, that both output grammars are identical. -# Publishing +# Publishing (Maintainer only) -To publish a new version, the following needs to be done: +Currently, we are publishing to a private Nexus repository only. As a maintainer, to publish a new version, the following needs to be done: -1) Create a new annotated tag with an appropriate version number increase (major, minor, patch) described in [semantic versioning](https://semver.org/) -2) If not already present, create a new file `gradle.properties` with two entries `repoUser` and `repoPassword` for our Nexus repository. -3) Run `./gradlew publish -PwithNewVersion` (maybe also adding ` -PasSnapshot` to create a SNAPSHOT release) +1) Create a new annotated tag with an appropriate version number increase (major, minor, patch) described in [semantic versioning](https://semver.org/) and with "Version $MAJOR.$MINOR.$PATH" as message. +2) If not already present, create a new file `gradle.properties` with two entries `repoUser` and `repoPassword` for our Nexus repository credentials. +3) Decide, if the new version should only be a snapshot version (whose contents can be overridden within the same version) +4) Run `./gradlew publish -PwithNewVersion` (or `./gradlew publish -PwithNewVersion -PasSnapshot` to create a SNAPSHOT release) +5) (Optional) Update the dependencies in other projects using Relational RAGs. [create-issue]: https://git-st.inf.tu-dresden.de/jastadd/relational-rags/issues/new