Workflows

Repository to have shared workflows to be used across organization.

Re-usable Workflows

To use a workflow:

jobs:
  job-name:
    uses: chill-viking/workflows/.github/workflows/{FILENAME}.yml@TAG_OR_BRANCH

Typically, would suggest using main branch when using a workflow. Not really going to bother with tagging this repo at this time, but that may change later... we'll see.

To create a re-usable workflow, it just needs to have workflow_call specified as it's trigger, which you can use to specify inputs and secrets for the workflow.

For more detail you can start your journey at Creating a reusable workflow in GitHub Docs.

Available Re-usable Workflows

• nx-sonar-cloud-all.yml
• nx-sonar-cloud-scan.yml
• nx-test-affected.yml
• release-manifest-please
• swa-deploy

nx-sonar-cloud-all.yml

Will test and publish results to sonar cloud for all libs and/or apps in a nx workspace that have sonar-project.properties file.

This workflow will only scan projects that have a sonar-project.properties file in the project folder, and either the folder is included in released-paths input or changes have occurred in the folder.

Usage:

jobs:
  use-workflow:
    name: Publish libs & apps
    uses: chill-viking/workflows/.github/workflows/nx-sonar-cloud-all.yml@main
    with:
      working-directory: ./nx-workspace-folder/
    secrets:
      sonar-token: ${{ secrets.SONAR_TOKEN }}
      github-token: ${{ secrets.GITHUB_TOKEN }}

Expected Config:

The following config files are expected in the project path to be scanned.

sonar-project.properties

Configuration for the sonar cloud scan. And will be used to determine the project path for the scan.

sonar.organization=[sonar-org]
sonar.projectKey=[sonar-project]

sonar.javascript.lcov.reportPaths=[lcov.info location]
sonar.typescript.tsconfigPaths=[tsconfig location]

Value Name	Description
sonar-org	Sonar Cloud organization key
sonar-project	Sonar Cloud project key
lcov.info location	Location of lcov.info file
tsconfig location	Location of tsconfig.json file, typically tsconfig.lib.json or tsconfig.app.json to exclude specs from coverage results

jest.config.ts

Configuration for the jest test runner. These are primarily suggestions to ensure that the coverage report is generated with the necessary root.

export default {
  // ...
  coverageDirectory: 'coverage',
  coverageReporters: [['lcov', { projectRoot: 'apps/my-app' }]],
  // ...
}

Property Name	Description
coverageDirectory	Directory to place coverage report, relative to project path in workspace.
coverageReporters	Reporters to use for coverage report. Set to use lcov and specify root as project path.

Defining the projectRoot will ensure that the coverage report is able to map source files in the sonar cloud report. Because the project root will be used as the root for the scan.

Inputs:

