From 58addcb0cc08b4adec248874443785bab7ae2e91 Mon Sep 17 00:00:00 2001 From: Conor Sloan Date: Tue, 30 Jul 2024 16:36:28 +0100 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4bfb899..11bb4a7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ # Publish Action Package +> [!IMPORTANT] +> This action is **not ready for public use**. It is part of an upcoming public roadmap item (see [GitHub Actions: Immutable actions publishing](https://github.com/github/roadmap/issues/592)). +> Attempts to use this action to upload an OCI artifact will not work until this feature has been fully released to the public. Please do not attempt to use it until that time. + _This action_ packages _your action_ as an OCI container and publishes it to the [GitHub Container registry](ghcr.io). This allows your action to be consumed as an _immutable_ package if a [SemVer](https://semver.org/) is specified in the consumer's workflow file. Your action workflow must be triggered on `release` as in the following example. The release's title must follow [semantic versioning](https://semver.org/). -Consumers of your action will then be able to specify the version, e.g., `- uses: your-name/your-action@v1.2.3` or even `- uses: your-name/your-action@v1`. +Consumers of your action will then be able to specify the version, e.g. + +* `- uses: your-name/your-action@v1.2.3` +* `- uses: your-name/your-action@v1` -> [!IMPORTANT] -> This action is **not ready for public use**. It is part of an upcoming public roadmap item (see [GitHub Actions: Immutable actions publishing](https://github.com/github/roadmap/issues/592)). -> Attempts to use this action to upload an OCI artifact will not work until this feature has been fully released to the public. Please do not attempt to use it until that time. ## Usage