Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@ jobs:
echo exit code $?
git tag --list

# jgitver only treats annotated tags as releases. A tag created in the GitHub Releases page is lightweight and
# would be built as a snapshot, so annotate the plain x.y.z tags (locally, on the runner only). Tags with a
# suffix (e.g. 1.5.0-xp, experimental releases) are intentionally left lightweight.
- name: Annotate the release tag
if: github.ref_type == 'tag'
run: |
if [[ "$GITHUB_REF_NAME" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
git -c user.name="github-actions[bot]" -c user.email="41898282+github-actions[bot]@users.noreply.github.com" \
tag -f -a "$GITHUB_REF_NAME" -m "Release $GITHUB_REF_NAME" "$GITHUB_REF_NAME^{commit}"
else
echo "Tag $GITHUB_REF_NAME is not a plain x.y.z version: left as it is (experimental release)."
fi

- name: Set up JDK 17
uses: actions/setup-java@v4
with:
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,18 @@ git tag -a 1.2.29
# Your EDITOR will open. Write a good message and save as it is used on Github as a release message
git push origin 1.2.29
```
Then you need to [create a new release](https://github.com/feedzai/feedzai-openml-java/releases/new) with this tag.
Alternatively, [create a new release](https://github.com/feedzai/feedzai-openml-java/releases/new) directly in GitHub, choosing
"Create new tag on publish": the tag it creates is lightweight, so the [deploy workflow](.github/workflows/deploy.yml) annotates
plain `x.y.z` tags before building (on the runner only; the tag in the repository is not changed).
In both cases create (or edit) the release for this tag on GitHub to publish the release notes.
There is a "Generate release notes" button available to create the release notes, just organize them according [to the previous ones](https://github.com/feedzai/feedzai-openml-java/releases).

### Experimental Release

For experimental releases, the process is the same as above but with a lightweight tag instead of annotated.
For experimental releases, the process is the same as above but with a lightweight tag instead of annotated. The tag name must have a
suffix (for example `1.5.0-xp`): the deploy workflow annotates plain `x.y.z` tags, which makes them public releases.
```bash
#the xp part is not needed, what matters is that the tag is not annotated, but is a good indicator for others that this was a tag for an experimental release
#the xp suffix is needed: a plain x.y.z tag is turned into a public release by the deploy workflow. The tag must not be annotated
git tag 1.5.0-xp
git push origin 1.5.0-xp
```
Expand Down
38 changes: 30 additions & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,19 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.source>1.8</project.source>
<java.release>8</java.release>
<junit.version>4.13.1</junit.version>
<junit.version>4.13.2</junit.version>
<assertj.version>3.7.0</assertj.version>
<openml-api.version>1.2.0</openml-api.version>
<jackson.version>2.6.7</jackson.version>
<jackson-databind.version>2.6.7</jackson-databind.version>
<commons-io.version>2.7</commons-io.version>
<jackson.version>2.21.8</jackson.version>
<jackson-annotations.version>2.21</jackson-annotations.version>
<jackson-databind.version>2.21.8</jackson-databind.version>
<commons-io.version>2.21.0</commons-io.version>
<apache.version>1.8</apache.version>
<log4j.version>2.20.0</log4j.version>
<log4j.version>2.24.3</log4j.version>
<guava.version>33.4.8-jre</guava.version>
<logback.version>1.3.16</logback.version>
<slf4j.version>2.0.17</slf4j.version>
<commons-lang3.version>3.19.0</commons-lang3.version>
</properties>

<dependencyManagement>
Expand Down Expand Up @@ -126,14 +131,31 @@
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>${jackson.version}</version>
<version>${jackson-annotations.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson-databind.version}</version>
</dependency>

<!-- Override the versions managed by the imported openml pom -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>${guava.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>${logback.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>${logback.version}</version>
</dependency>

<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
Expand All @@ -143,13 +165,13 @@
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.36</version>
<version>${slf4j.version}</version>
</dependency>

<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.13.0</version>
<version>${commons-lang3.version}</version>
</dependency>

<dependency>
Expand Down
Loading