.github

Summary

Product	Organisation-wide Github Actions Workflows
Description	Github Actions workflows which are used across the range of IATI Github repos for continuous integration and deployment.
Website	None
Related	Most in-use IATI apps.
Documentation	Rest of README
Technical Issues	See https://github.com/IATI/.github/issues
Support	https://iatistandard.org/en/guidance/get-support/

Code of Conduct

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

.github/workflows

Reusable GitHub actions workflows for IATI.

should_run.yaml

Determines if a deployment workflow should run for an IATI repository that uses dependabot dependency management for updates.

Pseudo Logic:

• If event_name = 'push', always run deployment
  • This covers any PRs/code pushed by a developer
  • PRs merged by dependabot don't pass this check
• If event_name = 'scheduled'
  • AND last commit author = dependabot (if last commit author is a developer, don't need to do another deploy because that commit would have triggered a deploy)
  • AND dependabot had a commit in last 24hrs (this is so we don't keep doing a deploy every day even if there are no new dependency updates)
  • Then run the deploy

cd_example.yaml

Example of how to use should_run.yaml reusable workflow in your deployment workflow to control if it should run on nightly scheduled run.

build_node_save.yaml

Builds a Node.js project with npm, no saving

build:
    uses: IATI/.github/.github/workflows/build_node_save.yaml@main
    with:
      save_artifact: false

Optionally zips and saves that project to a github artifact called build-artifact-dev:

build_save:
    uses: IATI/.github/.github/workflows/build_node_save.yaml@main
    with:
      save_artifact: true
      artifact_name: build-artifact-dev

If saving the artifact, you can download and unzip it for later steps with

steps:
  - name: Download build artifact
    uses: actions/download-artifact@v4
    with:
      name: build-artifact-dev

  - name: Unzip build artifact
    run: |
      unzip build-artifact-dev.zip
      rm build-artifact-dev.zip