Skip to content

fix: auto commit and push documentation #396

fix: auto commit and push documentation

fix: auto commit and push documentation #396

Workflow file for this run

name: release
on:
workflow_dispatch:
inputs:
semver:
description: 'The semver to use'
required: true
default: 'patch'
type: choice
options:
# - auto
- patch
- minor
- major
- prerelease
# - prepatch
# - preminor
# - premajor
pull_request:
types: [closed]
jobs:
release:
runs-on: ubuntu-latest
permissions:
contents: write
issues: write
pull-requests: write
steps:
- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: 18
- uses: actions/checkout@v4
- name: Set git user
uses: fregante/setup-git-user@v1
- name: Generate Api docs
run: |
npm ci
npm run doc
- name: Push updated markdown docs
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: 'docs: update API docs'
file_pattern: 'docs/api/md/*'
push_options: --force
- uses: nearform-actions/optic-release-automation-action@v4
with:
commit-message: 'Release {version}'
sync-semver-tags: true
access: 'public'
# This prefix is added before the prerelease number, e.g. `v3.0.0-alpha.0`
# prerelease-prefix: 'alpha'
semver: ${{ github.event.inputs.semver }}
# Prereleases are published under the `alpha` npm dist-tag
# npm-tag: ${{ startsWith(github.event.inputs.semver, 'pre') && 'alpha' || 'latest' }}
# Don't notify linked issues
notify-linked-issues: false
# optional: set this secret in your repo config for publishing to NPM
npm-token: ${{ secrets.NPM_TOKEN }}
build-command: |
npm ci