Add release workflow #13

supl · 2023-08-22T05:11:06Z

This PR adds a new workflow to release Java package and Docker image.

supl · 2023-08-22T05:52:14Z

.github/workflows/release.yml

+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+    branches:
+      - main


This workflow will release tagged and SNAPSHOT versions

.github/workflows/release.yml

supl · 2023-08-22T05:58:02Z

build.gradle

@@ -8,7 +8,7 @@ subprojects {
    }

    group = "com.scalar-labs"
-    project.version = project.findProperty('projVersion') ?: '1.0.0-SNAPSHOT'
+    project.version = project.findProperty('projVersion') ?: '1.1.0-SNAPSHOT'


Since we are ready for 1.0.0, I rename the SNAPSHOT version to 1.1.0.
I would use the rolling release where features and bugfix are managed in the main branch only. There will be no branches to manage minor versions. This is the reason why the SNAPSHOT version in the main branch is not 2.0.0-SNAPSHOT.

I think we should stick to the same model as the other products like ScalarDB and ScalarDL (i.e., the main branch points to the next major release); otherwise, it's too confusing for developers and users working on both projects.
Does it make things difficult?

@feeblefakie

I see.
For me, either {next major}.0.0-SNAPSHOT or 1.{next minor}.0 is reasonable as long as we clearly define the next is about major or minor.
Using {next major}.0.0-SNAPSHOT has a benefit of consistency so it's not difficult to me as well.

I changed the versioning in f8c8575

gradle/wrapper/gradle-wrapper.properties

supl · 2023-08-22T06:01:25Z

lib/archive.gradle

+                name = 'Scalar Admin for Kubernetes'
+                description = 'This library provides a fault-tolerant manner to pause Scalar products in Kubernetes environments and ensure the data is transactionally consistent.'


Please help revise the name and the description.

choplin

Could you tell me why you want to publish this to the Maven repository as a library? As far as I understand, this is a CLI application. If so, it's not necessary to publish it to the Maven.

lib/build.gradle

.github/workflows/release.yml

cli/build.gradle

gradle/wrapper/gradle-wrapper.properties

supl · 2023-08-23T05:27:37Z

Could you tell me why you want to publish this to the Maven repository as a library? As far as I understand, this is a CLI application. If so, it's not necessary to publish it to the Maven.

@choplin
Thank you for your question.

In the original design, we made scalar-admin-k8s able to be integrated, for example, the Scalar Manager can use this library to pause the products in a Kubernetes cluster. The CLI is mainly for the place that could not use Java library, for example, the CronJob or the non-Java application.

supl · 2023-08-23T06:35:43Z

gradlew

@@ -83,7 +83,8 @@ done
 # This is normally unused


This file is changed because my local Gradle was upgraded to 8.3 and I regenerate the Gradle wrapper to upgrade the wrapper from 7.6.2 to 8.1.1. Can ignore this diff.

supl · 2023-08-23T06:38:38Z

gradle/wrapper/gradle-wrapper.properties

@@ -2,5 +2,6 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists


This file is changed because my local Gradle was upgraded to 8.3 and I regenerate the Gradle wrapper to upgrade the wrapper from 7.6.2 to 8.1.1. Can ignore this diff.

.github/workflows/release.yml

choplin · 2023-08-23T06:49:31Z

@supl

In the original design, we made scalar-admin-k8s able to be integrated, for example, the Scalar Manager can use this library to pause the products in a Kubernetes cluster. The CLI is mainly for the place that could not use Java library, for example, the CronJob or the non-Java application.

Thank you for your explanation. Based on that, I'd recommend separating the project into sub-projects of cli and lib, and publishing only the lib project to the maven repo. IMO, it would not be good if the published library contained the main method. (You can do it later in another PR.)

supl · 2023-08-23T06:54:32Z

@supl

In the original design, we made scalar-admin-k8s able to be integrated, for example, the Scalar Manager can use this library to pause the products in a Kubernetes cluster. The CLI is mainly for the place that could not use Java library, for example, the CronJob or the non-Java application.

Thank you for your explanation. Based on that, I'd recommend separating the project into sub-projects of cli and lib, and publishing only the lib project to the maven repo. IMO, it would not be good if the published library contained the main method.

@choplin
I think it is exactly what I have done. (two sub projects and publish the Java package for only the lib part).

.github/workflows/release.yml

choplin · 2023-08-23T06:58:01Z

@supl

I think it is exactly what I have done. (two sub projects and publish the Java package for only the lib part).

Ah, sorry for that. I misunderstood. Thank you for pointing it out.

…n branch merging

choplin

LGTM!

brfrn169

LGTM! Thank you!

feeblefakie

Left some suggestions. PTAL!

feeblefakie · 2023-08-24T08:52:27Z

build.gradle

@@ -8,7 +8,7 @@ subprojects {
    }

    group = "com.scalar-labs"
-    project.version = project.findProperty('projVersion') ?: '1.0.0-SNAPSHOT'
+    project.version = project.findProperty('projVersion') ?: '1.1.0-SNAPSHOT'


I think we should stick to the same model as the other products like ScalarDB and ScalarDL (i.e., the main branch points to the next major release); otherwise, it's too confusing for developers and users working on both projects.
Does it make things difficult?

lib/archive.gradle

