Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add(packaging): add QGIS plugin CI necessary tools #20

Merged
merged 1 commit into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# CHANGELOG

The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/).

<!--

Unreleased

## version_tag - YYYY-DD-mm

### Added

### Changed

### Removed

-->

## Version 0.5.0-beta1 - 2024-10-04

- add modern plugin's packaging using QGIS Plugin CI
- apply Python coding rules to whole codebase (PEP8)
- remove dead code
- add Git hooks and quality tooling
- ships the big refactoring started in 2023

## Version 0.4 - 2023-06-29

- Fairly big refactoring and cleanup
- Better and more verbose error handling
- Improve performance
- Reduce backup size, change backup directory
- Improve dialogs and messages
- Add support for Vector Tiles connections
- Fix a crash (thanks Ivano Giuliano!)

## Version 0.31 - 2022-07-31

- Update metadata

## Version 0.3 - 2022-07-13

- Fix scanning for bookmarks, favourites, exp functions, styles

## Version 0.21 - 2022-01-18

- Add support for BSD and other Unixes (thanks Loïc Bartoletti!)
- Add Italy - German translation (thanks Salvatore Fiandaca!)

## Version 0.2 - 2022-01-12

- First public release
32 changes: 32 additions & 0 deletions docs/development/packaging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Packaging and deployment

## Packaging

This plugin is using the [qgis-plugin-ci](https://github.com/opengisch/qgis-plugin-ci/) tool to perform packaging operations.
The package command is performing a `git archive` run based on changelog.

Install additional dependencies:

```sh
python -m pip install -U -r requirements/packaging.txt
```

```sh
# package a specific version
qgis-plugin-ci package 1.3.1
# package latest version
qgis-plugin-ci package latest
```

## Release a version

Everything is done through the continuous deployment:

1. Add the new version to the `CHANGELOG.md`. You can write it manually or use the auto-generated release notes by Github:
1. Go to [project's releases](https://github.com/WhereGroup/profile-manager/releases) and click on `Draft a new release`
1. In `Choose a tag`, enter the new tag
1. Click on `Generate release notes`
1. Copy/paste the generated text from `## What's changed` until the line before `**Full changelog**:...` in the CHANGELOG.md replacing `What's changed` with the tag and the publication date
1. Change the version number in `metadata.txt`
1. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m "This version rocks!"`
1. Push tag to main branch: `git push origin 0.3.0`
4 changes: 4 additions & 0 deletions requirements/packaging.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Packaging
# ---------

qgis-plugin-ci==2.8.*