Skip to content

How to: Make a release

Vicky Vergara edited this page Dec 12, 2020 · 5 revisions

Process description of how to release pgRoutingLayer

This example process use v3.0.0

Verify that master & update to latest changes

git checkout master
git pull
git status

Verify the version to be released

git grep version metadata.txt

Verify any other issue you see fit

  • README.md is OK?

Publish plugin on QGIS plugins

  • Login into: https://plugins.qgis.org/
  • Search for: pgRoutingLayer
  • Click on: pgRoutingLayer
  • manage -> add
  • Browse: pgRoutingLayer.zip file created locally
  • The other fields can be left blank
  • Save The Plugin Version has been successfully created. You do not have approval permissions, plugin version has been set unapproved.
  • We wait a day or two for approval from QGIS team

This publishing will detect errors If an error shows, fix and publish the plugin Once it is published, then push the changes to master (maybe needs to be done with a PR) Continue with the next steps

Create the annotated signed tag

tagging basics git tag

git tag -a v3.0.0 -s -m 'Release 3.0.0'

Be careful before pushing a tag

  • do any double check you see fit before the push
git show v3.0.0

If everything is OK then push the tag

git push origin --tag v3.0.0

The tag will be created on

https://github.com/pgRouting/pgRoutingLayer/releases/tag/v3.0.0

Create the zip file for uploading to QGIS Plugins repo

install pip

pb_tool zip

Note: maybe pb_tool.cfg needs some change on plugin_path field currently it does not support -p flag like the deploy

At the end it will show

The pgRoutingLayer.zip archive has been created in the current directory

Edit the tag on github

Open: https://github.com/pgRouting/pgRoutingLayer/releases/tag/v3.0.0 Click on edit

  • title: v3.0.0
    • Same as tag
  • Write: Include what has being fixed/improved/added for the version
  • Attach Binaries: pgRoutingLayer.zip

Note -rc, -beta, -alpha, should be marked with This is a pre-release

click on: Publish Release

Let people Know

  • once its approved, inform on
    • pgrouting_dev pgrouting_user lists
    • tweeter
    • what ever social media