Release automation

[petr-pokorny-1]

GitHub workflow for releasing new versions

The logic is split in two jobs

• First jobs perform tests. It runs on Windows runner since Linux runners don't have GPU, which is required by many tests.
• Second job runs on Linux and creates builds minified library, creates github release, uploads release assets, updates version in npm package and submits package in the npm registry.

Workflow Description

The workflow is triggered when a tag is pushed or It can also be triggered manually.
After the workflow starts it searches for the most recent version tag (that is a tag with v*.*.* format) and uses the version from this tag for the next processing. The version must follow semantic versioning rules.

There can be regular version (i.e. 1.13.0) or pre-release (i.e. 1.13.0-rc.1).

In case of regular version the action parses CHANGELOG.md and creates release notes based on current and last version. Release notes are not generated for pre-release versions. In case of pre-release versions the github release is marked as pre-release accordingly.

The changelog should be updated on every PR - there is a placeholder at the top of the document - and heading should be renamed to the same version which is going to be set in the version tag during release.

Workflow Setup

The workflow expects there is NODE_AUTH_TOKEN secret in the repo settings which is used for pushing to npm registry.

There are no tags in the maplibre-gl-js repo currently. Initial tags can be setup as follows:

git tag -a v1.13.0 f87090b -m "version 1.13.0"                                                
git tag -a v1.13.1 -m "version 1.13.1"                                                        
git push --tags 

[github-actions]

Bundle size report:

Size Change: 0 B
Total Size Before: 201 kB
Total Size After: 201 kB

Output file	Before	After	Change
maplibre-gl.js	196 kB	196 kB	0 B
maplibre-gl.css	4.62 kB	4.62 kB	0 B

ℹ️ View Details

No major changes

[nyurik]

looks awesome, thanks! A few minor things:

• there is a number of linting issues, as shown in the files changed tab
• I think we should validate the tag for consistency, e.g. verify that it starts with a v, and that the number is valid, and that the changelog has a section dedicated to that version (the changelog would have the same version but without v?). The changelog requirement might be different for beta/rc releases (TBD).

[petr-pokorny-1]

I think we should validate the tag for consistency, e.g. verify that it starts with a v, and that the number is valid

This should be addressed here

maplibre-gl-js/build/version-utils.js

Line 57 in 6c315b3

case 'validate-latest-tag':

The tag format should be ensured by regular expressions. One more validation there checks if the new version tag is greater than the previous one (using semver library)

and that the changelog has a section dedicated to that version (the changelog would have the same version but without v?).

The test is here:

maplibre-gl-js/build/release-notes.js

Line 54 in 6c315b3

if (!currentReleaseNotes) {

The explanation how the relevant parts of changelog is matched is here:

maplibre-gl-js/build/release-notes.js

Line 26 in 6c315b3

/*

(this is original code from Mapbox)

The changelog requirement might be different for beta/rc releases (TBD).

The workflow has one variant for beta/rc releases and second for regular releases. For beta/rc releases, no release notes are produced. I would suggest to come up with solution for beta release notes in another PR if they are needed.

[nyurik]

a few more minor suggestions - I think it is better to rely on semver library for all parsing/testing, than to use regex - except to test that the semver begins with a v -- because semver automatically removes it. tags.map(v => v.trim()).filter(v => /^v\d/.test(v)).map(v => semver.validate(v)).filter(v => v) should work (or something similar).

Agree with your point about beta/release notes.

[klokan]

NODE_AUTH_TOKEN token is configured now.

[klokan]

Please no beta / rc and other pre-releases. Just semver - and increments - as soon as the release process is fixed.

[nyurik]

@klokan any reason not to automate publishing to NPM for rc/beta versions?