Merge remote-tracking branch 'origin/main'

vaidikcode · vaidikcode · commit ff1a75b4e5be · 2025-02-05T02:23:43.000+05:30
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1,53 @@
+# Configuration for Release Drafter: https://github.com/toolmantim/release-drafter
+---
+
+# Always use 3 digits for the version number
+name-template: $NEXT_PATCH_VERSION
+tag-template: $NEXT_PATCH_VERSION
+version-template: $MAJOR.$MINOR.$PATCH
+
+categories:
+  - title: 💥 Breaking changes
+    labels:
+      - breaking
+  - title: ⚠️ Deprecated
+    labels:
+      - deprecated
+  - title: 🚀 New features and improvements
+    labels:
+      - enhancement
+      - feature
+  - title: 🐛 Bug fixes
+    labels:
+      - bug
+      - fix
+      - bugfix
+      - regression
+      - regression-fix
+  - title: 📝 Documentation updates
+    labels:
+      - documentation
+  - title: 👻 Maintenance
+    labels:
+      - chore
+      - internal
+      - maintenance
+  - title: 🚦 Tests
+    labels:
+      - test
+      - tests
+  - title: ✍ Other changes
+  # Default label used by Dependabot
+  - title: 📦 Dependency updates
+    labels:
+      - dependencies
+    collapse-after: 15
+exclude-labels:
+  - reverted
+  - no-changelog
+  - skip-changelog
+  - invalid
+
+template: |
+  <!-- Optional: add a release summary here -->
+  $CHANGES
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -20,5 +20,5 @@ jobs:
           maven-version: 3.9.9
           cache-enabled: true
 
-      - name: Maven deploy
+      - name: Maven build
         run: mvn --batch-mode --update-snapshots verify
