Palladio-Build-Nightly

This repository implements a dynamic build pipeline for Palladio. Projects that want to participate must provide a .github/workflows/build.yml file, a features and bundles folder and deploy themselves to the update-site that is configured in the update_build.yml workflow in this repository.

Workflows

This repository contains two workflows. update_build.yml runs a dependency tool to generate nightly.yml which contains the build jobs for the nightly build in the Palladio organization. The jobs do not actually build the project but trigger the workflows on the corresponding repo instead.

• update_build.yml

  • Runs Palladio-Build-DependencyTool to determine the repositories that need to be build and the dependencies between them.
  • Generates nightly.yml which contains the jobs that trigger the workflows on the repositories. The generation process can be configured using the files in /template
  • Caution: The dependency tool generates a lot (near 1000) API calls and can therefore be only run once per hour when using the GitHub provided token which has a rate limit of 1000 API calls/hour.

• nightly.yml

  • Executes the workflow on the corresponding repositories and reports their outcome.
  • The workflows are only executed if:
    • No workflow was run on the repository.
    • There was a commit since the last workflow run.
    • There was a successful workflow run on a dependency since the last workflow run. Only the last 30 workflow runs are checked.

Note

On the first of the month and whenever the nighly build is triggered manually, all workflows are executed regardless of the above-defined preconditions.

Configuration

The build can be configured by changing the templates in the /template folder. These variables are automatically replaced by the update script.

nightly_template.yml

Template for nightly build.

Variable	Type	Description
${{ jobs }}	object	The jobs which are generated from job_template.yml.

job_template.yml

Job template for automatically discovered jobs. These are inserted into the ${{ jobs }} variable.

Variable	Type	Description
${{ repo_name }}	string	The full name of the repository in the form Owner/Reponame.
${{ repo_name_short }}	string	The name of the repository in the form Reponame (without the owner).
${{ deps_short }}	array	The build dependencies. An array of short repository names.
${{ repo_owner }}	string	The name of the owner.
${{ deps_json }}	string	The build dependencies as JSON array.

custom_jobs_template.yml

Define additional jobs that should be inserted into the ${{ jobs }} variable. Jobs under templated are created from the job_template.yml above. Jobs under custom are added as-is.

Example:

templated:
  # Must contain owner
  PalladioSimulator/Palladio-Build-UpdateSite: ${{ repo_names }}
  PalladioSimulator/Palladio-Bench-Product: ${{ repo_names }}

custom:
  MyCustomJob:
    runs-on: ubuntu-latest
      steps:
        - name: Checkout Code
          uses: actions/checkout@v3
        - ...

Variable	Type	Description
${{ repo_names }}	array	The full names of the automatically discovered repositories in the form Owner/Reponame.
${{ repo_names_short }}	array	The names of the automatically discovered repositories in the form Reponame (without the owner).