(jackrabbit-site) branch main updated: Document automated build & deployment with ASF Jenkins

[kw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/jackrabbit-site.git


The following commit(s) were added to refs/heads/main by this push:
     new 69520d9d Document automated build & deployment with ASF Jenkins
69520d9d is described below

commit 69520d9dbc0272836aad7b7b4584c48f0125f0e5
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri Feb 2 19:18:35 2024 +0100

    Document automated build & deployment with ASF Jenkins
    
    Add badges
    Introduce serverId for retrieving the credentials for manual deployment
---
 README.md | 29 ++++++++++++++++++++++++-----
 pom.xml   |  2 +-
 2 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 71e5d6eb..af79a77a 100644
--- a/README.md
+++ b/README.md
@@ -17,12 +17,19 @@
 
 Jackrabbit Site Generation
 ==========================
+
+[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license]
+[![Jenkins Status](https://img.shields.io/jenkins/s/https/ci-builds.apache.org/job/Jackrabbit/job/jackrabbit-site/job/main.svg)][build]
+
+This is the Git repository for the content of <https://jackrabbit.apache.org/jcr/>. 
+Further information in [Website](src/site/markdown/website.md).
+
 The Jackrabbit site lives as Markdown files in `src/site/markdown` such
 that it easy to view e.g. from GitHub. This project only generates the
 content below `https://svn.apache.org/repos/asf/jackrabbit/site/live/jcr`, otherwise
 the scm-publish mechanism is too slow, checking out the entire site.
 
-The Maven site plugin can be used to build and deploy a web site as follows:
+The Maven site plugin can be used to build a web site as follows:
 
 1. In this project build the site with:
 
@@ -32,13 +39,21 @@ The Maven site plugin can be used to build and deploy a web site as follows:
 
 2. Review the site at `target/site/index.html`
 
-3. Deploy the site to `http://jackrabbit.apache.org/jcr` using:
+3. Commit and push your changes
+
+### Automatic Deployment
+
+The `main` branch is automatically built on the [ASF Jenkins][build] after every commit and the results are automatically committed to <https://svn.apache.org/repos/asf/jackrabbit/site/live/jcr> from where the Website is being populated.
+
+### Manual Deployment
+
+1. Deploy the site to `http://jackrabbit.apache.org/jcr` using:
 
    ````
    $ mvn site-deploy
    ````
 
-4. Finally review the site at `http://jackrabbit.apache.org/`.
+2. Finally review the site at `http://jackrabbit.apache.org/`.
 
 Note: To skip the final commit use `-Dscmpublish.skipCheckin=true`. You can then
 review all pending changes in `target/scmpublish-checkout` and follow
@@ -46,7 +61,11 @@ up with `svn commit` manually.
 
 
 Note: Every committer should be able to deploy the site. Deployment is done via svn commit to
-`https://svn.apache.org/repos/asf/jackrabbit/site/live/jcr`. It may be necessary though to provide the credentials explicitly via `-Dpassword` and `-Dusername` ([maven-scm-publish-plugin:publish-scm](https://maven.apache.org/plugins/maven-scm-publish-plugin/publish-scm-mojo.html)).
+`https://svn.apache.org/repos/asf/jackrabbit/site/live/jcr`. 
+The credentials are retrieved from a server with `id` *apache.releases.https* from the [Maven Settings](https://maven.apache.org/settings.html). Alternatively
+one can provide the credentials explicitly via `-Dpassword` and `-Dusername` ([maven-scm-publish-plugin:publish-scm](https://maven.apache.org/plugins/maven-scm-publish-plugin/publish-scm-mojo.html)).
 
-Further information in [Website](src/site/markdown/website.md).
 
+[jira]: https://issues.apache.org/jira/projects/JCRSITE/
+[license]: https://www.apache.org/licenses/LICENSE-2.0
+[build]: https://ci-builds.apache.org/job/Jackrabbit/job/jackrabbit-site/job/main/
diff --git a/pom.xml b/pom.xml
index 1fea8096..1d222876 100644
--- a/pom.xml
+++ b/pom.xml
@@ -89,6 +89,7 @@
                     </execution>
                 </executions>
                 <configuration>
+                    <serverId>apache.releases.https</serverId>
                     <content>target/site</content>
                     <checkinComment>@trivial: Site checkin for project ${project.name}-${project.version}
                     </checkinComment>
@@ -156,7 +157,6 @@
 
     <distributionManagement>
         <site>
-            <id>apache.website</id>
             <url>scm:svn:https://svn.apache.org/repos/asf/jackrabbit/site/live/jcr</url>
         </site>
     </distributionManagement>