Name	Description	Required	Default
working-directory	The directory of the nx workspace.	No	./
is-release	Whether or not the scan being performed is a release. Will use an alpha version if set to false or not included. See get-version action for details.	No	false
released-paths	The paths of released projects to be scanned, will filter out paths without sonar-project.properties. Only used when is-released is 'true'	No	[]
files-for-coverage	The files to be used for coverage report. Will be used to check for changes to confirm if coverage report is necessary.	No	**/*.ts,**/*.html,**/*.cs
files-separator	The separator to use for files-for-coverage input.	No	,

nx-sonar-cloud-scan.yml

Will test and build nx project and publish results to sonar cloud.

Usage:

jobs:
  use-workflow:
    name: lint, test, and publish
    uses: chill-viking/workflows/.github/workflows/nx-sonar-cloud-scan.yml@main
    with:
      sonar-project: sonar-cloud-project-key
      working-directory: ./nx-workspace-folder/
      project-location: apps/project-name
      project-name: project-name
      config-location: tsconfig.app.json
      package-location: ./nx-workspace-folder/
    secrets:
      sonar-token: ${{ secrets.SONAR_TOKEN }}
      github-token: ${{ secrets.GITHUB_TOKEN }}

To get code coverage included, update project jest.config.ts with the following:

export default {
  // ...
  coverageDirectory: 'coverage',
  coverageReporters: [['lcov', { projectRoot: 'apps/project-name' }]],
  // ...
}

This will update coverage reporting to create the report at coverage/lcov.info in the project folder and have the generated coverage work for the project root.

Parameters:

Name	Description	Required	Default
sonar-org	Sonar Cloud organization key	No	chill-viking-org
sonar-project	Sonar Cloud project key	Yes
working-directory	Location of nx workspace	No	./
project-location	Location of project within nx workspace	Yes
coverage-location	Location of coverage report	No	coverage/lcov.info
project-name	Name of project	Yes
config-location	Location of project TS config file	Yes
project-version	Version of project	No	'' - will be retrieved from package.json
package-location	Location of project package.json file	No	{working-directory}{project-location}

Secrets:

Name	Description
sonar-token	Sonar Cloud token
github-token	GitHub token for PR comments

nx-test-affected.yml

Will call lint/test/build targets for all affected projects inside the specified nx workspace.

Usage:

jobs:
  use-remote-workflow:
    uses: chill-viking/workflows/.github/workflows/nx-test-affected.yml@main
    name: 'Test Affected'
    with:
      working-directory: './npm-root-folder/'
      fetch-depth: 0
      agent-count: 4

Inputs:

Name	Description	Required	Default
working-directory	The directory to run the workflow from.	No	./
fetch-depth	The number of commits to fetch.	No	0
agent-count	The number of agents to use for parallelization.	No	3
base	The base branch to compare against.	No	origin/main
head	The head branch to compare against.	No	HEAD

release-manifest-please.yml

Workflow to create a new release using release-please using manifest configuration. Will create a pull request to update the manifest file and it's related project file with the new version.

Usage:

jobs:
  use-remote-workflow:
    uses: chill-viking/workflows/.github/workflows/release-manifest-please.yml@main
    name: 'Release Please'
    secrets:
      git_pat: ${{ secrets.GITHUB_PAT }}
      sonar_token: ${{ secrets.SONAR_TOKEN }}

Parameters:

Name	Description	Required	Default
debug	Whether or not to run in debug mode.	No	false

Secrets:

Name	Description
git_pat	GitHub token for creating new release PR, will require write access to the repository.
sonar_token	Sonar Cloud token for publishing coverage results.

swa-deploy

Deploy Azure Static Web App. Will do an initial installation of dependencies, to speed up build process.

Usage:

jobs:
  deploy:
    uses: chill-viking/workflows/.github/workflows/swa-deploy.yml@main
    name: SWA
    if: always() # ensure that used for closed event action, to destroy pull request environment
    with:
      working_directory: ./work_dir
      app_location: ./work_dir
      output_location: work_dir/dist
    secrets:
      swa_token: ${{ secrets.SWA_TOKEN }}
      git_token: ${{ secrets.GITHUB_TOKEN }}

Parameters:

Name	Description	Required	Default
output_location	Location of compiled frontend application to be deployed	Yes
action	Action to perform	No	upload
app_location	Location of application source code to be built	No	/
api_location	Location of api source code to be used	No	''
working_directory	Location of working directory to install dependencies	No	./
files_for_deploy	Files to check for change, when changed deploy will occur	No	'**/*.ts,**/*.html'
file_separator	Separator to use for files	No	','
always_deploy	Whether or not to always deploy, will ignore if files not changed	No	false
debug	Whether or not to output debug logs	No	false

Secrets:

Name	Description
swa_token	Azure Static Web App token
git_token	GitHub token for PR comments

Composite actions

Actions to be re-used in workflows.

To use an action:

uses: chill-viking/workflows/actions/{action-folder}@main

Available composite actions

• get-json-version
• get-version
• npm-ci
• nx-test
• nx-test-and-build

get-json-version

Get version from package.json or any json file with a version property.

Usage:

jobs:
  job-id:
    name: 'Name of job'
    runs-on: ubuntu-latest
    steps:
      - uses: chill-viking/workflows/actions/get-json-version@main
        name: Get version
        id: step-id
        with:
          path: 'npm-root-folder'

      # Use version read from ./npm-root-folder/package.json
      - run: echo ${{ steps.step-id.outputs.json-version }} # 1.0.0

Inputs:

Name	Description	Required	Default
path	The path of the folder containing the json file. 1️	No	.
json-file	The json file containing version property to read.	No	package.json

Notes:

1️ Should only be the folder path, not the file name.

Outputs:

Name	Description
json-version	The value of version property from json-file in path folder

get-version

Get version from package.json and prepare as an alpha version, if is-release not provided or set to 'false'.

The alpha version generated will be {adjusted-package-version}-alpha.{github.run_number}. Using {github.run_number} to ensure that the alpha version is unique.

{adjusted-package-version} will be a bumped version of the version from package.json. Choose which part of the version to bump by providing version-to-bump input, which can be major, minor, or patch. This will default to patch.

Usage:

jobs:
  job-id:
    name: 'Name of job'
    runs-on: ubuntu-latest
    steps:
      - uses: chill-viking/workflows/actions/get-version@main
        name: Get version
        id: step-id
        with:
          package-path: './npm-root-folder'

      # Use version read from ./npm-root-folder/package.json
      - run: echo ${{ steps.step-id.outputs.version }} # 1.0.0-alpha.123

Inputs:

Name	Description	Required	Default
package-path	The path of the folder containing the package.json file.	No	./
is-release	Whether the output version is meant for a release.	No	'false'
version-to-bump	Which part of the version to bump.	No	'patch'

Outputs:

Name	Description
version	The resolved version to be used, either an alpha version or the actual version

npm-ci

⚠️ This action has been moved to its own repository, with a change to input. working-directory changed to working_directory (_ instead of -)

Install npm dependencies, using cache if already cached. Cache based on available package-lock.json files in source.

Usage:

jobs:
  job-id:
    name: 'Name of job'
    runs-on: ubuntu-latest
    steps:
      - uses: chill-viking/workflows/actions/npm-ci@main
        name: Install dependencies
        with:
          working-directory: './npm-root-folder/'

Inputs:

Name	Description	Required	Default
working-directory	The directory to run the workflow from. 1️⃣	No	./

Notes: 1️⃣ Make sure to suffix working-directory path with /, as node_modules will be appended to specify folder to be cached

nx-test

Composite action to run test target for the current nx workspace.

Usage:

jobs:
  job-id:
    name: 'Name of job'
    runs-on: ubuntu-latest
    steps:
      - uses: chill-viking/workflows/actions/nx-test@main
        name: Test nx-project
        with:
          project-name: 'nx-project'
          working-directory: './npm-root-folder/'

Inputs:

Name	Description	Required	Default
project-name	name of project in nx workspace to run :test against	Yes
working-directory	location of nx workspace	No	./

nx-test-and-build

Composite action to run test and build targets for the current nx workspace.

Usage:

jobs:
  job-id:
    name: 'Name of job'
    runs-on: ubuntu-latest
    steps:
      - uses: chill-viking/workflows/actions/nx-test-and-build@main
        name: Test and Build nx-project
        with:
          project-name: 'nx-project'
          working-directory: './npm-root-folder/'

Inputs:

Name	Description	Required	Default
project-name	name of project in nx workspace to run targets against	Yes
working-directory	location of nx workspace	No	./