Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 3.96 KB

RELEASE.md

File metadata and controls

115 lines (76 loc) · 3.96 KB

Releasing the project

Make version

1. Update CHANGELOG.md file
2. Set release version in 'build.gradle.kts'
  • remove "-alphaN" qualifier for the 'version' property.
3. Build and release JVM artifacts to Maven Central

a) Upload to the Nexus staging repository:

  • ./gradlew :clean
  • ./gradlew :plot-api:publishAllPublicationsToMavenRepository
  • ./gradlew publishLetsPlotKotlinGeoToolsPublicationToMavenRepository

Check artifacts are uploaded to the Nexus staging repository:

https://oss.sonatype.org/index.html#stagingRepositories

In the "Content" tab enter ‘Path lookup’: org/jetbrains/lets-plot

Note: check SNAPSHOT artifacts at:

https://oss.sonatype.org/index.html#view-repositories;snapshots~browsestorage

b) Publish all artifacts to the Nexus "Releases" repository (from the staging):

  • ./gradlew closeAndReleaseRepository

Check artifacts lets-plot-kotlin-[jvm, js, kernel, metadata, geotools] are uploaded to the Nexus Releases repository:

https://oss.sonatype.org/index.html#view-repositories;releases~browsestorage

In the "Browse Storage" tab enter ‘Path lookup’: org/jetbrains/lets-plot

Note: PGP signature is required for publishing.

See:

Note: Individually Lets-Plot Kotlin API artifacts can be published with commands:

  • "Kotlin kernel":

  • ./gradlew publishLetsPlotKotlinKernelPublicationToMavenRepository

  • Multi-platform:

  • ./gradlew :plot-api:publishKotlinMultiplatformPublicationToMavenRepository

  • ./gradlew :plot-api:publishJvmPublicationToMavenRepository

  • ./gradlew :plot-api:publishJsPublicationToMavenRepository

  • ./gradlew :plot-api:publishMetadataPublicationToMavenRepository

4. Prepare to the next dev cycle
  • increment the version and add "-alpha1" qualifier (The 'version' property in the root 'build.gradle.kts')
  • push the new dev version to GitHub.
5. Re-generate the API Reference (HTML)
  • ./gradlew dokkaHtml
  • Move the content of docs/api-reference/ to the docs/kotlin/ directory of the lets-plot-docs repository.

See also: api_reference.md

Update Lets-Plot library descriptor in Jupyter Kotlin Kernel

Note: the new descriptor will become the default only with the next release of the Kotlin Kernel. Until then, the %useLatestDescriptors line magic must be included in notebooks.

Release demo notebooks

1. Edit binder/environment.yml file.

This is optional - needed only if newer version of 'kotlin-jupyter-kernel' is required.

2. Update demo notebooks
  • move from 'docs/examples/jupyter-notebooks-dev' to 'docs/examples/jupyter-notebooks'.
  • Make sure the %useLatestDescriptors line magic is present.
  • Remove parameters in the %use lets-plot line magic.
  • Re-run all notebooks.
3. Push the updated demo notebooks and add "demo-tag":
git add --all && git commit -m "Updated demo notebooks, add v1.2.3demos1 repo tag" && git push

git tag v1.2.3demos1 && git push --tags

In docs/README.md update the Binder link with new "demo" tag (above).

Add the GitHub release: