Test and Deploy scripts

This is a Maven project, which uses standard conventions for test and deploy.

What's notable is that it has Docker (testcontainers) tests and that it has a Maven BOM. The latter implies deploy runs twice: once for the normal project modules, and again for the BOM.

On deploy:

• [javadoc_to_gh_pages] pushes Javadoc to the gh-pages branch on N.M.L branch, but not master.
  • gh-pages is addressable via https://zipkin.io/zipkin/

Build Overview

build-bin holds portable scripts used in CI to test and deploy the project.

The scripts here are portable. They do not include any CI provider-specific logic or ENV variables. This helps test.yml (GitHub Actions) and alternatives contain nearly the same contents, even if certain OpenZipkin projects need slight adjustments here. Portability has proven necessary, as OpenZipkin has had to transition CI providers many times due to feature and quota constraints.

These scripts serve a second purpose, which is to facilitate manual releases, which has also happened many times due usually to service outages of CI providers. While tempting to use CI-provider specific tools, doing so can easily create a dependency where no one knows how to release anymore. Do not use provider-specific mechanisms to implement release flow. Instead, automate triggering of the scripts here.

The only scripts that should be modified per project are in the base directory. Those in sub directories, such as [docker], should not vary project to project except accident of version drift. Intentional changes in sub directories should be relevant and tested on multiple projects to ensure they can be blindly copy/pasted.

Conversely, the files in the base directory are project specific entry-points for test and deploy actions and are entirely appropriate to vary per project. Here's an overview:

Test

Test builds and runs any tests of the project, including integration tests. CI providers should be configured to run tests on pull requests or pushes to the master branch, notably when the tag is blank. Tests should not run on documentation-only commits. Tests must not depend on authenticated resources, as running tests can leak credentials. Git checkouts should include the full history so that license headers or other git analysis can take place.

• [configure_test] - Sets up build environment for tests.
• [test] - Builds and runs tests for this project.

Example GitHub Actions setup

A simplest GitHub Actions test.yml runs tests after configuring them, but only on relevant event conditions. The name test.yml and job test allows easy references to status badges and parity of the scripts it uses.

The on: section obviates job creation and resource usage for irrelevant events. Notably, GitHub Actions includes the ability to skip documentation-only jobs.

Here's a partial test.yml including only the aspects mentioned above.

on:
  push:
    tags: ''
    branches: master
    paths-ignore: '**/*.md'
  pull_request:
    branches: master
    paths-ignore: '**/*.md'

jobs:
  test:
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0  # full git history for license check
      - name: Test
        run: |
          build-bin/configure_test
          build-bin/test

Deploy

Deploy builds and pushes artifacts to a remote repository for master and release commits on it. CI providers deploy pushes to master on when the tag is blank, but not on documentation-only commits. Releases should deploy on version tags (ex /^[0-9]+\.[0-9]+\.[0-9]+/), without consideration of if the commit is documentation only or not.

• [configure_deploy] - Sets up environment and logs in, assuming [configure_test] was not called.
• [deploy] - deploys the project, with arg0 being "master" or a release commit like "1.2.3"

Example GitHub Actions setup

A simplest GitHub Actions deploy.yml deploys after logging in, but only on relevant event conditions. The name deploy.yml and job deploy allows easy references to status badges and parity of the scripts it uses.

The on: section obviates job creation and resource usage for irrelevant events. GitHub Actions cannot implement "master, except documentation only-commits" in the same file. Hence, deployments of master will happen even on README change.

Here's a partial deploy.yml including only the aspects mentioned above. Notice env variables are explicitly defined and on.tags is a glob pattern.

on:
  push:
    tags: '[0-9]+.[0-9]+.[0-9]+**'  # e.g. 8.272.10 or 15.0.1_p9
    branches: master

jobs:
  deploy:
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 1  # only needed to get the sha label
      - name: Configure Deploy
        run: build-bin/configure_deploy
        env:
          GH_USER: ${{ secrets.GH_USER }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
      - name: Deploy
        # GITHUB_REF will be refs/heads/master or refs/tags/1.2.3
        run: build-bin/deploy $(echo ${GITHUB_REF} | cut -d/ -f 3)