Added publishing tasks to the build #124

rozza · 2025-09-04T11:08:18Z

Changes include:

evergreen updates to support publishing tasks
github workflows to trigger the release
javadoc updates:
- Configure links to linked sources
- Set encoding to UTF-8
- Fix no comment warnings in the code

Changes include: - evergreen updates to support publishing tasks - github workflows to trigger the release - javadoc updates: - Configure links to linked sources - Set encoding to UTF-8 - Fix no comment warnings in the code HIBERNATE-81

rozza · 2025-09-04T11:20:50Z

.evergreen/config.yml


  bootstrap-mongo-orchestration:
    - command: subprocess.exec
+      type: test


These are evergreen validation fixes related to errors produced on line 96 and on line 110 & 124

rozza · 2025-09-04T11:22:06Z

.evergreen/publish.sh

+export ORG_GRADLE_PROJECT_signingPassword=${SIGNING_PASSWORD}
+
+if [ "$RELEASE" == "true" ]; then
+  TASK="publishArchives closeSonatypeStagingRepository" # TODO - update to closeAndReleaseSonatypeStagingRepository


This allows for inspection in the maven central portal to manually release.
Eventually this should be updated to automatic close and release via the closeAndReleaseSonatypeStagingRepository commands.

If this TODO is something we cannot do now, but should do in the future, then

Let's create a corresponding Jira task, which explains what needs to be done, and addresses when it should be done, as "eventually" is unclear.

Then, if, for example, there is a need to point to a specific line in the codebase, and say that the line is to be changed when working on the task, we should leave a note in the following format: TODO-<HIBERNATE ticket ID> <the text of the note>. Example:

mongo-hibernate/src/main/java/com/mongodb/hibernate/internal/extension/service/StandardServiceRegistryScopedState.java

Line 95 in 1396799

// TODO-HIBERNATE-43 `LOGGER.debug("{} is not detected", ...)`

.

Leave a note in the description of the ticket, reminding the assignee about the related TODO notes in the code: "Addressing the source code notes tagged with TODO- is in scope of this ticket.". Example: see the description of https://jira.mongodb.org/browse/HIBERNATE-43.

The approach described above was agreed to previously, and is used consistently throughout this codebase and HIBERNATE tickets.

Done - added HIBERNATE-128 to track.

rozza · 2025-09-04T11:22:27Z

.github/workflows/bump-and-tag.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash


Copy and paste from the java repo

Let's decide to use either #!/usr/bin/env bash or #!/bin/bash, and use only one variant in all Bash scripts. I see claims that the first variant is more portable (https://stackoverflow.com/a/10383546/1285873), but also "poses a privilege escalation security threat "

Opted to use #!/usr/bin/env bash for portability.

The idea of a privilege escalation security threat when executing
a bash script with such a shebang, requires the user to manipulate
the PATH - so realistically the security of the system would have
already been compromised.

src/main/java/com/mongodb/hibernate/annotations/package-info.java

src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java

rozza · 2025-09-04T11:25:11Z

build.gradle.kts

