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

  • delete-workflow-artifacts Deletes artifacts produced by the given workflow run, matching the provided artifact names or patterns. Artifact names can contain '?' for single character wildcards and '*' for multiple character wildcards.

  • 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.

  • soapui-testrunner Runs tests in a SoapUI and generates a report with the test results. Optionally a .properties file can be provided to set CI specific property values.

  • wait-till-healthy-container A more robust and flexible alternative to the frank-run-till-healthy action. Starting the container is left to other parts of the workflow with whatever method is prefered. This action simply waits till a Docker container running on the Docker host, returns a 'HEALTHY' health probe result.

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.

  • docusaurus-release A generic release workflow for publishing a Docusaurus documentation website to GitHub Pages.

  • 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'. The version tags are updated by default in Dockerfile and frankrunner.properties.

  • soapui-testrunner Runs tests in a SoapUI and generates a report with the test results. The application/environment under test can be brought up with a 'Setup' script and cleaned up afterwards with a 'Teardown' script. After the 'Setup' script has been executed, the workflow will wait for the container's health endpoint to report 'Healthy'. Once the container is heathy, the SoapUI TestRunner will be executed.

  • larva-testrunner Runs Larva testcases and generates a report with the test results. A Markdown version of the Larva test report is also generated and output as GitHub Actions run summary.

    The application/environment under test can be brought up with a 'Setup' script and cleaned up afterwards with a 'Teardown' script. After the 'Setup' script has been executed, the workflow will wait for the container's health endpoint to report 'Healthy'. Once the container is healthy, the Larva Test runner will be executed.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors