You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2022/06/21 22:12:51 UTC

[commons-crypto] branch sebb-docker updated: Document build process

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

sebb pushed a commit to branch sebb-docker
in repository https://gitbox.apache.org/repos/asf/commons-crypto.git


The following commit(s) were added to refs/heads/sebb-docker by this push:
     new d77e054  Document build process
d77e054 is described below

commit d77e05420234a5452ed901924a1c169b8113cc70
Author: Sebb <se...@apache.org>
AuthorDate: Tue Jun 21 23:12:45 2022 +0100

    Document build process
---
 src/docker/README.md | 33 ++++++++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

diff --git a/src/docker/README.md b/src/docker/README.md
index be38962..176fb97 100644
--- a/src/docker/README.md
+++ b/src/docker/README.md
@@ -31,14 +31,14 @@ target/classes/org/apache/commons/crypto/native before creating the release.
 For example, the macOS object can be added as
 target/classes/org/apache/commons/crypto/native/Mac/x86_64/libcommons-crypto.jnilib
 
-# Building with Docker
+# Building the Docker image
 
 ```
   cd src/docker
   docker compose build crypto
 ```
 
-# Running with Docker
+# Running the Docker image
 
 ```
   cd src/docker
@@ -47,4 +47,31 @@ target/classes/org/apache/commons/crypto/native/Mac/x86_64/libcommons-crypto.jni
   docker compose run --entrypoint src/docker/build.sh crypto # run full build
   docker compose run --entrypoint src/docker/build_linux32.sh crypto # optionally run linux32 build
   # N.B. the linux32 build needs an additional install, but that causes linux 64 bit builds to fail.
-```
\ No newline at end of file
+```
+
+# Creating a release candidate using macOS
+
+This is the easiest if the release manager has access to a macOS host.
+
+The steps are:
+
+- mvn clean
+- cd src/docker
+- docker compose run --entrypoint src/docker/build.sh crypto
+- docker compose run --entrypoint src/docker/build_linux32.sh crypto # optional
+- cd ../..
+
+Now perform the release (don't run mvn clean!)
+- mvn release ...
+
+# Creating a release candidate using another OS
+
+If the Release Manager (RM) does not have access to a macOS system, they will need to obtain a copy
+of the macOS native binary from another Commons developer. 
+
+The process starts as above, but just before using the host system to build the release,
+add the macOS binary to the workspace at:
+
+```target/classes/org/apache/commons/crypto/native/Mac/x86_64/libcommons-crypto.jnilib```
+
+The release can then be created in the normal way.