Skip to content

wearefrank/ci-cd-templates

Repository files navigation

CI/CD reusable workflows & GitHub actions

The purpose of these workflows an actions is to provide a maintainable way to reuse common ci/cd functionality.

GitHub actions:

  • frank-run-till-healthy Runs the Docker container till the health endpoint returns 'HEALTHY', indicating that the database and adapters are all correctly started.

  • next-reference Generates a reference to use for when a version is not available or appropriate.

  • update-buildinfo Updates the BuildInfo.properties file with the new version and datetime. The file needs to be already present in order to update the content.

GitHub reusable workflows:

  • ci-generic A generic continuous integration workflow that updates the instance BuildInfo.properties and builds and tests a Docker container with the docker-ci-generic workflow. This workflow only requires a version or reference to be available before calling this workflow.

  • docker-ci-generic A generic continuous integration workflow for Docker that builds the Docker image and executes several tests. The Checkov Linter is ran on the Dockerfile to check for security issues and enforces Dockerfile best practices. The built image is also tested by running it and waiting for the Frank!Framework health endpoint to signal that all adapters started successfully.

  • docker-release-generic Runs the Docker container till the health endpoint returns 'HEALTHY', indicating that the database and adapters are all correctly started.

  • ff-version-auto-bumper F!F version auto bumper workflow updates the Frank Framework version used in the project to the requested version (versions after 8.0.1). As default, the tag of the version is set to 'latest'.