From 665d8f05cc325fbafe32649803a9563ca1c2eb02 Mon Sep 17 00:00:00 2001 From: Conor Sloan Date: Wed, 22 Nov 2023 13:17:51 +0000 Subject: [PATCH] clean up markdowns --- CONTRIBUTING.md | 2 +- README.md | 32 ++++++++++++++++---------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f815a99..4088f4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -## Initial Setup +# Initial Setup After you've cloned the repository to your local machine or codespace, you'll need to perform some initial setup steps before you can develop your action. diff --git a/README.md b/README.md index 3477caf..5ba57de 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ -

- -

+# Publish Action Package -# Package and Publish +This action packages your action repository as OCI artifacts and publishes it to [GHCR](ghcr.io). -This action packages your action repository as OCI artifacts and publishes it to [GHCR](ghcr.io), so your action can then be consumed as a package to make the actions ecosystem more secure. +This allows your action to be consumed as an immutable package to make the actions ecosystem more secure. -The whole action repository is packaged by default. Set `path` input to specify which path you want to package if you want only a few folders (for eg. dist) to be packaged. +The whole action repository is packaged by default. Set `path` input to specify which path you want to package. -Make sure you use the [Starter Workflow] (https://github.com/actions-on-packages/.github) (TODO) to run the action and ensure you have the release trigger in the workflow where you use this action. +Make sure you use the [Starter Workflow](https://github.com/actions-on-packages/.github) (TODO) to run the action. +Please also ensure you have the release trigger in the workflow where you use this action. -# Usage +## Usage ```yaml @@ -42,19 +41,20 @@ on: ``` -# License +## License The scripts and documentation in this project are released under the [MIT License](LICENSE) +## [Internal] Differences from previous implementation -# [Internal] Differences from previous implementation +This is a new implementation of an Action which publishes a given release to ghcr.io (GitHub Packages). -This is a new implementation of an Action which publishes a given release to ghcr.io (GitHub Packages). It will eventually be moved to https://github.com/actions-on-packages/package-action and replace the existing implementation. +It will eventually be moved to our `actions`` org. The key differences are: -* This Action goes directly to GitHub Packages rather than using an API endpoint to pass a bundle to. -* This Action uses Node.js libraries to create both a `zip` and `tar.gz` of the content as layers. -* This Action creates and publishes the OCI manifest which houses those archives, which was previously done on the backend. -* This Action has the goal of generating provenance attestations for any release that is created. -* This Action parses and validates that the release tag which triggered it is in a valid semver format, either `1.0.3-prerelease` or `v1.0.0-prerelease`. +- This Action goes directly to GitHub Packages rather than using an API endpoint to pass a bundle to. +- This Action uses Node.js libraries to create both a `zip` and `tar.gz` of the content as layers. +- This Action creates and publishes the OCI manifest which houses those archives, which was previously done on the backend. +- This Action has the goal of generating provenance attestations for any release that is created. +- This Action parses and validates that the release tag which triggered it is in a valid semver format, either `1.0.3-prerelease` or `v1.0.0-prerelease`.