Skip to content

Commit

Permalink
Replace workflows with those from shared templates
Browse files Browse the repository at this point in the history
  • Loading branch information
mattdean-digicatapult committed Jan 6, 2025
1 parent 2529c5e commit b978d67
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 309 deletions.
218 changes: 29 additions & 189 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,194 +1,34 @@
name: Release

name: Release (NPM)
on:
push:
branches: ['main']

jobs:
preconditions:
runs-on: ubuntu-latest
outputs:
repo_name: ${{ steps.repo_ids.outputs.REPO_NAME }}
org_name: ${{ steps.repo_ids.outputs.ORG_NAME }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Check Github token
run: |
if [ -z "${{ secrets.GITHUB_TOKEN }}"]; then
echo "Must provide a GITHUB_TOKEN secret in order to run release workflow"
exit 1
fi
- name: Check Dockerhub token
run: |
if [ -z "${{ secrets.SQNC_DOCKERHUB_TOKEN }}"]; then
echo "Must provide a SQNC_DOCKERHUB_TOKEN secret in order to run release workflow"
exit 1
fi
- name: Get repository identifiers
id: repo_ids
run: |
REPO_NAME=$(echo "${{ github.event.repository.name }}" | tr '[:upper:]' '[:lower:]')
ORG_NAME=$(echo "${{ github.event.repository.owner.name }}" | tr '[:upper:]' '[:lower:]')
echo "REPO_NAME=$REPO_NAME" >> $GITHUB_OUTPUT
echo "ORG_NAME=$ORG_NAME" >> $GITHUB_OUTPUT
static-checks:
name: Run Static Analysis Checks
strategy:
fail-fast: false
matrix:
command: [lint, depcheck, build]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20.x
- name: Cache Node.js modules
uses: actions/cache@v4
with:
path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.OS }}-node-
${{ runner.OS }}-
- name: Install Packages
run: npm ci
- name: ${{ matrix.command }}
run: npm run ${{ matrix.command }}

static-checks-npm:
uses: digicatapult/shared-workflows/.github/workflows/static-checks-npm.yml@main
with:
matrix_commands: '["lint", "depcheck", "check"]'
tests:
name: Run tests
runs-on: ubuntu-latest
needs: [preconditions]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@master
with:
node-version: 20.x
- name: Use npm latest
run: npm install -g npm@latest
- name: Cache Node.js modules
uses: actions/cache@v4
with:
path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.OS }}-node-
${{ runner.OS }}-
- name: Install Packages
run: npm ci
- name: Tsoa build
run: npm run tsoa:build
- name: Setup dependencies
run: docker compose up -d
- name: Sleep
uses: kibertoad/[email protected]
with:
time: '30s'
- name: Initialise DB
run: npm run db:migrate
- name: Run tests
run: npm run test

check-version:
name: 'Check version'
runs-on: ubuntu-latest
outputs:
is_new_version: ${{ steps.get_version.outputs.IS_NEW_VERSION }}
version: ${{ steps.get_version.outputs.VERSION }}
build_date: ${{ steps.get_version.outputs.BUILD_DATE }}
is_prerelease: ${{ steps.get_version.outputs.IS_PRERELEASE }}

steps:
- uses: actions/checkout@v4
- name: Check version
id: get_version
uses: digicatapult/check-version@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}

publish:
name: 'Publish package'
needs: [preconditions, static-checks, tests, check-version]
runs-on: ubuntu-latest
if: ${{ needs.check-version.outputs.is_new_version == 'true' }}

steps:
- uses: actions/checkout@v4

