Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add check-dependent-jobs action #16

Merged
merged 25 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/no-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:
- '**'
- '!.github/workflows/test-*'
- '!buildkite/run/**'
- '!check-dependent-jobs/**'
- '!git/setup/**'
- '!google/auth/**'
- '!updatecli/run/**'
Expand Down
42 changes: 42 additions & 0 deletions .github/workflows/test-check-dependent-jobs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: test-check-dependent-jobs

on:
pull_request:
branches:
- main
paths:
- '.github/workflows/test-check-dependent-jobs.yml'
- 'check-dependent-jobs/**'
push:
branches:
- main
paths:
- '.github/workflows/test-check-dependent-jobs.yml'
- 'check-dependent-jobs/**'

permissions:
contents: read

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./check-dependent-jobs
id: check
with:
jobs: '{ "job-a": { "result": "success" }, "job-b": { "result": "success" } }'
- name: assert outputs.is-success==true
run: test "${{ steps.check.outputs.is-success }}" = "true"
- uses: ./check-dependent-jobs
id: check-2
with:
jobs: '{ "job-a": { "result": "success" }, "job-b": { "result": "failure" } }'
- name: assert outputs.is-success==false
run: test "${{ steps.check-2.outputs.is-success }}" = "false"
- uses: ./check-dependent-jobs
id: check-3
with:
jobs: '{ "job-a": { "result": "failure" }, "job-b": { "result": "failure" } }'
- name: assert outputs.is-success==false
run: test "${{ steps.check-3.outputs.is-success }}" = "false"
49 changes: 49 additions & 0 deletions check-dependent-jobs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# <!--name-->check-dependent-jobs<!--/name-->

<!--description-->
Evaluates the combined the status results of the provided needs context.
<!--/description-->

## Inputs
<!--inputs-->
| Name | Description | Required | Default |
|--------|------------------------------|----------|---------|
| `jobs` | needs context as JSON string | `true` | ` ` |
<!--/inputs-->

## Outputs

<!--outputs-->
| Name | Description |
|--------------|-----------------------------------------------------------------|
| `is-success` | The evaluated result of all provided jobs in the needs context. |
| `status` | One of success or failure. |
<!--/outputs-->

## Usage

<!--usage action="elastic/oblt-actions/check-dependent-jobs" version="env:VERSION"-->
```yaml
jobs:
job-a:
runs-on: ubuntu-latest
steps:
- run: exit 1;
job-b:
runs-on: ubuntu-latest
steps:
- run: exit 0;
job-c:
if: always()
runs-on: ubuntu-latest
needs:
- job-a
- job-b
steps:
- id: check
uses: elastic/oblt-actions/check-dependent-jobs@v1
with:
jobs: ${{ toJSON(needs) }}
- run: ${{ steps.check.outputs.is-success }} # should exit with 1 or 0.
```
<!--/usage-->
27 changes: 27 additions & 0 deletions check-dependent-jobs/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: check-dependent-jobs
description: |
Evaluates the combined the status results of the provided needs context.
inputs:
jobs:
required: true
description: needs context as JSON string
outputs:
is-success:
description: The evaluated result of all provided jobs in the needs context.
value: ${{ steps.test.outputs.is-success }}
status:
description: One of success or failure.
value: ${{ steps.test.outputs.status }}
runs:
using: composite
steps:
- id: test
reakaleek marked this conversation as resolved.
Show resolved Hide resolved
uses: actions/github-script@v7
with:
script: |
const jobs = JSON.parse(process.env.JOBS)
const isSuccess = Object.values(jobs).every(job => job.result === 'success')
core.setOutput('is-success', isSuccess)
core.setOutput('status', isSuccess ? 'success' : 'failure')
env:
JOBS: ${{ inputs.jobs }}
Loading