You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2026/07/16 12:28:23 UTC
(sling-org-apache-sling-servlets-post) branch maia/workflow-1784204918696 created (now 421e017)
This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a change to branch maia/workflow-1784204918696
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-post.git
at 421e017 docs: clarify test commands, protocol name, and repository layout
This branch includes the following new commits:
new 421e017 docs: clarify test commands, protocol name, and repository layout
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(sling-org-apache-sling-servlets-post) 01/01: docs: clarify test commands, protocol name, and repository layout
Posted by cz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch maia/workflow-1784204918696
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-post.git
commit 421e0177e9b4199509287a085dd8056f403cef87
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Thu Jul 16 14:28:38 2026 +0200
docs: clarify test commands, protocol name, and repository layout
Co-authored-by: Maia <ma...@noreply>
---
README.md | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 6287b80..512d5e4 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,8 @@ Java 17 is required.
- Full build: `mvn clean install`
- Build without tests: `mvn clean install -DskipTests`
-- Unit tests: `mvn test`
-- Integration tests (Failsafe, including `ModifyOperationIT`): `mvn verify`
+- Unit tests (Surefire, `*Test.java`): `mvn test`
+- Integration tests (Failsafe, `*IT.java`, currently including `ModifyOperationIT`): `mvn verify`
- Single unit test class: `mvn test -Dtest=HtmlResponseTest`
- Single integration test class: `mvn verify -Dit.test=ModifyOperationIT`
- Inspect generated bundle metadata and embedded resources:
@@ -53,15 +53,21 @@ For manual file-upload protocol checks against a running Sling instance on `loca
`sh developer-tests/testFileUploads.sh <testfile>`
-The script uploads using regular, streamed, and chunked streamed protocols, then downloads and compares content. See `developer-tests/README.md` and `Protocols.md` for protocol and script details.
+The script uploads using regular, streamed, and streaming chunked protocols, then downloads and compares content. See `developer-tests/README.md` and `Protocols.md` for protocol and script details.
## Repository layout
```text
+AGENTS.md Repository-specific agent/developer guidance
+CLAUDE.md Additional repository instructions
+CODE_OF_CONDUCT.md Community code of conduct
+CONTRIBUTING.md Contribution guidelines
+LICENSE Apache License 2.0 text
pom.xml Maven build descriptor (packaging: jar)
bnd.bnd OSGi bundle instructions and embedded resources
Jenkinsfile ASF Jenkins pipeline definition
Protocols.md Protocol notes for POST and upload behavior
+README.md Project overview, build, and usage notes
src/
main/java/org/apache/sling/servlets/post/
*.java Public Jakarta-first API/SPI (+ legacy compatibility APIs)
@@ -85,6 +91,7 @@ developer-tests/ Manual developer test scripts
- OSGi metadata is generated with bnd (`bnd-maven-plugin`), with API baseline checks via `bnd-baseline-maven-plugin`.
- The build shades and relocates selected classes from `jackrabbit-jcr-commons` and `sling-jcr-contentparser` into internal `impl` packages.
- JCR (`javax.jcr.*`) and `org.apache.sling.jcr.contentloader` imports are configured as dynamic for runtime flexibility.
+- Integration tests run with Sling Mock Oak and include explicit classpath adjustments for Jackrabbit/Oak compatibility.
- The bundle uses `jakarta.servlet-api` as the primary servlet API while keeping `javax.servlet-api` and `org.apache.felix.http.wrappers` for compatibility adapters.
- JSON support is split between Jakarta JSON APIs for Jakarta responses and legacy JSON support for backwards-compatible APIs.
- The project security posture follows the Apache Sling threat model: https://github.com/apache/sling/blob/master/docs/threat-model.md .