-
Notifications
You must be signed in to change notification settings - Fork 653
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add gradle release task to remove -SNAPSHOT in examples and jupyter n…
…otebooks. Change-Id: I459c1ba848981c8af929db09219ed2a0596ce914
- Loading branch information
Showing
12 changed files
with
202 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| # Release Process | ||
|
|
||
| ## Overview | ||
|
|
||
| This document outlines the procedure to release Deep Java Library (DJL) project to maven central. | ||
|
|
||
| ## Step 1: Preparing the Release Candidate | ||
|
|
||
| ### Step 1.1 Publish javadoc to S3 bucket | ||
|
|
||
| Make sure you are using correct aws credential and run the following command: | ||
|
|
||
| ```shell script | ||
| cd djl | ||
| ./gradlew -Prelease uploadJavadoc | ||
| ``` | ||
|
|
||
| ### Step 1.2: Bump up versions in documents to point to new url | ||
|
|
||
| Edit [README Release Notes section](../../README.md#release-notes) to add link to new release. | ||
|
|
||
| Update build version with the following command: | ||
| ```shell script | ||
| cd djl | ||
| ./gradlew -PpreviousVersion=X.X.X iFV | ||
| ``` | ||
| Make a commit, get reviewed, and then merge it into github. | ||
|
|
||
| ### Step 1.4: Upload javadoc-index.html to S3 bucket | ||
|
|
||
| ```shell script | ||
| aws s3 cp website/javadoc-index.html s3://javadoc-djl-ai/index.html | ||
| ``` | ||
|
|
||
| ### Step 1.5: Publish mxnet-native library to sonatype staging server | ||
|
|
||
| Run the following command to trigger mxnet-native publishing job: | ||
| ```shell script | ||
| curl -XPOST -u "USERNAME:PERSONAL_TOKEN" -H "Accept: application/vnd.github.everest-preview+json" -H "Content-Type: application/json" https://api.github.com/repos/awslabs/djl/dispatches --data '{"event_type": "mxnet-staging-pub"}' | ||
| ``` | ||
|
|
||
| ### Step 1.6: Remove -SNAPSHOT in examples and jupyter notebooks | ||
|
|
||
| Run the following command with correct version value: | ||
| ```shell script | ||
| cd djl | ||
| git clean -xdff | ||
| ./gradlew release | ||
| git commit -a -m 'Remove -SNAPSHOT for release vX.X.X' | ||
| git tag -a vX.X.X -m "Releasing version vX.X.X" | ||
| git push origin vX.X.X | ||
| ``` | ||
|
|
||
| ### Step 1.7 Create a Release Notes | ||
|
|
||
| Navigate to DJL github site, select "Release" tab and click "Draft a new Release" button. | ||
| Select tag that created by previous step. Check "This is a pre-release" checkbox. | ||
|
|
||
| Release notes content should include the following: | ||
| - list of new features | ||
| - list of bug fixes | ||
| - limitations and known issues | ||
| - API changes and migration document | ||
|
|
||
| Once "Publish release" button is clicked, a github Action will be triggered, and release packages | ||
| will be published sonatype staging server. | ||
|
|
||
| ## Step 2: Validate release on staging server | ||
|
|
||
| Login to https://oss.sonatype.org/, and find out staging repo name. | ||
|
|
||
| Run the following command to point maven repository to staging server: | ||
| ```shell script | ||
| cd djl | ||
| git checkout vX.X.X | ||
| ./gradlew -PstagingRepo=aidjl-XXXX staging | ||
| ``` | ||
|
|
||
| ### Validate examples project are working fine | ||
|
|
||
| ```shell script | ||
| cd examples | ||
| ./gradlew run | ||
| mvn exec:java -Dexec.mainClass="ai.djl.examples.inference.ObjectDetection" | ||
| ``` | ||
|
|
||
| ### Validate jupyter notebooks | ||
|
|
||
| Make sure jupyter notebook and running properly and all javadoc links are accessible. | ||
| ```shell script | ||
| cd jupyter | ||
| jupyter notebook | ||
| ``` | ||
|
|
||
| ## Step 3: Validate javadoc url in documents | ||
|
|
||
| Navigate to DJL github site, select tag created by earlier step, open markdown files and | ||
| check javadoc links are accessible. | ||
|
|
||
| ## Step 4: Publish staging package to maven central | ||
|
|
||
| Login to https://oss.sonatype.org/, close staging packages and publish to maven central. | ||
|
|
||
| ## Step 5: Upgrade version for next release | ||
|
|
||
| ```shell script | ||
| cd djl | ||
| ./gradlew -PtargetVersion=X.X.X iBV | ||
| ``` | ||
|
|
||
| Create a PR to get reviewed and merge into github. | ||
|
|
||
| ## Step 5: Publish new snapshot to sonatype | ||
|
|
||
| Manually trigger a nightly build with the following command: | ||
| ```shell script | ||
| curl -XPOST -u "USERNAME:PERSONAL_TOKEN" -H "Accept: application/vnd.github.everest-preview+json" -H "Content-Type: application/json" https://api.github.com/repos/awslabs/djl/dispatches --data '{"event_type": "nightly-build"}' | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| task release { | ||
| doLast { | ||
| def collection = fileTree("jupyter").filter { it.name.endsWith(".ipynb") } | ||
| collection += files("examples/build.gradle", "examples/pom.xml") | ||
| collection.each { File file -> | ||
| file.text = file.text.replaceAll("-SNAPSHOT", "").replaceAll("%mavenRepo", "// %mavenRepo") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| task staging() { | ||
| doLast { | ||
| if (!project.hasProperty("stagingRepo")) { | ||
| throw new GradleException("stagingRepo property is required.") | ||
| } | ||
| def stagingRepo = project.property("stagingRepo") | ||
|
|
||
| def collection = fileTree("jupyter").filter { it.name.endsWith(".ipynb") } | ||
| collection += files("examples/build.gradle", "examples/pom.xml") | ||
| collection.each { File file -> | ||
| file.text = file.text.replaceAll("https://oss\\.sonatype\\.org/content/repositories/snapshots/", | ||
| "https://oss.sonatype.org/service/local/repositories/${stagingRepo}/content/") | ||
| .replaceAll("-SNAPSHOT", "") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| task increaseBuildVersion { | ||
| doLast { | ||
| if (!project.hasProperty("targetVersion")) { | ||
| throw new GradleException("targetVersion property is required.") | ||
| } | ||
| def targetVersion = project.property("targetVersion") | ||
|
|
||
| def collection = fileTree("jupyter").filter { it.name.endsWith(".ipynb") } | ||
| collection += files("examples/build.gradle", "examples/pom.xml") | ||
| collection.each { File file -> | ||
| file.text = file.text.replaceAll("${version}", "${targetVersion}-SNAPSHOT") | ||
| } | ||
|
|
||
| File file = new File("build.gradle") | ||
| def releaseVersion = version.replaceAll("-SNAPSHOT", "") | ||
| file.text = file.text.replaceAll("\"${releaseVersion}\"", "\"${targetVersion}\"") | ||
| } | ||
| } | ||
|
|
||
| task increaseFinalVersion { | ||
| doLast { | ||
| if (!project.hasProperty("previousVersion")) { | ||
| throw new GradleException("previousVersion property is required.") | ||
| } | ||
| def previousVersion = project.property("previousVersion") | ||
| def releaseVersion = version.replaceAll("-SNAPSHOT", "") | ||
|
|
||
| def collection = fileTree("jupyter").filter { it.name.endsWith(".ipynb") } | ||
| collection += fileTree(".").filter { | ||
| it.name.endsWith(".md") || it.name.endsWith("overview.html") || it.name.endsWith("javadoc-index.html") | ||
| } | ||
|
|
||
| collection.each { File file -> | ||
| file.text = file.text.replaceAll("/${previousVersion}/", "/${releaseVersion}/") | ||
| .replaceAll(">${previousVersion}<", ">${releaseVersion}<") | ||
| .replaceAll(":${previousVersion}", ":${releaseVersion}") | ||
| } | ||
| } | ||
| } | ||
|
|