diff --git a/README.md b/README.md index 0e710d8e..3fb34005 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,21 @@ OCI Registry as Storage enables libraries to push OCI Artifacts to [OCI Conforma ## Consuming SDK -SNAPSHOT version are published on GitHub Maven package. +SNAPSHOT version are published on GitHub Maven packages. +Releases are published on Maven Central Javadoc is published from main branch into: https://oras-project.github.io/oras-java/ +```xml + + land.oras + oras-java-sdk + VERSION_HERE + +``` + +### Only for SNAPSHOTS (only for testing) + GitHub requires authentication to download packages. You can use a personal access token to authenticate with GitHub Packages. To authenticate with GitHub Packages, you need to update your `~/.m2/settings.xml` file to include your personal access token. ```xml @@ -79,19 +90,13 @@ Registry registry = Registry.Builder.builder().insecure().build(); registry.pullArtifact(ContainerRef.parse("localhost:5000/hello:v1"), Path.of("folder")); ``` -### Deploy to GitHub Packages +### Deploy SNAPSHOTS -This is temporary until published to Maven Central with a proper workflow. - -The maven resolver must be switched to `wagon` to deploy to GitHub Packages. - -```shell -mvn -Dmaven.resolver.transport=wagon -DskipTests -Poras-java clean deploy -``` +SNAPSHOTS are automatically deployed when the `main` branch is updated. See the [GitHub Actions](.github/workflows/deploy-snapshots.yml) for more details. ### Perform release -- Ensure the draft release version correspond to the version on the `pom.xml` +- Ensure the draft release version correspond to the version on the `pom.xml`. Specially if changing the major or minor version. Patch releases are automatically updated. - Run the release workflow ## Code of Conduct diff --git a/pom.xml b/pom.xml index 244a1007..e8169d2a 100644 --- a/pom.xml +++ b/pom.xml @@ -2,9 +2,9 @@ 4.0.0 - land.oras.java + land.oras oras-java-sdk - 0.1.10-SNAPSHOT + 0.2.0-SNAPSHOT jar ${project.groupId}:${project.artifactId} ORAS Java SDK @@ -538,12 +538,10 @@ org.apache.maven.plugins maven-gpg-plugin - org.apache.maven.plugins maven-release-plugin