Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.8 KB

RELEASE.md

File metadata and controls

46 lines (28 loc) · 2.8 KB
Raw

Release Process

This document describes the steps needed to make a release:

On the main branch:

  1. Update the top-level CHANGELOG.md with the commits/PRs since the previous release (the changelogs for the other two packages link there). Ideally at least PRs with breaking changes should already have modified the changelog to list their breaking change.

  2. Update the library version in pubspec.yaml for each supported library:

    • maplibre_gl_platform_interface
    • maplibre_gl_web
    • flutter-maplibre-gl

Version numbering

As long as we are on major version 0 (i.e. version number 0.xx.xx), we increase the minor component (e.g. from 0.16.0 to 0.17.0) for every breaking/significant release.

We may want to make releases where we only increase the patch version (the final digits) for small bug-fix-releases or similar.

Only on the GitHub release branch

  1. After performing the above changes on the main branch (new changelog and versions), create a new git release branch from the main branch, named like git-release-x.y.z.

  2. On that branch:

    a. In flutter-maplibre-gl and maplibre_gl_web in their respective pubspec.yaml file, change the ref value for the maplibre git dependencies from main to git-release-x.y.z (the new git release branch).

    b. In the example app's pubspec.yaml: change the git refs for maplibre_gl_platform_interface and maplibre_gl_platform_interface to the new git release branch and comment out the dependency_overrides. Then the example app will use the packages from this git release branch, instead of their local copies. This way, inter-package dependencies can be tested and users can see how to correctly use the release in their app.

  3. Then, create a GitHub release (x.y.z) with a new git tag (x.y.z) from this git release branch (This can be done from the GitHub web interface).

Only on the pub release branch

  1. After performing the above changes on the git release branch, create a new pub release branch from the git release branch, named like pub-release-x.y.z.

  2. On that branch:

    a. In flutter-maplibre-gl and maplibre_gl_web in their pubspec.yaml files change the maplibre git dependencies to hosted dependencies (regular pub.dev dependencies) with the same version number.

    b. In the example apps's pubspec.yaml file, change the maplibre_gl_platform_interface and maplibre_gl_platform_interface dependencies to use the hosted versions from pub.dev as well.

Publishing order to pub.dev

Then the 3 plugins can be published from this pub release branch in this order (because of the inter-package dependencies):

  1. maplibre_gl_platform_interface
  2. maplibre_gl_web
  3. flutter-maplibre-gl

(For the first two, of course only publish the contents of the relevant subfolder with the same name)