Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/cloudposse/github-action-matrix-outputs-write

Workaround implementation - Write matrix jobs outputs
https://github.com/cloudposse/github-action-matrix-outputs-write

Last synced: about 1 year ago
JSON representation

Workaround implementation - Write matrix jobs outputs

Awesome Lists containing this project

README 

          



# github-action-matrix-outputs-write [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-matrix-outputs-write.svg)](https://github.com/cloudposse/github-action-matrix-outputs-write/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)



[![README Header][readme_header_img]][readme_header_link]



[![Cloud Posse][logo]](https://cpco.io/homepage)



[Workaround implementation](https://github.com/community/community/discussions/17245#discussioncomment-3814009) - Write matrix jobs outputs



---



This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.

[][share_email]

[][share_googleplus]

[][share_facebook]

[][share_reddit]

[][share_linkedin]

[][share_twitter]



It's 100% Open Source and licensed under the [APACHE2](LICENSE).



## Introduction



GitHub actions have an [Jobs need a way to reference all outputs of matrix jobs](https://github.com/community/community/discussions/17245) issue.

If there is a job that runs multiple times with `strategy.matrix` only the latest iteration's output availiable for 

reference in other jobs.



There is a [workaround](https://github.com/community/community/discussions/17245#discussioncomment-3814009) to address the limitation.

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-write@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-write/releases/tag/0.5.0).



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. Outputs writen with `cloudposse/github-action-matrix-outputs-write@v1` can not be read by `cloudposse/github-action-matrix-outputs-read@v0`and below versions.  



## Usage



Example how you can use workaround to reference matrix job outputs.



```yaml

  name: Pull Request

  on:

    pull_request:

      branches: [ 'main' ]

      types: [opened, synchronize, reopened, closed, labeled, unlabeled]



  jobs:

    build:

      runs-on: ubuntu-latest

      strategy:

        matrix:

          platform: ["i386", "arm64v8"]

      steps:

        - name: Checkout

          uses: actions/checkout@v3



        - name: Build

          id: build

          uses: cloudposse/github-action-docker-build-push@1.9.0

          with:

            registry: registry.hub.docker.com

            organization: "${{ github.event.repository.owner.login }}"

            repository: "${{ github.event.repository.name }}"

            build-args: |-

              PLATFORM=${{ matrix.platform }}



        ## Write for matrix outputs workaround 

        - uses: cloudposse/github-action-matrix-outputs-write@v1

          id: out

          with:

            matrix-step-name: ${{ github.job }}

            matrix-key: ${{ matrix.platform }}

            outputs: |-

              image: ${{ steps.build.outputs.image }}:${{ steps.build.outputs.tag }}

              ## Multiline string

              tags: ${{ toJson(steps.build.outputs.image) }}



    ## Read matrix outputs 

    read:

      runs-on: ubuntu-latest

      needs: [build]

      steps:

        - uses: cloudposse/github-action-matrix-outputs-read@v1

          id: read

          with:

            matrix-step-name: build



      outputs:

        result: "${{ steps.read.outputs.result }}"

  

    ## This how you can reference matrix output

    assert:

      runs-on: ubuntu-latest

      needs: [read]

      steps:

        - uses: nick-fields/assert-action@v1

          with:

            expected: ${{ registry.hub.docker.com }}/${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}:i386

            ## This how you can reference matrix output

            actual: ${{ fromJson(needs.read.outputs.result).image.i386 }}

  

        - uses: nick-fields/assert-action@v1

          with:

            expected: ${{ registry.hub.docker.com }}/${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}:arm64v8

            ## This how you can reference matrix output

            actual: ${{ fromJson(needs.read.outputs.result).image.arm64v8 }}

```



### Reusable workflow example 



Reusable workflow that support matrix outputs



`./.github/workflow/build-reusabled.yaml`



```yaml

name: Build - Reusable workflow

on:

  workflow_call:

    inputs:

      registry:

        required: true

        type: string

      organization:

        required: true

        type: string

      repository:

        required: true

        type: string

      platform:

        required: true

        type: string

      matrix-step-name:

        required: false

        type: string

      matrix-key:

        required: false

        type: string

    outputs:

      image:

        description: "Image"

        value: ${{ jobs.write.outputs.image }}



jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3



      - name: Build

        id: build

        uses: cloudposse/github-action-docker-build-push@1.9.0

        with:

          registry: ${{ inputs.registry }}

          organization: ${{ inputs.organization }}

          repository: ${{ inputs.repository }}

          build-args: |-

            PLATFORM=${{ inputs.platform }}

    outputs:

      image: ${{ needs.build.outputs.image }}:${{ needs.build.outputs.tag }}



  write:

    runs-on: ubuntu-latest

    needs: [build]

    steps:        

      ## Write for matrix outputs workaround 

      - uses: cloudposse/github-action-matrix-outputs-write@v1

        id: out

        with:

          matrix-step-name: ${{ inputs.matrix-step-name }}

          matrix-key: ${{ inputs.matrix-key }}

          outputs: |-

            image: ${{ needs.build.outputs.image }}



    outputs:

      image: ${{ fromJson(steps.out.outputs.result).image }}

      image_alternative: ${{ steps.out.outputs.image }}

```



Then you can use the workflow with matrix



```yaml

name: Pull Request

on:

  pull_request:

    branches: [ 'main' ]

    types: [opened, synchronize, reopened, closed, labeled, unlabeled]



jobs:

  build:

    usage: ./.github/workflow/build-reusabled.yaml

    strategy:

      matrix:

        platform: ["i386", "arm64v8"]

    with:

      registry: registry.hub.docker.com

      organization: "${{ github.event.repository.owner.login }}"

      repository: "${{ github.event.repository.name }}"

      platform: ${{ matrix.platform }}

      matrix-step-name: ${{ github.job }}

      matrix-key: ${{ matrix.platform }}



  ## Read matrix outputs 

  read:

    runs-on: ubuntu-latest

    needs: [build]

    steps:

      - uses: cloudposse/github-action-matrix-outputs-read@v1

        id: read

        with:

          matrix-step-name: build



    outputs:

      result: "${{ steps.read.outputs.result }}"



  ## This how you can reference matrix output

  assert:

    runs-on: ubuntu-latest

    needs: [read]

    steps:

      - uses: nick-fields/assert-action@v1

        with:

          expected: ${{ registry.hub.docker.com }}/${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}:i386

          ## This how you can reference matrix output

          actual: ${{ fromJson(needs.read.outputs.result).image.i386 }}



      - uses: nick-fields/assert-action@v1

        with:

          expected: ${{ registry.hub.docker.com }}/${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}:arm64v8

          ## This how you can reference matrix output

          actual: ${{ fromJson(needs.read.outputs.result).image.arm64v8 }}

```



or as a simple job



```yaml

name: Pull Request

on:

  pull_request:

    branches: [ 'main' ]

    types: [opened, synchronize, reopened, closed, labeled, unlabeled]



jobs:

  build:

    usage: ./.github/workflow/build-reusabled.yaml

    with:

      registry: registry.hub.docker.com

      organization: "${{ github.event.repository.owner.login }}"

      repository: "${{ github.event.repository.name }}"

      platform: "i386"



  ## This how you can reference single job output

  assert:

    runs-on: ubuntu-latest

    needs: [build]

    steps:

      - uses: nick-fields/assert-action@v1

        with:

          expected: ${{ registry.hub.docker.com }}/${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}:i386

          ## This how you can reference matrix output

          actual: ${{ needs.build.outputs.image }}

```



## Inputs



| Name | Description | Default | Required |

|------|-------------|---------|----------|

| matrix-key | Matrix key | N/A | false |

| matrix-step-name | Matrix step name | N/A | false |

| outputs | YAML structured map of outputs | N/A | false |



## Outputs



| Name | Description |

|------|-------------|

| result | Outputs result (Deprecated!!!) |



## Share the Love



Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-matrix-outputs-write)! (it helps us **a lot**)



Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)



## Related Projects



Check out these related projects.



- [github-action-matrix-outputs-read](https://github.com/cloudposse/github-action-matrix-outputs-read) - Matrix outputs read



## References



For additional context, refer to some of these links.



- [github-actions-workflows](https://github.com/cloudposse/github-actions-workflows) - Reusable workflows for different types of projects

- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow



## Help



**Got a question?** We got answers.



File a GitHub [issue](https://github.com/cloudposse/github-action-matrix-outputs-write/issues), send us an [email][email] or join our [Slack Community][slack].



[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]



## DevOps Accelerator for Startups



We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.



[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]



Work directly with our team of DevOps experts via email, slack, and video conferencing.



We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.



- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.

- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.

- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.

- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.

- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.

- **Training.** You'll receive hands-on training so your team can operate what we build.

- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.

- **Troubleshooting.** You'll get help to triage when things aren't working.

- **Code Reviews.** You'll receive constructive feedback on Pull Requests.

- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.



## Slack Community



Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.



## Discourse Forums



Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.



## Newsletter



Sign up for [our newsletter][newsletter] that covers everything on our technology radar.  Receive updates on what we're up to on GitHub as well as awesome new projects we discover.



## Office Hours



[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!



[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]



## Contributing



### Bug Reports & Feature Requests



Please use the [issue tracker](https://github.com/cloudposse/github-action-matrix-outputs-write/issues) to report any bugs or file feature requests.



### Developing



If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].



In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.



 1. **Fork** the repo on GitHub

 2. **Clone** the project to your own machine

 3. **Commit** changes to your own branch

 4. **Push** your work back up to your fork

 5. Submit a **Pull Request** so that we can review your changes



**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!



## Copyright



Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)



## License



[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)



See [LICENSE](LICENSE) for full details.



```text

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



  https://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.

```



## Trademarks



All other trademarks referenced herein are the property of their respective owners.



## About



This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!



[![Cloud Posse][logo]][website]



We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️  [Open Source Software][we_love_open_source].



We offer [paid support][commercial_support] on all of our projects.



Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.



### Contributors



|  [![Igor Rodionov][goruha_avatar]][goruha_homepage]
[Igor Rodionov][goruha_homepage] |

|---|



  [goruha_homepage]: https://github.com/goruha

  [goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png



[![README Footer][readme_footer_img]][readme_footer_link]

[![Beacon][beacon]][website]



  [logo]: https://cloudposse.com/logo-300x69.svg

  [docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=docs

  [website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=website

  [github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=github

  [jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=jobs

  [hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=hire

  [slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=slack

  [linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=linkedin

  [twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=twitter

  [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=testimonial

  [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=office_hours

  [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=newsletter

  [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=discourse

  [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=email

  [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=commercial_support

  [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=we_love_open_source

  [terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=terraform_modules

  [readme_header_img]: https://cloudposse.com/readme/header/img

  [readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=readme_header_link

  [readme_footer_img]: https://cloudposse.com/readme/footer/img

  [readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=readme_footer_link

  [readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img

  [readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-matrix-outputs-write&utm_content=readme_commercial_support_link

  [share_twitter]: https://twitter.com/intent/tweet/?text=github-action-matrix-outputs-write&url=https://github.com/cloudposse/github-action-matrix-outputs-write

  [share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-matrix-outputs-write&url=https://github.com/cloudposse/github-action-matrix-outputs-write

  [share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-matrix-outputs-write

  [share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-matrix-outputs-write

  [share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-matrix-outputs-write

  [share_email]: mailto:?subject=github-action-matrix-outputs-write&body=https://github.com/cloudposse/github-action-matrix-outputs-write

  [beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-matrix-outputs-write?pixel&cs=github&cm=readme&an=github-action-matrix-outputs-write