ivila commented on PR #180:
URL: 
https://github.com/apache/incubator-teaclave-trustzone-sdk/pull/180#issuecomment-2804172341

   How about adding comments in the `build_runner_image.yml`:
   
   ```yml
   # This action provides a standardized and reproducible way to build a CI 
runner
   # image.
   #
   # It is especially helpful for developers who want to contribute to the 
github
   # workflow of teaclave, includes the following:
   #
   # 1. Changes to the CI runner image via Dockerfile modifications
   # 2. Experiments with new platforms (e.g., adding ARM64 runner)
   #
   # Developers can build their own image, test it in their fork or repository, 
and
   # once verified, request maintainers to build and publish the official image.
   # The developer’s tested image and the final official image should be 
identical
   # to ensure consistency.
   #
   #
   # Example Workflow:
   # Suppose a developer named Alice wants to modify the base runner image.
   # She would:
   #
   # 1. Update the Dockerfile with her changes.
   # 2. Build a custom runner image using GitHub Actions.
   # 3. In her branch, temporarily replace the official runner image with her
   #    custom image in the CI workflow.
   # 4. Run the CI using the modified setup to verify everything works as 
expected.
   #
   # Once the tests pass:
   # 5. Alice opens a PR demonstrating the container used, the CI results.
   # 6. The Teaclave maintainers will build an official image via GitHub 
Actions,
   #    which should be identical to Alice's custom image.
   # 7. Finally, she updates the CI workflow to use the official image built 
from
   #    the updated Dockerfile instead of her custom one.
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscr...@teaclave.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@teaclave.apache.org
For additional commands, e-mail: dev-h...@teaclave.apache.org

Reply via email to