CI: remove draftversion variables, prepare for release deprecation

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,7 +4,7 @@ about: Technical issues, document format problems, bugs in scripts or feature pr
 
 ---
 
-<!-- SPDX-FileCopyrightText: Copyright 2021-2022 Arm Limited and/or its affiliates <open-source-office@arm.com> -->
+<!-- SPDX-FileCopyrightText: Copyright 2021-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com> -->
 <!-- SPDX-License-Identifier: Apache-2.0 -->
 
 **Thank you for submitting a pull request!**
@@ -60,7 +60,5 @@ Checklist: (mark with ``X`` those which apply)
       correctness of the result in the PDF output (please refer to the
       instructions on [how to build the PDFs
       locally](https://github.com/ARM-software/acle/blob/main/CONTRIBUTING.md#continuous-integration)).
-* [ ] The variable `draftversion` is set to `true` in the YAML header
-      of the sources of the specifications I have modified.
 * [ ] Please *DO NOT* add my GitHub profile to the list of contributors
       in the [README](https://github.com/ARM-software/acle/blob/main/README.md#contributors-) page of the project.

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Copyright 2021 Arm Limited and/or its affiliates <open-source-office@arm.com>
+# SPDX-FileCopyrightText: Copyright 2021, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
 #
 # SPDX-License-Identifier: Apache-2.0
 name: CI
@@ -12,7 +12,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4.1.7
     - name: check the correctness of the sources and generate the PDFs
-      run: ./build_with_docker.sh
+      run: ./build_with_docker.sh --finalversion
     - uses: actions/upload-artifact@v4.4.0
       with:
         name: pdfs
@@ -32,13 +32,3 @@ jobs:
     - uses: gaurav-nelson/github-action-markdown-link-check@v1
       with:
           config-file: '.github/workflows/markdown-link-check.json'
-
-  draftversion-check:
-    runs-on: ubuntu-latest
-    if: github.base_ref == 'main' || github.ref == 'refs/heads/main'
-    steps:
-    - uses: actions/checkout@v4.1.7
-      with:
-        fetch-depth: 0
-    - name: Check correctness of draftversion fields
-      run:  python ./tools/acle_draftversion_value_check.py .

_includes/navbar.html

@@ -1,5 +1,5 @@
 <!-- SPDX-License-Identifier: Apache-2.0 -->
-<!-- SPDX-FileCopyrightText: Copyright 2021 Arm Limited and/or its affiliates <open-source-office@arm.com> -->
+<!-- SPDX-FileCopyrightText: Copyright 2021, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com> -->
 
 <nav id="header">
   <span id="left-side">
@@ -16,8 +16,20 @@
   </span>
   <img id="logo" src="{{site.baseurl}}/assets/images/Arm_logo_white_RGB.svg" alt="Logo">
   <span id="right-side">
-    {% if page.version %} Version: {{ page.version }} &nbsp;:::&nbsp; {% endif %}
-    {% if page.date-of-issue %} Release Date: {{ page.date-of-issue }} &nbsp;:::&nbsp; {% endif %}
+    {% assign hash = site.commithash | default: site.github.build_revision %}
+    {% if hash %}
+      {% assign short_hash = hash | slice: 0, 12 %}
+      {% if site.finalversion %}
+        Version: <a id="link_finalversion" href="https://github.com/ARM-software/acle/commit/{{ hash }}">{{ hash }}</a> &nbsp;:::&nbsp;
+      {% elsif site.cleanrepo %}
+        Version: <span class="dev_version">Dev version (<a id="link_devversion" href="https://github.com/ARM-software/acle/commit/{{ hash }}">{{ short_hash }}</a>)</span> &nbsp;:::&nbsp;
+      {% else %}
+        Version: <span class="dev_version">Dev version (<a id="link_devversion" href="https://github.com/ARM-software/acle/commit/{{ hash }}">{{ short_hash }}</a>), modified</span> &nbsp;:::&nbsp;
+      {% endif %}
+    {% elsif page.version %}
+      Version: {{ page.version }} &nbsp;:::&nbsp;
+    {% endif %}
+    {% if page.date-of-issue %} Issue Date: {{ page.date-of-issue }} &nbsp;:::&nbsp; {% endif %}
     <a href="https://github.com/ARM-software/acle/issues">
       <button class="navbar_button"> Report a Bug </button>
     </a>

_sass/main.scss

@@ -1,5 +1,5 @@
 /*
-SPDX-FileCopyrightText: Copyright 2021 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2021, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
 SPDX-License-Identifier: Apache-2.0
 The colors used for formatting have been added in accordance with corporate guidelines:
 https://www.arm.com/company/policies/trademarks/guidelines-corporate-logo
@@ -114,3 +114,17 @@ https://www.arm.com/company/policies/trademarks/guidelines-corporate-logo
 #index_logo {
   height: 160px;
 }
+
+#link_finalversion {
+  color: white;
+  text-decoration: underline;
+}
+
+.dev_version {
+  color: red;
+}
+
+#link_devversion {
+  color: red;
+  text-decoration: underline;
+}

build_with_docker.sh

@@ -3,10 +3,43 @@
 # SPDX-FileCopyrightText: Copyright 2021-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
 # SPDX-License-Identifier: Apache-2.0
 
+finalversion=""
+cleanrepo=""
+
+while [[ $# -gt 0 ]]; do
+	case "$1" in
+		--finalversion)
+			finalversion="--finalversion"
+			;;
+		*)
+			echo "Unknown option: $1" >&2
+			exit 1
+			;;
+	esac
+	shift
+done
+
+# Check if repo is in a clean state
+if [[ -z "$(git -C "$ROOTDIR" status --porcelain)" ]]; then
+	cleanrepo="--cleanrepo"
+fi
+
+# Get last commit
+commithash="--commithash $(git rev-parse HEAD)"
+
+echo "Building pdfs with parameters:"
+if [[ -n "$finalversion" ]]; then
+	echo "  --finalversion"
+fi
+if [[ -n "$cleanrepo" ]]; then
+	echo "  --cleanrepo"
+fi
+echo "  $commithash"
+
 set -x
 IMAGE_NAME=acle_build
 # Build the image.
 docker build -t $IMAGE_NAME tools/docker
 # Run the image, mounting the current folder into the /src folder of
 # the docker image. Run as the host user so that the output files are owned by them.
-docker run --rm -u $(id -u):$(id -g) --mount type=bind,source="$(pwd)",target=/src $IMAGE_NAME
+docker run --rm -u $(id -u):$(id -g) --mount type=bind,source="$(pwd)",target=/src $IMAGE_NAME $finalversion $commithash $cleanrepo

cmse/cmse.md

@@ -1,18 +1,16 @@
 ---
 title: Arm®v8-M Security Extensions <br /> Requirements on Development Tools
-version: 1.4
 date-of-issue: 21 June 2024
 set-quote-highlight: true
 # LaTeX specific variables
-copyright-text: Copyright 2019, 2021-2024 Arm Limited and/or its affiliates <open-source-office@arm.com>.
-draftversion: true
+copyright-text: Copyright 2019, 2021-2024, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
 # Jekyll specific variables
 header_counter: true
 toc: true
 ---
 
 <!--
-SPDX-FileCopyrightText: Copyright 2019, 2021-2024 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2019, 2021-2024, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
 CC-BY-SA-4.0 AND Apache-Patent-License
 See LICENSE.md file for details
 -->

main/acle.md

@@ -1,10 +1,8 @@
 ---
 title: Arm C Language Extensions
-version: 2026Q1
 date-of-issue: 15 May 2026
 # LaTeX specific variables
 copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}."
-draftversion: true
 # Jekyll specific variables
 header_counter: true
 toc: true

morello/morello.md

@@ -1,10 +1,8 @@
 ---
 title: Morello Supplement to the Arm C Language Extensions
-version: 02alpha
 date-of-issue: 11 January 2022
 # LaTeX specific variables
-copyright-text: Copyright 2020-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>.
-draftversion: true
+copyright-text: Copyright 2020-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
 # Jekyll specific variables
 header_counter: true
 toc: true

mve_intrinsics/mve.md

@@ -1,18 +1,16 @@
 ---
 title: Arm MVE Intrinsics
-version: 2021Q4
 date-of-issue: 11 January 2022
 # LaTeX specific variables
 landscape: true
-copyright-text: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>.
-draftversion: true
+copyright-text: Copyright 2019-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
 # Jekyll specific variables
 header_counter: true
 toc: true
 ---
 
 <!--
-SPDX-FileCopyrightText: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2019-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
 CC-BY-SA-4.0 AND Apache-Patent-License
 See LICENSE.md file for details
 -->

mve_intrinsics/mve.template.md

@@ -1,18 +1,16 @@
 ---
 title: Arm MVE Intrinsics
-version: 2021Q4
 date-of-issue: 11 January 2022
 # LaTeX specific variables
 landscape: true
-copyright-text: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>.
-draftversion: true
+copyright-text: Copyright 2019-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
 # Jekyll specific variables
 header_counter: true
 toc: true
 ---
 
 <!--
-SPDX-FileCopyrightText: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2019-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
 CC-BY-SA-4.0 AND Apache-Patent-License
 See LICENSE.md file for details
 -->

neon_intrinsics/advsimd.md

@@ -1,11 +1,9 @@
 ---
 title: Arm Neon Intrinsics Reference
-version: 2026Q1
 date-of-issue: 15 May 2026
 # LaTeX specific variables
 landscape: true
 copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}."
-draftversion: true
 # Jekyll specific variables
 header_counter: true
 toc: true

neon_intrinsics/advsimd.template.md

@@ -1,11 +1,9 @@
 ---
 title: Arm Neon Intrinsics Reference
-version: 2026Q1
 date-of-issue: 15 May 2026
 # LaTeX specific variables
 landscape: true
 copyright-text: "Copyright: see section \\texorpdfstring{{\\nameref{{copyright}}}}{{Copyright}}."
-draftversion: true
 # Jekyll specific variables
 header_counter: true
 toc: true

tools/acle_template.tex

@@ -1,5 +1,5 @@
 % Copyright (c) 2014--2021, John MacFarlane
-% SPDX-FileCopyrightText: Copyright 2021-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
+% SPDX-FileCopyrightText: Copyright 2021-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
 % SPDX-License-Identifier: BSD-3-Clause
 % Based on default.latex template released with Pandoc (www.pandoc.org).
 % See `data/templates` in `COPYRIGHT` at https://github.com/jgm/pandoc
@@ -38,10 +38,14 @@
 \makeatother
 
 \sectionfont{\color{armblue}}
-$if(draftversion)$
-\newcommand{\versiontext}{\textcolor{red}{Development version based on $version$}}
+$if(finalversion)$
+  \newcommand{\versiontext}{\href{https://github.com/ARM-software/acle/commit/$commithash$}{$commithash$}}
 $else$
-\newcommand{\versiontext}{$version$}
+  $if(cleanrepo)$
+    \newcommand{\versiontext}{\textcolor{red}{Development version based on \href{https://github.com/ARM-software/acle/commit/$commithash$}{$commithash$}}}
+  $else$
+    \newcommand{\versiontext}{\textcolor{red}{Development version based on \href{https://github.com/ARM-software/acle/commit/$commithash$}{$commithash$}, with modifications}}
+  $endif$
 $endif$
 \newcommand{\dateofissue}{$if(draftversion)$TBD$else$$date-of-issue$$endif$}
 
@@ -127,7 +131,7 @@
         \begin{minipage}[t]{14.0cm}
           \begin{flushleft}
             {\huge \bfseries  $title$}\\[2ex]
-            {\large Release Date: \dateofissue}\\[2ex]
+            {\large Issue Date: \dateofissue}\\[2ex]
             {\large \bfseries Version: \versiontext}\\[3ex]
           \end{flushleft}
         \end{minipage}