You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@teaclave.apache.org by yu...@apache.org on 2026/02/03 03:34:18 UTC
(teaclave-trustzone-sdk) branch main updated (06069b2 -> f08d177)
This is an automated email from the ASF dual-hosted git repository.
yuanz pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/teaclave-trustzone-sdk.git
from 06069b2 Bump OP-TEE version and optee-* versions (#270)
new 74af801 docs/release-tips: fmt
new f08d177 release: add helper script for publishing crates
The 2 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.
Summary of changes:
docs/release-tips.md | 75 ++++++++++++++++++++++++++-----------
scripts/release/publish_crates.sh | 78 +++++++++++++++++++++++++++++++++++++++
2 files changed, 132 insertions(+), 21 deletions(-)
create mode 100755 scripts/release/publish_crates.sh
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@teaclave.apache.org
For additional commands, e-mail: commits-help@teaclave.apache.org
(teaclave-trustzone-sdk) 02/02: release: add helper script for publishing crates
Posted by yu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
yuanz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/teaclave-trustzone-sdk.git
commit f08d177b7458eb6d18c8b9dfd0fb0c88b68273c9
Author: Yuan Zhuang <yu...@apache.org>
AuthorDate: Fri Jan 30 07:12:13 2026 +0000
release: add helper script for publishing crates
---
docs/release-tips.md | 17 +++++++++
scripts/release/publish_crates.sh | 78 +++++++++++++++++++++++++++++++++++++++
2 files changed, 95 insertions(+)
diff --git a/docs/release-tips.md b/docs/release-tips.md
index ea323dd..d11b369 100644
--- a/docs/release-tips.md
+++ b/docs/release-tips.md
@@ -60,6 +60,23 @@ cargo publish --dry-run # check if ready, will not upload
cargo publish # check and upload
```
+We have a script to simplify this process:
+[publish_crates.sh](https://github.com/apache/teaclave-trustzone-sdk/blob/main/scripts/release/publish_crates.sh).
+
+To use the script with the Docker environment:
+
+```bash
+# Run the Docker container (use the same image from the vote email)
+docker run -it --rm \
+ -v $(pwd):/root/teaclave_sdk_src \
+ -w /root/teaclave_sdk_src \
+ teaclave/teaclave-trustzone-emulator-nostd-expand-memory:OPTEE-VERSION
+
+# Inside the Docker container:
+cargo login
+./scripts/release/publish_crates.sh
+```
+
### GitHub Action for Drafting Release Notes
We use a GitHub Action to help categorize pull requests and generate a draft of
diff --git a/scripts/release/publish_crates.sh b/scripts/release/publish_crates.sh
new file mode 100755
index 0000000..7e82130
--- /dev/null
+++ b/scripts/release/publish_crates.sh
@@ -0,0 +1,78 @@
+#!/bin/bash
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+set -e
+
+SCRIPT_DIR=$(cd "$(dirname "$0")" && pwd)
+ROOT_DIR="$SCRIPT_DIR/../.."
+CRATES_DIR=(
+ "optee-utee/optee-utee-sys"
+ "optee-utee/macros"
+ "optee-utee-build"
+ "optee-utee"
+ "optee-teec/optee-teec-sys"
+ "optee-teec/macros"
+ "optee-teec"
+)
+
+cd "$ROOT_DIR"
+echo "Working directory set to: $(pwd)"
+
+echo "=== Phase 1: Verify All Packages (Local Build Check) ==="
+for DIR in "${CRATES_DIR[@]}"; do
+ echo "[$DIR] Validating package..."
+ if [ ! -d "$DIR" ]; then
+ echo "Error: Directory $DIR not found!"
+ exit 1
+ fi
+ (cd "$DIR" && cargo build)
+done
+
+echo -e "\nAll packages passed Phase 1 (local verification)."
+echo "Entering Phase 2: Sequential Dry-run and Interactive Publish."
+
+for DIR in "${CRATES_DIR[@]}"; do
+ echo "------------------------------------------------"
+ echo "Processing crate: $DIR"
+
+ pushd "$DIR" > /dev/null
+
+ echo "[$DIR] Step 1: Running cargo publish --dry-run..."
+ cargo publish --dry-run
+
+ echo -e "\n[$DIR] Dry-run successful."
+ read -p "Do you want to formally PUBLISH [$DIR] to crates.io? (y/n) " -n 1 -r
+ echo
+ if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+ echo "Publishing aborted by user at [$DIR]. Exiting."
+ popd > /dev/null
+ exit 1
+ fi
+
+ echo "[$DIR] Step 2: Publishing..."
+ cargo publish
+
+ popd > /dev/null
+
+ echo "[$DIR] Done. Waiting 30s for crates.io index sync..."
+ sleep 30
+done
+
+echo "------------------------------------------------"
+echo "All crates have been published successfully!"
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@teaclave.apache.org
For additional commands, e-mail: commits-help@teaclave.apache.org
(teaclave-trustzone-sdk) 01/02: docs/release-tips: fmt
Posted by yu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
yuanz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/teaclave-trustzone-sdk.git
commit 74af8019ff8a9d1274dd853edcff0ea3e52f5c0e
Author: Yuan Zhuang <yu...@apache.org>
AuthorDate: Fri Jan 30 06:59:43 2026 +0000
docs/release-tips: fmt
---
docs/release-tips.md | 58 +++++++++++++++++++++++++++++++++-------------------
1 file changed, 37 insertions(+), 21 deletions(-)
diff --git a/docs/release-tips.md b/docs/release-tips.md
index de3ad58..ea323dd 100644
--- a/docs/release-tips.md
+++ b/docs/release-tips.md
@@ -4,27 +4,34 @@ permalink: /trustzone-sdk-docs/release-tips.md
# TrustZone SDK Release Tips
-For the complete workflow and operational details, please refer to the [Release Guide for the Teaclave Community](https://teaclave.apache.org/release-guide).
+For the complete workflow and operational details, please refer to the
+[Release Guide for the Teaclave Community](https://teaclave.apache.org/release-guide).
This documentation highlights items that are specific to the `TrustZone SDK`.
## Release Schedule & Stages
### Release Schedule
-Apache TrustZone SDK follows a quarterly release cycle, aligned with [OP-TEE releases](https://optee.readthedocs.io/en/latest/general/releases.html).
+Apache TrustZone SDK follows a quarterly release cycle, aligned with
+[OP-TEE releases](https://optee.readthedocs.io/en/latest/general/releases.html).
The upcoming release in 2026 is as follows:
-| Apache Teaclave SDK Release Version | optee-* Rust crate Release version | OP-TEE Version | OP-TEE Release Date | Teaclave SDK Pre-release on Github (approximately) | Teaclave SDK Finalized Release on Apache and `crates.io` (approximately) |
-|-------------------------------------|-------------------------------------|----------------|--------------------|----------------------------------------------------|--------------------------------------------------------------------------|
-| v0.8.0 | v0.8.0 | OP-TEE 4.9.0 | 16/Jan/26 | 30/Jan/26 | 13/Feb/26 |
-| v0.9.0 | v0.9.0 | OP-TEE 4.10.0 | 17/Apr/26 | 1/May/26 | 15/May/26 |
-| v0.10.0 | v0.10.0 | OP-TEE 4.11.0 | 17/Jul/26 | 31/Jul/26 | 14/Aug/26 |
-| v0.11.0 | v0.11.0 | OP-TEE 4.12.0 | 16/Oct/26 | 30/Oct/26 | 13/Nov/26 |
+| Apache Teaclave SDK Release Version | optee-\* Rust crate Release version | OP-TEE Version | OP-TEE Release Date | Teaclave SDK Pre-release on Github (approximately) | Teaclave SDK Finalized Release on Apache and `crates.io` (approximately) |
+| ----------------------------------- | ----------------------------------- | -------------- | ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------ |
+| v0.8.0 | v0.8.0 | OP-TEE 4.9.0 | 16/Jan/26 | 30/Jan/26 | 13/Feb/26 |
+| v0.9.0 | v0.9.0 | OP-TEE 4.10.0 | 17/Apr/26 | 1/May/26 | 15/May/26 |
+| v0.10.0 | v0.10.0 | OP-TEE 4.11.0 | 17/Jul/26 | 31/Jul/26 | 14/Aug/26 |
+| v0.11.0 | v0.11.0 | OP-TEE 4.12.0 | 16/Oct/26 | 30/Oct/26 | 13/Nov/26 |
-**Note:** The table outlines the planned release schedule under normal circumstances. However, if there are no updates to the optee-* crates in the SDK during a given quarter, the release will be skipped and deferred to the following quarter.
+**Note:** The table outlines the planned release schedule under normal
+circumstances. However, if there are no updates to the optee-\* crates in the
+SDK during a given quarter, the release will be skipped and deferred to the
+following quarter.
-According to the Release Documentation in [Teaclave community](https://teaclave.apache.org/release-guide), the approximate timeline for v0.6.0:
+According to the Release Documentation in
+[Teaclave community](https://teaclave.apache.org/release-guide), the approximate
+timeline for v0.6.0:
- **July 11** – OP-TEE 4.7.0 released
- **July 12–18** – Prepare the release
@@ -34,14 +41,15 @@ According to the Release Documentation in [Teaclave community](https://teaclave.
The timeline is flexible and can be adjusted based on the actual circumstances.
-
## Specific for TrustZone SDK
### Publish on `crates.io`
-We maintain the optee-* Rust crates at <https://crates.io/search?q=optee>, which are released in sync with Apache releases.
+We maintain the optee-\* Rust crates at <https://crates.io/search?q=optee>,
+which are released in sync with Apache releases.
-If the release manager needs permission to publish these crates, please contact @DemesneGH for access.
+If the release manager needs permission to publish these crates, please contact
+@DemesneGH for access.
After the Apache release is finalized, we need to publish the crates:
@@ -54,7 +62,10 @@ cargo publish # check and upload
### GitHub Action for Drafting Release Notes
-We use a GitHub Action to help categorize pull requests and generate a draft of the release notes. This makes the notes more readable and organized. The typical workflow is to first trigger the action, then manually edit the resulting draft as needed.
+We use a GitHub Action to help categorize pull requests and generate a draft of
+the release notes. This makes the notes more readable and organized. The typical
+workflow is to first trigger the action, then manually edit the resulting draft
+as needed.
Manually trigger the Github Action workflow to draft the release notes:
@@ -69,12 +80,19 @@ After the workflow completes, a draft release will appear at:
The workflow categorizes the PRs according to their labels.
Tips for improving the draft release notes:
-- Add a brief summary at the top to highlight the major changes. You can write it manually or generate it using AI.
-- Include sections such as “New Contributors” and “Changelog”. Note: Our custom GitHub Action does not generate these sections by default. To get these missing parts, you can click the "Generate Release Notes" button on the release editing page and copy the generated content into the draft.
-
-Please note that once a release is published (including pre-releases), its release notes can no longer be updated via GitHub Actions (manual edits are possible). If you need to update the release notes through Actions (e.g., to revise the release to rc.2 to include the new commits), you must first delete the existing release (e.g. tagged rc.1), then re-trigger the workflow.
+- Add a brief summary at the top to highlight the major changes. You can write
+ it manually or generate it using AI.
+- Include sections such as “New Contributors” and “Changelog”. Note: Our custom
+ GitHub Action does not generate these sections by default. To get these
+ missing parts, you can click the "Generate Release Notes" button on the
+ release editing page and copy the generated content into the draft.
+Please note that once a release is published (including pre-releases), its
+release notes can no longer be updated via GitHub Actions (manual edits are
+possible). If you need to update the release notes through Actions (e.g., to
+revise the release to rc.2 to include the new commits), you must first delete
+the existing release (e.g. tagged rc.1), then re-trigger the workflow.
### Email template for voting
@@ -93,7 +111,7 @@ The release candidate to be voted over is available at:
- https://dist.apache.org/repos/dist/dev/teaclave/trustzone-sdk-$VERSION-$RC/
The release candidate is signed with a GPG key available at:
-- https://downloads.apache.org/teaclave/KEYS
+- https://downloads.apache.org/teaclave/KEYS
Instructions to verify the release candidate’s signature:
- https://teaclave.apache.org/download/#verify-the-integrity-of-the-files
@@ -125,5 +143,3 @@ explicitly.
Best,
$YOUR_NAME
````
-
-
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@teaclave.apache.org
For additional commands, e-mail: commits-help@teaclave.apache.org