Co-authored-by: Hiroyuki Yamada <[email protected]>

kota2and3kan

Sorry for my late review...
Overall looks good to me, but I left one question.
Please take a look when you have time!

lib/archive.gradle

Co-authored-by: kota2and3kan <[email protected]>

kota2and3kan

LGTM! Thank you!

feeblefakie

LGTM! Thank you!

supl self-assigned this Aug 22, 2023

supl added the improvement label Aug 22, 2023

Add release workflow

b106a82

supl force-pushed the releasing branch from 1cb63ee to b106a82 Compare August 22, 2023 05:50

supl commented Aug 22, 2023

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

supl commented Aug 22, 2023

View reviewed changes

gradle/wrapper/gradle-wrapper.properties Outdated Show resolved Hide resolved

supl commented Aug 22, 2023

View reviewed changes

supl requested review from brfrn169, choplin, feeblefakie and kota2and3kan August 22, 2023 06:01

choplin reviewed Aug 23, 2023

View reviewed changes

lib/build.gradle Outdated Show resolved Hide resolved

.github/workflows/release.yml Outdated Show resolved Hide resolved

cli/build.gradle Outdated Show resolved Hide resolved

gradle/wrapper/gradle-wrapper.properties Outdated Show resolved Hide resolved

Don't use the Gradle plugin to build Docker images

804f9a3

supl commented Aug 23, 2023

View reviewed changes

choplin reviewed Aug 23, 2023

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

Do conditional statement in shell

d863996

supl requested a review from choplin August 23, 2023 06:54

choplin reviewed Aug 23, 2023

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

supl added 4 commits August 23, 2023 16:01

Make the Docker image to Support multiple platforms

2051d88

Remove unnecessary conditional statement

c4235a2

Throw an error if the workflow is not triggered by tag pushing or mai…

4091456

…n branch merging

Set a default value when properties are not defined

1e71099

supl requested a review from choplin August 23, 2023 08:15

choplin approved these changes Aug 23, 2023

View reviewed changes

brfrn169 approved these changes Aug 24, 2023

View reviewed changes

Publish lib to GitHub package

504d057

feeblefakie reviewed Aug 24, 2023

View reviewed changes

supl and others added 2 commits August 24, 2023 22:15

Update lib/archive.gradle

06ae619

Co-authored-by: Hiroyuki Yamada <[email protected]>

Make the next definition to be on major versions

f8c8575

supl requested a review from feeblefakie August 24, 2023 13:52

Forgot to build the shadow Jar

6bf8b2c

kota2and3kan reviewed Aug 28, 2023

View reviewed changes

lib/archive.gradle Outdated Show resolved Hide resolved

Update lib/archive.gradle

4436479

Co-authored-by: kota2and3kan <[email protected]>

kota2and3kan approved these changes Aug 28, 2023

View reviewed changes

feeblefakie approved these changes Aug 28, 2023

View reviewed changes

feeblefakie merged commit be56cc0 into main Aug 28, 2023

feeblefakie deleted the releasing branch August 28, 2023 16:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add release workflow #13

Add release workflow #13

supl commented Aug 22, 2023

supl Aug 22, 2023

supl Aug 22, 2023 •

edited

Loading

feeblefakie Aug 24, 2023

supl Aug 24, 2023

supl Aug 22, 2023

choplin left a comment

supl commented Aug 23, 2023

supl Aug 23, 2023

supl Aug 23, 2023

choplin commented Aug 23, 2023 •

edited

Loading

supl commented Aug 23, 2023

choplin commented Aug 23, 2023

choplin left a comment

brfrn169 left a comment

feeblefakie left a comment

feeblefakie Aug 24, 2023

kota2and3kan left a comment

kota2and3kan left a comment

feeblefakie left a comment

		name = 'Scalar Admin for Kubernetes'
		description = 'This library provides a fault-tolerant manner to pause Scalar products in Kubernetes environments and ensure the data is transactionally consistent.'

		@@ -2,5 +2,6 @@ distributionBase=GRADLE_USER_HOME
		distributionPath=wrapper/dists

Add release workflow #13

Add release workflow #13

Conversation

supl commented Aug 22, 2023

supl Aug 22, 2023

Choose a reason for hiding this comment

supl Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

feeblefakie Aug 24, 2023

Choose a reason for hiding this comment

supl Aug 24, 2023

Choose a reason for hiding this comment

supl Aug 22, 2023

Choose a reason for hiding this comment

choplin left a comment

Choose a reason for hiding this comment

supl commented Aug 23, 2023

supl Aug 23, 2023

Choose a reason for hiding this comment

supl Aug 23, 2023

Choose a reason for hiding this comment

choplin commented Aug 23, 2023 • edited Loading

supl commented Aug 23, 2023

choplin commented Aug 23, 2023

choplin left a comment

Choose a reason for hiding this comment

brfrn169 left a comment

Choose a reason for hiding this comment

feeblefakie left a comment

Choose a reason for hiding this comment

feeblefakie Aug 24, 2023

Choose a reason for hiding this comment

kota2and3kan left a comment

Choose a reason for hiding this comment

kota2and3kan left a comment

Choose a reason for hiding this comment

feeblefakie left a comment

Choose a reason for hiding this comment

supl Aug 22, 2023 •

edited

Loading

choplin commented Aug 23, 2023 •

edited

Loading