Add QGIS plugin publish workflow - #12
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an automated publishing pipeline for this QGIS plugin template, enabling GitHub Releases (and manual dispatch) to build a distributable zip, validate its version, attach the artifact to the release, and upload it to the official QGIS plugin repository.
Changes:
- Added a GitHub Actions
Publishworkflow triggered byrelease.publishedandworkflow_dispatch. - Implemented a standalone XML-RPC upload helper script for
plugins.qgis.org. - Added version validation to ensure
metadata.txtmatches the release tag before publishing.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
scripts/upload_to_qgis_plugin_repo.py |
New XML-RPC uploader for publishing the built plugin zip to plugins.qgis.org. |
.github/workflows/publish.yml |
New release/manual workflow to build the zip, verify version vs tag, attach to release, and upload to QGIS plugin repo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+25
to
+33
| steps: | ||
| - uses: actions/checkout@v6 | ||
|
|
||
| - uses: actions/setup-python@v6 | ||
| with: | ||
| python-version: "3.13" | ||
|
|
||
| - name: Build plugin zip | ||
| run: python "package_plugin.py" --source "$PLUGIN_DIR" --name "$PLUGIN_NAME" --output "$ZIP_PATH" |
Comment on lines
+31
to
+37
| endpoint = REPO_URL_TEMPLATE.format( | ||
| user=quote(username, safe=""), | ||
| password=quote(password, safe=""), | ||
| ) | ||
| server = ServerProxy(endpoint, verbose=False) | ||
| plugin_id, version_id = server.plugin.upload(payload) | ||
| return plugin_id, version_id |
Comment on lines
+58
to
+67
| try: | ||
| plugin_id, version_id = upload(args.zip_path, username, password) | ||
| except Fault as exc: | ||
| print( | ||
| f"Upload failed: {exc.faultString} (code {exc.faultCode})", file=sys.stderr | ||
| ) | ||
| return 1 | ||
| except ProtocolError as exc: | ||
| print(f"Upload failed: HTTP {exc.errcode} {exc.errmsg}", file=sys.stderr) | ||
| return 1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
metadata.txtand__init__.pyunder the expected plugin root.