Skip to content

Documentation & dependency upgrades #560

Documentation & dependency upgrades

Documentation & dependency upgrades #560

Workflow file for this run

name: CI
on:
push:
tags:
- 'v*'
pull_request:
branches:
- main
permissions:
contents: write
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: set up node
uses: actions/setup-node@v4
with:
node-version: 20.x
- uses: actions/checkout@v4
- run: yarn
- run: yarn lint
test:
name: Test
needs: [lint]
runs-on: ubuntu-latest
steps:
- name: set up node
uses: actions/setup-node@v4
with:
node-version: 20.x
- name: checkout
uses: actions/checkout@v4
- run: yarn
- run: yarn test
build-linux:
name: Build Linux
needs: [test]
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v4
- name: set up node
uses: actions/setup-node@v4
with:
node-version: 20.x
- name: build
run: |
yarn
VIV_VERSION="${{ github.ref_name }}" make linux
- name: upload artifact
uses: actions/upload-artifact@v4
with:
name: vivify-linux
path: build/linux
build-macos:
name: Build MacOS ${{ matrix.arch }}
needs: [test]
strategy:
matrix:
include:
- os: macos-latest
arch: arm
- os: macos-13
arch: x86
runs-on: ${{ matrix.os }}
steps:
- name: checkout
uses: actions/checkout@v4
- name: get Homebrew Node
# lists node dependencies, these need to be mirrored for the Homebrew package
run: |
brew update
brew install node
brew deps --installed --direct node > macos-deps-${{ matrix.arch }}.txt
- name: build
run: |
yarn
VIV_VERSION="${{ github.ref_name }}" make macos
- name: upload artifact (macOS build)
uses: actions/upload-artifact@v4
with:
name: vivify-macos-${{ matrix.arch }}
path: build/macos
- name: upload artifact (macOS dependency list)
uses: actions/upload-artifact@v4
with:
name: macos-deps-${{ matrix.arch }}
path: macos-deps-${{ matrix.arch }}.txt
release:
name: Release
needs: [build-linux, build-macos]
runs-on: ubuntu-latest
steps:
# we check out the repo to get information from tags
- name: checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
fetch-tags: true
# release binaries -------------------------------------------------------
- name: download linux artifact
uses: actions/download-artifact@v4
with:
name: vivify-linux
path: ./vivify-linux
- name: download macos arm artifact
uses: actions/download-artifact@v4
with:
name: vivify-macos-arm
path: ./vivify-macos-arm
- name: download macos x86 artifact
uses: actions/download-artifact@v4
with:
name: vivify-macos-x86
path: ./vivify-macos-x86
- name: fix permissions & archive
run: |
chmod +x ./vivify-linux/* ./vivify-macos-arm/* ./vivify-macos-x86/*
tar -czf vivify-linux.tar.gz vivify-linux
tar -czf vivify-macos-arm.tar.gz vivify-macos-arm
tar -czf vivify-macos-x86.tar.gz vivify-macos-x86
# macos dependencies -----------------------------------------------------
- name: download macos arm dependencies
uses: actions/download-artifact@v4
with:
name: macos-deps-arm
path: macos-deps-arm
- name: download macos x86 dependencies
uses: actions/download-artifact@v4
with:
name: macos-deps-x86
path: macos-deps-x86
# release notes ----------------------------------------------------------
# actions/checkout seems to have a bug where annotated tags are converted
# to simple tags so we have to fetch them explicitly again
# https://github.com/actions/checkout/issues/882
- run: git fetch --tags --force origin
- name: build release notes
run: |
echo -e "## What's changed\n" \
> release.md
git tag -l --format="%(contents)" ${{ github.ref_name }} | sed '/^-----BEGIN PGP SIGNATURE-----/,$d' \
>> release.md
echo -e "\n**Full changelog**: https://github.com/jannis-baum/vivify/compare/$(git tag --sort=version:refname | tail -2 | head -1)...${{ github.ref_name }}" \
>> release.md
echo -e '\n**SHA256 checksums**\\' \
>> release.md
echo -e "Linux: \`$(sha256sum vivify-linux.tar.gz | cut -d' ' -f1)\`\\" \
>> release.md
echo -e "macOS ARM: \`$(sha256sum vivify-macos-arm.tar.gz | cut -d' ' -f1)\`" \
>> release.md
echo -e "macOS x86: \`$(sha256sum vivify-macos-x86.tar.gz | cut -d' ' -f1)\`" \
>> release.md
if ! cmp -s macos-deps-arm/macos-deps-arm.txt macos-deps-x86/macos-deps-x86.txt; then
echo -e '\n**macOS Homebrew ARM dependencies**\n\n```plain' \
>> release.md
cat macos-deps-arm/macos-deps-arm.txt \
>> release.md
echo -e '```\n' \
>> release.md
echo -e '\n**macOS Homebrew x86 dependencies**\n\n```plain' \
>> release.md
cat macos-deps-x86/macos-deps-x86.txt \
>> release.md
echo -e '```' \
>> release.md
else
echo -e '\n**macOS Homebrew dependencies (shared across ARM and x86)**\n\n```plain' \
>> release.md
cat macos-deps-arm/macos-deps-arm.txt \
>> release.md
echo -e '```' \
>> release.md
fi
- name: print release notes for logs
run: cat release.md
# release ----------------------------------------------------------------
- name: release
if: startsWith(github.ref, 'refs/tags/v')
uses: softprops/action-gh-release@v2
with:
body_path: release.md
files: vivify-*.tar.gz