Using GitHub actions to release plugins

death.au · November 12, 2020, 6:51am

Building on this base I’ve created my own version.
It doesn’t require you to update your plugin name, as it just uses the name of the repo to create the zip file (I want to do as little work as possible ).
I eventually want to update it to somehow grab release notes and put them in the release. Still thinking about how I want to manage that…

github.com

deathau/workflow-experiments/blob/main/.github/workflows/release.yml

name: Release Obsidian Plugin
on:
  push:
    # Sequence of patterns matched against refs/tags
    tags:
    - '*' # Push events to matching any tag format, i.e. 1.0, 20.15.10
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
    - name: Use Node.js
      uses: actions/setup-node@v1
      with:
        node-version: '14.x' # You might need to adjust this value to your own version
    # Get the version number and put it in a variable
    - name: Get Version
      id: version

This file has been truncated. show original

I’ve also created a second script that you can trigger manually within the github interface to bump the version number (major, minor or patch — you decide) and push the updates to the manifest file and create the git tag for you, which will then trigger the release workflow.

There are two catches:

You have to provide a Personal Access Token in a GitHub Secret called PAT — this is so the push will trigger the second workflow. It doesn’t get triggered when you use secrets.GITHUB_TOKEN
You should probably provide an .npmrc file in the root of your repo which has tag-version-prefix = "" to get rid of the v from the start of the version number
(I do want to get rid of this requirement now I have half an idea what I’m doing. I shouldn’t need to rely on NPM to do the bumping for me)

github.com

deathau/workflow-experiments/blob/main/.github/workflows/version.yml

name: Bump Version
on:
  workflow_dispatch:
    inputs:
      type:
        description: 'Type of version (`major`, `minor`, `patch`)'
        required: true
        default: 'patch'
jobs:
  bump:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
        token: ${{secrets.PAT}} # use a personal acces token so that other actions can trigger
    - name: Use Node.js
      uses: actions/setup-node@v1
      with:

This file has been truncated. show original