Continuous-Integration on Micha Kops' Tech Notes

Whitesource Snippets

Sun, 11 Nov 2018 00:00:00 +0100

Whitesource Configuration for GitLab Pipeline

The following configuration derives values from predefined GitLab Variables

whitesource.conf

# Providing project information from GitLab CI
wss_project_name="$CI_PROJECT_NAME"
wss_project_version="$CI_JOB_ID"
wss_project_tag="$CI_COMMIT_TAG"

# Providing product information
wss_product_name="The Product Name"
wss_product_version="$POM_VERSION"

# Analyze the Maven POM and its transitive dependencies only, no file-system check
# Use this only if you don't have any extra checked in jar-files or stuff like that!
fileSystemScan=false
includes=pom.xml

# Only scanning the Maven project
resolveAllDependencies=false
maven.resolveDependencies=true

GitHub Snippets

Mon, 01 Mar 2010 00:00:00 +0100

GitHub Actions

Step to check variables and redistribute as env

The following step does ..

check of given variables are set, if not, exit with an error that is visible in the action’s log
provide the given input as environment variable in GITHUB_ENV

- name: configuration
      env:
        VAR1: ${{ needs.configure.outputs.something }}
        VAR2: ${{ vars.SOMETHING_OTHER }}/
        VAR3: "something_other_other"
      run: |
        for var in VAR1 VAR2 VAR3; do [ -n "${!var}" ] || { echo "$var is missing"; exit 1; }; echo "$var=${!var}" >> "$GITHUB_ENV"; done

GitLab Snippets

Mon, 01 Mar 2010 00:00:00 +0100

Generate AsciiDoc Documentation and Publish it with GitLab Pages

We setup a repository and add a directory named docs there .. this is the home of our AsciiDoc files.

We’re using asciidoctor/docker-asciidoctor as Docker image for tool provisioning

This is the .gitlab-ci.yml, we’re running the stage only when something in the docs directory has changed.

stages:
  - "Build docs"

# The name of the job activates the GitLab pages publication
pages:
  image: asciidoctor/docker-asciidoctor
  stage: "Build docs"
  tags:
    - build
  script:
    - sh ./gen_docs.sh
    - mv output public
  only:
    refs:
      - master
    changes:
      - /docs/*
  artifacts:
    paths:
      - public
    expose_as: 'Documentation Archive'