# Docker build
- name: Setup QEMU
uses: docker/setup-qemu-action@v3
with:
platforms: all
- name: Setup Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v3
with:
buildkitd-flags: '--debug'
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: $GITHUB_ACTOR
password: ${{ secrets.GITHUB_TOKEN }}
- name: Login to Dockerhub Registry
uses: docker/login-action@v3
with:
username: ${{ secrets.SQNC_DOCKERHUB_USERNAME }}
password: ${{ secrets.SQNC_DOCKERHUB_TOKEN }}
- name: Publish multi-arch image
uses: docker/build-push-action@v6
with:
push: true
builder: ${{ steps.buildx.outputs.name }}
context: .
file: ./Dockerfile
platforms: linux/amd64, linux/arm64
tags: |
ghcr.io/${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:${{ needs.check-version.outputs.version }}
${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:${{ needs.check-version.outputs.version }}
ghcr.io/${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:latest
${{ needs.preconditions.outputs.org_name }}/${{ needs.preconditions.outputs.repo_name }}:latest
labels: |
org.opencontainers.image.title=${{ needs.preconditions.outputs.repo_name }}
org.opencontainers.image.description=${{ github.event.repository.description }}
org.opencontainers.image.source=${{ github.event.repository.html_url }}
org.opencontainers.image.url=${{ github.event.repository.html_url }}
org.opencontainers.image.revision=${{ github.sha }}
org.opencontainers.image.version=${{ needs.check-version.outputs.version }}
org.opencontainers.image.created=${{ needs.check-version.outputs.build_date }}
# Build github release
- name: Build release version
uses: softprops/action-gh-release@v2
with:
token: '${{ secrets.GITHUB_TOKEN }}'
tag_name: ${{ needs.check-version.outputs.version }}
prerelease: false
name: ${{ needs.check-version.outputs.version }}
generate_release_notes: true
- name: Delete release latest
uses: actions/github-script@v7
with:
github-token: ${{secrets.GITHUB_TOKEN}}
script: |
const { owner, repo } = context.repo
try {
await github.rest.git.deleteRef({ owner, repo, ref: 'tags/latest' })
}
catch (err) {
if (err.status !== 422) throw err
}
- name: Build release latest
uses: softprops/action-gh-release@v2
with:
token: '${{ secrets.GITHUB_TOKEN }}'
tag_name: latest
prerelease: false
name: Latest ${{ needs.check-version.outputs.version }}
generate_release_notes: true
uses: digicatapult/shared-workflows/.github/workflows/tests-npm.yml@main
with:
npm_build_command: 'npm run tsoa:build'
pre_test_command: 'npm run db:migrate'
tests: '["test"]'
build-docker:
needs: [tests, static-checks-npm]
uses: digicatapult/shared-workflows/.github/workflows/build-docker.yml@main
with:
push_dockerhub: true
push_ghcr: true
permissions:
packages: write
contents: write
secrets:
DOCKERHUB_TOKEN: ${{ secrets.SQNC_DOCKERHUB_TOKEN }}
DOCKERHUB_USERNAME: ${{ secrets.SQNC_DOCKERHUB_USERNAME }}
release-github:
needs: [build-docker]
uses: digicatapult/shared-workflows/.github/workflows/release-github.yml@main
permissions:
contents: write
pull-requests: read
secrets: inherit
20 changes: 20 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Test (NPM)
on:
push:
branches-ignore: ['main']
jobs:
static-checks-npm:
uses: digicatapult/shared-workflows/.github/workflows/static-checks-npm.yml@main
with:
matrix_commands: '["lint", "depcheck", "check"]'
tests:
uses: digicatapult/shared-workflows/.github/workflows/tests-npm.yml@main
with:
npm_build_command: 'npm run tsoa:build'
pre_test_command: 'npm run db:migrate'
tests: '["test"]'
build-docker:
uses: digicatapult/shared-workflows/.github/workflows/build-docker.yml@main
permissions:
packages: write
contents: write
119 changes: 0 additions & 119 deletions .github/workflows/tests.yml

This file was deleted.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"main": "src/index.ts",
"scripts": {
"build": "npm run tsoa:build && swc ./src -d ./build --strip-leading-paths --copy-files",
"check": "tsc --noEmit",
"check": "npm run tsoa:build && tsc --noEmit",
"clean": "rimraf -rf ./build",
"test": "NODE_ENV=test mocha --config ./test/mocharc.json ./test/**/*.test.ts",
"lint": "prettier -c ./src ./test ./migrations",
Expand Down

0 comments on commit b978d67

Please sign in to comment.