diff --git a/README.md b/README.md index e3feb0a..d393fe0 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,22 @@ We implement the workaround with two GitHub Actions: * [Matrix Outputs Write](https://github.com/cloudposse/github-action-matrix-outputs-write) * [Matrix Outputs Read](https://github.com/cloudposse/github-action-matrix-outputs-read) +## v1 - What's new + +> [!IMPORTANT] +> cloudposse/github-action-matrix-outputs-read@v1+ is not currently supported on GHES yet. If you are on GHES, you +> must use [v0](https://github.com/cloudposse/github-action-matrix-outputs-read/releases/tag/0.1.2). + +The release of `cloudposse/github-action-matrix-outputs-write@v1` and `cloudposse/github-action-matrix-outputs-read@v1` +are major changes to the backend architecture of Artifacts. They have numerous performance and behavioral improvements. + +For more information, see the [`@actions/artifact`](https://github.com/actions/toolkit/tree/main/packages/artifact) documentation. + +### Breaking Changes + +1. On self hosted runners, additional [firewall rules](https://github.com/actions/toolkit/tree/main/packages/artifact#breaking-changes) may be required. +2. `cloudposse/github-action-matrix-outputs-read@v1` can not be read outputs writen by `cloudposse/github-action-matrix-outputs-write@v0`. + diff --git a/README.yaml b/README.yaml index 4c2e675..f3df173 100644 --- a/README.yaml +++ b/README.yaml @@ -48,6 +48,22 @@ introduction: |- * [Matrix Outputs Write](https://github.com/cloudposse/github-action-matrix-outputs-write) * [Matrix Outputs Read](https://github.com/cloudposse/github-action-matrix-outputs-read) + ## v1 - What's new + + > [!IMPORTANT] + > cloudposse/github-action-matrix-outputs-read@v1+ is not currently supported on GHES yet. If you are on GHES, you + > must use [v0](https://github.com/cloudposse/github-action-matrix-outputs-read/releases/tag/0.1.2). + + The release of `cloudposse/github-action-matrix-outputs-write@v1` and `cloudposse/github-action-matrix-outputs-read@v1` + are major changes to the backend architecture of Artifacts. They have numerous performance and behavioral improvements. + + For more information, see the [`@actions/artifact`](https://github.com/actions/toolkit/tree/main/packages/artifact) documentation. + + ### Breaking Changes + + 1. On self hosted runners, additional [firewall rules](https://github.com/actions/toolkit/tree/main/packages/artifact#breaking-changes) may be required. + 2. `cloudposse/github-action-matrix-outputs-read@v1` can not be read outputs writen by `cloudposse/github-action-matrix-outputs-write@v0`. + references: - name: "github-actions-workflows" description: "Reusable workflows for different types of projects"