workflow-conclusion

This action will:

Use the Actions REST API to get the conclusion for each previous job.
- The API call provides the conclusion which is the job status after continue-on-error is applied.
- In addition to jobs, the API call also includes status check results.
Examine each additional conclusion that is provided through the additional-conclusions argument.
Determine a single workflow conclusion based on the API results and arguments.

The action will interpret a wider range of inputs in the additional-conclusions argument than the standard GitHub values of cancelled, skipped, failure and success. This allows using the outcome of a step as well as the output that an action might set.

[cancelled | canceled | cancel] are accepted and interpreted as cancelled
[failure | failing | failed | fail] are accepted and interpreted as failure
[success | passing | passed | pass] are accepted and interpreted as success
[skipped | skip] are accepted and interpreted as skipped

The final workflow conclusion is determined by:

First looking for any Cancelled conclusions and if found the conclusion is set to cancelled
Then looking for any Failed conclusions and if found the conclusion is set to failure
Finally looking for any Successful conclusions and if found the conclusion is set to success
If none of the statuses are found, it will set the workflow conclusion to the fallback value which defaults to skipped

Index

workflow-conclusion

Inputs

Parameter	Is Required	Description
`github-token`	true	The token used to make API requests
`additional-conclusions`	false	A JSON-parseable array of additional conclusions to consider. See the comments above for accepted values. See the Usage Example below for the correct format. This may be helpful if `continue-on-error` is used on a steps or for actions that provide an output with their own status.
`fallback-conclusion`	false	The fallback conclusion to use when a job's or step's additional conclusion cannot be determined. Defaults to skipped.
`suppress-fallback-warnings`	false	Whether to suppress warnings about the fallback conclusion. Defaults to create warnings.

Outputs

Output	Description
`workflow_conclusion`	The workflow conclusion.

Usage Examples

jobs:
  ...
  
  test:
    runs-on: [ubuntu-20.04]
    outputs: 
      test-step-outcome: ${{ steps.test.outcome }}             # Can be: cancelled, skipped, failure, success
      test-check-result: ${{ steps.test_check.test-outcome }}  # Can be:  Failed, Passed
    steps:
      - name: dotnet test with coverage
        id: test
        continue-on-error: true
        run: dotnet test --logger trx --configuration Release /property:CollectCoverage=True /property:CoverletOutputFormat=opencover
      
      - name: Process dotnet test results and create a status check
        id: test_check
        # You may also reference just the major or major.minor version
        uses: im-open/process-dotnet-test-results@v2.2.3
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          
  ...

  update-deployment-board:
    runs-on: [ubuntu-20.04]
    needs: [test, auto-deploy-to-dev]
    if: always()
    steps:
      - uses: im-open/workflow-conclusion@v2.2.3
        id: conclusion
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          # needs.test.outputs.test-step-outcome is step status before continue-on-error is applied.  Could be cancelled, skipped, failure, success.
          # needs.test.outputs.test-check-result is an output of the process-dotnet-test-results action.  Could be Failed or Passed
          additional-conclusions: |
            [
              { "name": "dotnet-test-coverage", "conclusion" : "${{ needs.test.outputs.test-step-outcome }}" }, 
              { "name": "process-test-results", "conclusion" : "${{ needs.test.outputs.test-check-result }}" }
            ]
      
      # Use the workflow conclusion below
      - name: Update Deployment Board
        uses: im-open/update-deployment-board@v1.5.1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN}}
          environment: ${{ github.event.inputs.environment }}
          board-number: 1
          ref: ${{ github.event.inputs.branch-tag-sha }}
          deploy-status: ${{ env.WORKFLOW_CONCLUSION }} # can also use ${{ steps.conclusion.workflow_conclusion }}

Contributing

When creating PRs, please review the following guidelines:

The action code does not contain sensitive information.
At least one of the commit messages contains the appropriate +semver: keywords listed under Incrementing the Version for major and minor increments.
The action has been recompiled. See Recompiling Manually for details.
The README.md has been updated with the latest version of the action. See Updating the README.md for details.
Any tests in the build-and-review-pr workflow are passing

Incrementing the Version

This repo uses git-version-lite in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if source code changes have been made. The following table provides the fragment that should be included in a commit message to active different increment strategies.

Increment Type	Commit Message Fragment
major	+semver:breaking
major	+semver:major
minor	+semver:feature
minor	+semver:minor
patch	default increment type, no comment needed

Source Code Changes

The files and directories that are considered source code are listed in the files-with-code and dirs-with-code arguments in both the build-and-review-pr and increment-version-on-merge workflows.

If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The build-and-review-pr workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.

If a PR consists solely of non-source code changes like changes to the README.md or workflows under ./.github/workflows, version updates and recompiles do not need to be performed.

Recompiling Manually

This command utilizes esbuild to bundle the action and its dependencies into a single file located in the dist folder. If changes are made to the action's source code, the action must be recompiled by running the following command:

# Installs dependencies and bundles the code
npm run build

Updating the README.md

If changes are made to the action's source code, the usage examples section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See Incrementing the Version for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.

Tests

The build and review PR workflow includes tests which are linked to a status check. That status check needs to succeed before a PR is merged to the default branch. The tests do not need special permissions, so they should succeed whether they come from a branch or a fork.

Code of Conduct

This project has adopted the im-open's Code of Conduct.

im-open/workflow-conclusion