how to use one matrix element?

[almissab]

Select Topic Area

Question

Body

hello,
i need to use just one matrix element, based on inputs. How?

workflow_dispatch:
    inputs:
      DEPLOY:
        description: "Select what to deploy"
        type: choice
        default: "ALL"
        options:
          - "ALL"
          - "accounts-api"
          - "games-history-api"
          - "limits-api"
permissions:
  id-token: write

jobs:
  deploy:
    name: ${{ matrix.image }} 
    strategy:
      fail-fast: false
      matrix:
        include: 
          - image: accounts-api
            docker_tag: api-accounts
          - image: games-history-api
            docker_tag: api-games-history
          - image: limits-api
            docker_tag: api-limits
            
    if: ${{ inputs.DEPLOY == 'ALL' }}
    uses: mono-repo-maven-release-al.yml@main
    with:
      IMAGE_NAME: dfe-bff-${{ matrix.image }}
      DOCKER_TAG_PARAMETER_NAME: "/dfe-test02/${{ matrix.docker_tag  }}"
    secrets: inherit


  deploy_one:
    name: ${{ matrix.image }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - image: accounts-api
            docker_tag: api-accounts
          - image: games-history-api
            docker_tag: api-games-history
          - image: limits-api
            docker_tag: api-limits

    if: ${{ inputs.DEPLOY != 'ALL' }}
    uses: mono-repo-maven-release-al.yml@main
    with:
      IMAGE_NAME: dfe-bff-${{ ????? }}
      DOCKER_TAG_PARAMETER_NAME: "/dfe-test02/${{ ??????? }}"
    secrets: inherit
```
`

[Chanduporalla]

To handle the scenario where you need to deploy only one specific service based on the DEPLOY input, you can modify the workflow by dynamically selecting the matrix elements based on the input value. The idea is to include a conditional logic that picks only the relevant matrix element when inputs.DEPLOY is not equal to ALL.

Here is how you can modify the deploy_one job to use the selected input directly to filter the matrix elements:

yaml

name: Conditional Matrix Workflow

on:
workflow_dispatch:
inputs:
DEPLOY:
description: "Select what to deploy"
type: choice
default: "ALL"
options:
- "ALL"
- "accounts-api"
- "games-history-api"
- "limits-api"

permissions:
id-token: write

jobs:
deploy:
name: Deploy All
strategy:
fail-fast: false
matrix:
include:
- image: accounts-api
docker_tag: api-accounts
- image: games-history-api
docker_tag: api-games-history
- image: limits-api
docker_tag: api-limits
if: ${{ github.event.inputs.DEPLOY == 'ALL' }}
uses: mono-repo-maven-release-al.yml@main
with:
IMAGE_NAME: dfe-bff-${{ matrix.image }}
DOCKER_TAG_PARAMETER_NAME: "/dfe-test02/${{ matrix.docker_tag }}"
secrets: inherit

deploy_one:
name: Deploy Single
strategy:
fail-fast: false
matrix:
include:
- image: accounts-api
docker_tag: api-accounts
- image: games-history-api
docker_tag: api-games-history
- image: limits-api
docker_tag: api-limits
if: ${{ github.event.inputs.DEPLOY != 'ALL' && github.event.inputs.DEPLOY == matrix.image }}
uses: mono-repo-maven-release-al.yml@main
with:
IMAGE_NAME: dfe-bff-${{ matrix.image }}
DOCKER_TAG_PARAMETER_NAME: "/dfe-test02/${{ matrix.docker_tag }}"
secrets: inherit

The condition if: ${{ github.event.inputs.DEPLOY != 'ALL' && github.event.inputs.DEPLOY == matrix.image }} ensures that only the matrix element that matches the selected input is used in the deploy_one job.
The job deploy_one will only run for the specific service you selected using the DEPLOY input, filtering out other elements.
The variable references ${{ matrix.image }} and ${{ matrix.docker_tag }} are now properly aligned to work with the filtered matrix item. And i work on it it's working

[almissab]

I was going to do exactly the same, but the problem is that Job IF does not see the element of the matrix and gives an error: unrecognized named-value: 'matrix'. Located at position 70 within expression: github.event.inputs.DEPLOY != 'ALL' && github.event.inputs.DEPLOY == matrix.image.
and from Step I cannot use (uses: mono-repo-maven-release-al.yml@main) because there are also jobs.

[almissab]

Unexpected value 'when'
and here I also don't find 'when':
https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions

I don't understand why jobs.<job_id>.if dont see marix variables

[almissab]

I found only such a solution, maybe someone can suggest a better one?

name: Conditional Matrix Workflow

on:
  workflow_dispatch:
    inputs:
      DEPLOY:
        description: "Select what to deploy"
        type: choice
        default: "ALL"
        options:
          - "ALL"
          - "accounts-api"
          - "games-history-api"
          - "limits-api"
permissions:
  id-token: write

jobs:
  deploy_all:
    if: ${{ inputs.DEPLOY == 'ALL' }}
    strategy:
      fail-fast: false
      matrix:
        include: 
          - image: accounts-api
            docker_tag: api-accounts
          - image: games-history-api
            docker_tag: api-games-history
          - image: limits-api
            docker_tag: api-limits

    name: Deploy ${{ matrix.image }} 
    uses: mono-repo-maven-release-al.yml@main
    with:
      IMAGE_NAME: dfe-bff-${{ matrix.image }}
      DOCKER_TAG_PARAMETER_NAME: "/dfe-test02/${{ matrix.docker_tag }}"
    secrets: inherit

  checking_inputs:
    if: ${{ inputs.DEPLOY != 'ALL' }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - image: accounts-api
            docker_tag: api-accounts
          - image: games-history-api
            docker_tag: api-games-history
          - image: limits-api
            docker_tag: api-limits
    steps:
      - name: Check selected input
        if: ${{ matrix.image == inputs.DEPLOY }}
        id: check_selected
        run: |
          echo "image=${{ matrix.image }}" >> $GITHUB_OUTPUT
          echo "docker_tag=${{ matrix.docker_tag }}" >> $GITHUB_OUTPUT
    outputs:
      image: ${{ steps.check_selected.outputs.image }}
      docker_tag: ${{ steps.check_selected.outputs.docker_tag }}

  deploy-selected:
    needs: checking_inputs
    name: Deploy ${{ needs.checking_inputs.outputs.image }} 
    if: ${{ inputs.DEPLOY != 'ALL' }}
    uses: mono-repo-maven-release-al.yml@main
    with:
      IMAGE_NAME: dfe-bff-${{ needs.checking_inputs.outputs.image }}
      DOCKER_TAG_PARAMETER_NAME: "/dfe-test02/${{ needs.checking_inputs.outputs.docker_tag }}"
    secrets: inherit

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