diff --git a/.github/workflows/deploy-javadoc.yml b/.github/workflows/deploy-javadoc.yml
@@ -0,0 +1,39 @@
+name: Deploy Javadoc
+
+on:
+  workflow_call:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  deploy-javadoc:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      - name: Setup Maven Action
+        uses: s4u/setup-maven-action@v1.18.0
+        with:
+          java-distribution: 'temurin'
+          java-version: 17
+          maven-version: 3.9.9
+          cache-enabled: true
+
+      - name: Build javadoc
+        run: mvn javadoc:javadoc
+
+      - name: Upload javadoc
+        id: upload-javadoc
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/reports/apidocs/
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -0,0 +1,20 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  workflow_call:
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  deploy-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Setup Maven Action
+        uses: s4u/setup-maven-action@v1.18.0
+        with:
+          java-distribution: 'temurin'
+          java-version: 17
+          maven-version: 3.9.9
+          cache-enabled: true
+
+      - name: Maven release
+        run: mvn --batch-mode --update-snapshots -DtagNameFormat=@{project.version} -Dmaven.resolver.transport=wagon -DskipTests release:prepare release:perform
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Close draft release
+        run: |
+          release=$(gh api /repos/$GITHUB_REPOSITORY/releases | jq -e -r '[ .[] | select(.draft == true).id] | max')
+          gh api -X PATCH -F draft=false -F name=$version -F tag_name=$version /repos/$GITHUB_REPOSITORY/releases/$release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.mvn/maven.config b/.mvn/maven.config
@@ -1 +1 @@
--Drevision=0.0.1-SNAPSHOT
+-Drevision=0.1.0-SNAPSHOT
diff --git a/README.md b/README.md
@@ -9,6 +9,36 @@
 
 OCI Registry as Storage enables libraries to push OCI Artifacts to [OCI Conformant](https://github.com/opencontainers/oci-conformance) registries. This is a Java SDK for Java developers to empower them to do this in their applications.
 
+## Consuming SDK
+
+SNAPSHOT version are published on GitHub Maven package.
+
+Javadoc is published from main branch into: https://oras-project.github.io/oras-java/
+
+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
+<server>
+    <id>oras-java</id>
+    <username>YOUR_USERNAME</username>
+    <password>YOUR_ACCESS_TOKEN_WITH_PACKAGE_READ_SCOPE</password>
+</server>
+```
+
+Then on your `pom.xml`
+
+```xml
+<repositories>
+    <repository>
+        <id>oras-java</id>
+        <url>https://maven.pkg.github.com/oras-project/oras-java</url>
+        <snapshots>
+            <enabled>true</enabled>
+        </snapshots>
+    </repository>
+</repositories>
+```
+
 ## Examples
 
 ### Push an Artifact
diff --git a/pom.xml b/pom.xml
@@ -25,20 +25,18 @@
     <spotless.check.skip>false</spotless.check.skip>
     <enforcer.skip>false</enforcer.skip>
 
-    <maven.compiler.release>17</maven.compiler.release>
-
     <!-- Version -->
     <slf4j.version>2.0.16</slf4j.version>
     <docker-java.version>3.4.1</docker-java.version>
     <jspecify.version>1.0.0</jspecify.version>
-    <gson.version>2.11.0</gson.version>
+    <gson.version>2.12.1</gson.version>
     <apache.common-compress.version>1.27.1</apache.common-compress.version>
 
     <!-- Test dependencies version -->
     <logback.version>1.5.16</logback.version>
     <junit.version>5.11.4</junit.version>
     <testcontainer.version>1.20.4</testcontainer.version>
-    <wiremock.version>3.10.0</wiremock.version>
+    <wiremock.version>3.11.0</wiremock.version>
     <mockito.version>5.15.2</mockito.version>
     <system.stubs.version>2.1.7</system.stubs.version>
 
@@ -48,6 +46,11 @@
     <maven-enforcer-plugin.version>3.5.0</maven-enforcer-plugin.version>
     <maven-javadoc-plugin.version>3.11.2</maven-javadoc-plugin.version>
 
+    <!-- Target Java 17 -->
+    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.target>17</maven.compiler.target>
+    <maven.compiler.release>17</maven.compiler.release>
+
   </properties>
 
   <dependencyManagement>
@@ -200,6 +203,7 @@
               <phase>verify</phase>
               <configuration>
                 <show>public</show>
+                <failOnWarnings>true</failOnWarnings>
               </configuration>
             </execution>
           </executions>
diff --git a/src/main/java/land/oras/Annotations.java b/src/main/java/land/oras/Annotations.java
@@ -22,6 +22,7 @@ public record Annotations(
     /**
      * Create a new annotations record with only manifest annotations
      * @param manifestAnnotations The manifest annotations
+     * @return The annotations
      */
     public static Annotations ofManifest(Map<String, String> manifestAnnotations) {
         return new Annotations(new HashMap<>(), manifestAnnotations, new HashMap<>());
diff --git a/src/main/java/land/oras/Registry.java b/src/main/java/land/oras/Registry.java
@@ -573,6 +573,7 @@ private boolean switchTokenAuth(OrasHttpClient.ResponseWrapper<String> response)
     private void handleError(OrasHttpClient.ResponseWrapper<?> responseWrapper) {
         if (responseWrapper.statusCode() >= 400) {
             if (responseWrapper.response() instanceof String) {
+                LOG.debug("Response: {}", responseWrapper.response());
                 throw new OrasException((OrasHttpClient.ResponseWrapper<String>) responseWrapper);
             }
             throw new OrasException(new OrasHttpClient.ResponseWrapper<>("", responseWrapper.statusCode(), Map.of()));
diff --git a/src/test/java/land/oras/AnnotationsTest.java b/src/test/java/land/oras/AnnotationsTest.java
@@ -4,7 +4,10 @@
 
 import java.util.Map;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
+import org.junit.jupiter.api.parallel.ExecutionMode;
 
+@Execution(ExecutionMode.CONCURRENT)
 public class AnnotationsTest {
 
     @Test
diff --git a/src/test/java/land/oras/ContainerRefTest.java b/src/test/java/land/oras/ContainerRefTest.java
@@ -4,7 +4,10 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
+import org.junit.jupiter.api.parallel.ExecutionMode;
 
+@Execution(ExecutionMode.CONCURRENT)
 public class ContainerRefTest {
 
     @Test
diff --git a/src/test/java/land/oras/LayerTest.java b/src/test/java/land/oras/LayerTest.java
@@ -3,7 +3,10 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
+import org.junit.jupiter.api.parallel.ExecutionMode;
 
+@Execution(ExecutionMode.CONCURRENT)
 public class LayerTest {
 
     @Test
diff --git a/src/test/java/land/oras/ManifestTest.java b/src/test/java/land/oras/ManifestTest.java
@@ -3,11 +3,12 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
+import org.junit.jupiter.api.parallel.ExecutionMode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.testcontainers.junit.jupiter.Testcontainers;
 
-@Testcontainers
+@Execution(ExecutionMode.CONCURRENT)
 public class ManifestTest {
 
     /**
diff --git a/src/test/java/land/oras/RegistryContainerTest.java b/src/test/java/land/oras/RegistryContainerTest.java
diff --git a/src/test/java/land/oras/RegistryTest.java b/src/test/java/land/oras/RegistryTest.java
diff --git a/src/test/java/land/oras/RegistryWireMockTest.java b/src/test/java/land/oras/RegistryWireMockTest.java
diff --git a/src/test/java/land/oras/auth/BearerTokenProviderTest.java b/src/test/java/land/oras/auth/BearerTokenProviderTest.java
diff --git a/src/test/java/land/oras/auth/EnvironmentPasswordProviderTest.java b/src/test/java/land/oras/auth/EnvironmentPasswordProviderTest.java
diff --git a/src/test/java/land/oras/utils/DigestUtilsTest.java b/src/test/java/land/oras/utils/DigestUtilsTest.java
diff --git a/src/test/resources/junit-platform.properties b/src/test/resources/junit-platform.properties

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`--Drevision=0.0.1-SNAPSHOT`
	`1`	`+-Drevision=0.1.0-SNAPSHOT`
Original file line number	Diff line number	Diff line change
`@@ -573,6 +573,7 @@ private boolean switchTokenAuth(OrasHttpClient.ResponseWrapper<String> response)`
`573`	`573`	`private void handleError(OrasHttpClient.ResponseWrapper<?> responseWrapper) {`
`574`	`574`	`if (responseWrapper.statusCode() >= 400) {`
`575`	`575`	`if (responseWrapper.response() instanceof String) {`
	`576`	`+ LOG.debug("Response: {}", responseWrapper.response());`
`576`	`577`	`throw new OrasException((OrasHttpClient.ResponseWrapper<String>) responseWrapper);`
`577`	`578`	`}`
`578`	`579`	`throw new OrasException(new OrasHttpClient.ResponseWrapper<>("", responseWrapper.statusCode(), Map.of()));`