+    standardDocletOptions.apply {
+        author(true)
+        version(true)
+        encoding = "UTF-8"


Added UTF-8 encoding as javadoc failed without it.

rozza · 2025-09-04T11:25:32Z

build.gradle.kts

+        addBooleanOption("html5", true)
+        addBooleanOption("-allow-script-in-comments", true)
+        links =
+            listOf(


Add the inter-linking javadoc support

rozza · 2025-09-04T11:26:47Z

build.gradle.kts

 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 // Integration Test

+// Added `Action` explicitly due to an intellij 2025.2 false positive: https://youtrack.jetbrains.com/issue/KTIJ-34210


Not related to publishing but clears the intellij warning in the latest versions of intellij.

rozza · 2025-09-04T11:28:06Z

build.gradle.kts

+}
+
+// Gets the git version
+val gitVersion: String by lazy {


Added git versioning check for the version check in the publishArchives task.

rozza · 2025-09-04T11:28:52Z

gradle.properties

 # limitations under the License.

-version=1.0.0-SNAPSHOT
+version=0.1.0-SNAPSHOT


I changed this to 0.1.0-SNAPSHOT as I can plan & test the github action for a 0.1.0 test release.

rozza · 2025-09-04T11:30:54Z

Confirmation of the publish-snapshot task publishing to the maven central snapshots repo:
mongodb-hibernate/0.1.0-SNAPSHOT

stIncMale · 2025-09-26T14:07:45Z

.github/workflows/bump-and-tag.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash


Let's decide to use either #!/usr/bin/env bash or #!/bin/bash, and use only one variant in all Bash scripts. I see claims that the first variant is more portable (https://stackoverflow.com/a/10383546/1285873), but also "poses a privilege escalation security threat "

stIncMale · 2025-09-26T14:17:17Z

.evergreen/publish.sh

+export ORG_GRADLE_PROJECT_signingPassword=${SIGNING_PASSWORD}
+
+if [ "$RELEASE" == "true" ]; then
+  TASK="publishArchives closeSonatypeStagingRepository" # TODO - update to closeAndReleaseSonatypeStagingRepository


If this TODO is something we cannot do now, but should do in the future, then

Let's create a corresponding Jira task, which explains what needs to be done, and addresses when it should be done, as "eventually" is unclear.

Then, if, for example, there is a need to point to a specific line in the codebase, and say that the line is to be changed when working on the task, we should leave a note in the following format: TODO-<HIBERNATE ticket ID> <the text of the note>. Example:

mongo-hibernate/src/main/java/com/mongodb/hibernate/internal/extension/service/StandardServiceRegistryScopedState.java

Line 95 in 1396799

// TODO-HIBERNATE-43 `LOGGER.debug("{} is not detected", ...)`

.

Leave a note in the description of the ticket, reminding the assignee about the related TODO notes in the code: "Addressing the source code notes tagged with TODO- is in scope of this ticket.". Example: see the description of https://jira.mongodb.org/browse/HIBERNATE-43.

The approach described above was agreed to previously, and is used consistently throughout this codebase and HIBERNATE tickets.

gradle/libs.versions.toml

src/main/java/com/mongodb/hibernate/package-info.java

src/main/java/com/mongodb/hibernate/annotations/package-info.java

src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java

.evergreen/publish.sh

HIBERNATE-81

Using `#!/usr/bin/env bash` ensures portability. The idea of a privilege escalation security threat when executing a bash script with such a shebang, requires the user to manipulate the PATH - so realistically the security of the system would have already been compromised.

Co-authored-by: Valentin Kovalenko <valentin.male.kovalenko@gmail.com>

HIBERNATE-81

stIncMale

Thank you, Ross. There is only one more thing to address, which I proposed a commit for.

build.gradle.kts

stIncMale · 2025-10-15T23:30:04Z

The last reviewed commit is 142c5e4.

stIncMale

The last reviewed commit is 78acc90.

Added publishing tasks to the build

a0c20c3

Changes include: - evergreen updates to support publishing tasks - github workflows to trigger the release - javadoc updates: - Configure links to linked sources - Set encoding to UTF-8 - Fix no comment warnings in the code HIBERNATE-81

rozza requested a review from a team as a code owner September 4, 2025 11:08

rozza requested review from stIncMale and removed request for a team September 4, 2025 11:08

rozza commented Sep 4, 2025

View reviewed changes

Merge branch 'main' into H81

20ca741

stIncMale requested changes Sep 26, 2025

View reviewed changes

rozza commented Sep 29, 2025

View reviewed changes

.evergreen/publish.sh Outdated Show resolved Hide resolved

rozza and others added 7 commits September 29, 2025 10:54

Update .evergreen/publish.sh

127e4ef

Undo some documentation changes, exclude some packages

99fcda2

HIBERNATE-81

Added java version comment for the javadoc

7660fd7

Update the package javadoc

afed3b1

Update src/main/java/com/mongodb/hibernate/annotations/package-info.java

a6f8aca

Co-authored-by: Valentin Kovalenko <valentin.male.kovalenko@gmail.com>

Merge branch 'main' into H81

142c5e4

rozza requested a review from stIncMale September 29, 2025 10:18

Add more javadoc links, deal with the warnings

78acc90

HIBERNATE-81

stIncMale requested changes Oct 15, 2025

View reviewed changes

build.gradle.kts Show resolved Hide resolved

rozza requested a review from stIncMale October 16, 2025 10:56

stIncMale approved these changes Oct 16, 2025

View reviewed changes

rozza merged commit dc8f6af into mongodb:main Oct 16, 2025
7 checks passed

rozza deleted the H81 branch October 16, 2025 15:09

Added publishing tasks to the build #124

Added publishing tasks to the build #124

Uh oh!

Conversation

rozza commented Sep 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rozza Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rozza commented Sep 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stIncMale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stIncMale commented Oct 15, 2025

Uh oh!

stIncMale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rozza Sep 29, 2025 •

edited

Loading