Documentation improvements. #1784

	name: ssi-service-ci

	# when:
	# - a pull request is opened against main
	# - commits are pushed to main
	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main ]
	# used to run action manually via the UI
	workflow_dispatch:

	jobs:
	vulnerability-scan:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3

	- name: Set up Go
	uses: actions/setup-go@v3
	with:
	go-version: 1.20.6
	cache: true

	- name: Install Mage
	run: go install github.com/magefile/mage

	- name: Check Vulnerabilities
	run: mage -v vuln

	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3

	- name: Set up Go
	uses: actions/setup-go@v3
	with:
	go-version: 1.20.6
	cache: true

	- name: Install mage
	run: go install github.com/magefile/mage

	- name: Check if swagger is up to date
	if: ${{ github.ref != 'refs/heads/main' }}
	run: \|
	mage -v spec
	if (git diff --shortstat \| grep '[0-9]'); then \
	echo "Swagger spec is out of date. Please run mage spec"; \
	exit 1;
	fi

	- name: Build library
	run: mage build

	- name: Test
	run: mage CITest

	- name: Upload coverage to Codecov
	uses: codecov/codecov-action@v3

	- name: Build binary
	if: ${{ github.ref == 'refs/heads/main' }}
	run: mage artifact

	- uses: actions/upload-artifact@v3
	if: ${{ github.ref == 'refs/heads/main' }}
	with:
	path: bin/ssi-service

Provide feedback