chore: add architecture in release process (#51)

* chore: add architecture in release process

* Code review

- Describe the purpose of `ARCH` in `release.py` and `nginx-version-info.example`

* more review: touch up arch-related documentation

* revert submodule change

---------

Co-authored-by: David Goffredo <[email protected]>

Author: dmehala

README.md

@@ -25,9 +25,11 @@ include the following:
 
 Each release contains one zipped tarball per supported image above. The
 naming convention is
-`<base image with underscores><hyphen>ngx_http_datadog_module.so.tgz`,
-e.g. `nginx_1.23.1-alpine-ngx_http_datadog_module.so.tgz` or
-`amazonlinux_2.0.20230119.1-ngx_http_datadog_module.so.tgz`.
+`<base image with underscores>-<arch>-ngx_http_datadog_module.so.tgz`,
+e.g. `nginx_1.23.1-alpine-amd64-ngx_http_datadog_module.so.tgz` or
+`amazonlinux_2.0.20230119.1-arm64-ngx_http_datadog_module.so.tgz`.
+
+Supported architectures (`<arch>`) are `amd64` and `arm64`.
 
 The zipped tarball contains a single file, `ngx_http_datadog_module.so`, which
 is the Datadog tracing nginx module.

bin/docker_build.sh

@@ -15,8 +15,10 @@ usage:
 
         Prompt the user for confirmation unless --yes is specified.
 
-        --platforms is a comma separated list of platforms to target. --platforms is required.
-        Example: --platforms linux/amd64,linux/arm64
+        --platforms is a comma separated list of platforms to target.
+        --platforms is required. The option has the same format as --platform
+        in `docker buildx build`.
+        For example: --platforms linux/amd64,linux/arm64
 
         If --push is specified, push the resulting image to DockerHub
         with a suitable tag.

bin/release.py

@@ -288,16 +288,22 @@ def prepare_release_artifact(build_job_number, work_dir):
     module_path = work_dir / 'ngx_http_datadog_module.so'
     download_file(module_url, module_path)
 
-    # `nginx_version_info` will define BASE_IMAGE. That's that value that we
-    # want to prefix the tarball name with, but with colons replaced by
-    # underscores.
+    # `nginx_version_info` serves to determine the values of BASE_IMAGE and ARCH.
+    # These values are instrumental in constructing the tarball name according to
+    # the specified convention: <BASE_IMAGE>-<ARCH>-ngx_http_datadog_module.so.tgz
     variables = parse_info_script(nginx_version_info)
     if 'BASE_IMAGE' not in variables:
         raise Exception(
             f"BASE_IMAGE not found in nginx-version-info: {nginx_version_info}"
         )
+    if 'ARCH' not in variables:
+        raise Exception(
+            f"ARCH not found in nginx-version-info: {nginx_version_info}"
+        )
+
+    arch = variables['ARCH']
     base_prefix = variables['BASE_IMAGE'].replace(':', '_')
-    tarball_path = work_dir / f'{base_prefix}-ngx_http_datadog_module.so.tgz'
+    tarball_path = work_dir / f'{base_prefix}-{arch}-ngx_http_datadog_module.so.tgz'
     command = [tar_exe, '-czf', tarball_path, '-C', work_dir, module_path.name]
     run(command, check=True)
 

nginx-version-info.example

@@ -34,11 +34,20 @@
 #
 #     NGINX_MODULES_PATH is not required for the "build" or "build-in-docker"
 #     make targets, but is required for the "test" and "lab" targets.
+#
+# ARCH
+#     The docker image architecture to use. The following values are supported:
+#
+#     - amd64
+#     - arm64
+#
+#     ARCH is not required by any of the make targets, but is used when
+#     preparing releases.
 
-ARCH=linux/amd64
 NGINX_VERSION=1.24.0
 BASE_IMAGE=nginx:1.24.0-alpine
 NGINX_MODULES_PATH=/usr/lib/nginx/modules
+ARCH=amd64
 
 # NGINX_VERSION=1.14.1
 # BASE_IMAGE=nginx:1.14.1