QGIS Plugin CI - Documentation

Description: Let qgis-plugin-ci package and release your QGIS plugins for you. Have a tea or go hiking meanwhile. Contains scripts to perform automated testing and deployment for QGIS plugins. These scripts are written for and tested on GitHub Actions, GitLab CI, Travis-CI, and Transifex.
Author and contributors: Denis Rouzaud, Etienne Trimaille, Julien Moura
Version: 2.8.10
Source code: https://opengisch.github.io/qgis-plugin-ci/
Last documentation build: 02 December 2024

Installation

Package is available on PyPi:

pip install qgis-plugin-ci

Configuration

• Configuration
• Plugin source path
• Exclude files in the plugin archive
• Handle submodules SSH
• Using Transifex to translate your plugin

Use the CLI

• Changelog (CLI)
• Package
• Release
• Commands related to the translation

Use in CI/CD platforms

• GitHub workflows
• GitLab CI
• Docker
• TravisCI

Miscellaneous

• Credits
• Frequently Asked Questions

Contribution guide

• Code documentation
• Contributing Guidelines
• Development
• Documentation
• Tests
• CHANGELOG

---

Plugins published using qgis-plugin-ci

Render GeoJSON (server)

• deployment on GitHub Releases and plugin repository

• works on GitHub workflows

• barebone implementation, no bells and whistles

https://github.com/opengisch/qgis_server_render_geojson/

Lizmap

• using a setup.cfg file

• metadata populated automatically from CHANGELOG.md file

• GitHub release created automatically from Travis

• released on official repository

• translations are committed from Travis to the repository after the release process

• GitLab-CI with Docker is used as well

https://github.com/3liz/lizmap-plugin/

GeoMapFish Locator

• translated on Transifex

• released on official repo

https://github.com/opengisch/qgis_geomapfish_locator/

VeriVD

• released on custom repo as GitHub release

https://github.com/VeriVD/qgis_VeriVD/

pgMetadata

• Released using GitHub Actions and Transifex

https://github.com/3liz/qgis-pgmetadata-plugin/

QTribu

• GitHub Actions

• using a setup.cfg file

• Used to on custom plugins repository as GitHub release

https://github.com/geotribu/qtribu/

Land Survey Codes Import

• Release using GitLab CI

• Local translations

• using a setup.cfg file

https://gitlab.com/Oslandia/qgis/landsurveycodesimport/

French Locator Filter

• Release using GitLab CI

• Local translations (no transifex)

• Configured using a setup.cfg file

• Both deployed on custom repository on GitLab Pages (on master) on official repository (on git tag)

https://gitlab.com/Oslandia/qgis/french_locator_filter/

Thyrsis

• Packaged and release using GitLab CI

• Embed some built external dependencies

• Local translations (no transifex)

• Configured using a setup.cfg file

• Both deployed on custom repository on GitLab Pages (on master) on official repository (on git tag)

https://gitlab.com/Oslandia/qgis/thyrsis/