Merge pull request #1005 from rwaffen/release-5.2.0

Release 5.2.0

CHANGELOG.md

@@ -2,6 +2,50 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v5.2.0](https://github.com/voxpupuli/puppetboard/tree/v5.2.0) (2024-01-17)
+
+[Full Changelog](https://github.com/voxpupuli/puppetboard/compare/v5.1.0...v5.2.0)
+
+**Implemented enhancements:**
+
+- Update README for SECRET\_KEY and SSL Setup [\#985](https://github.com/voxpupuli/puppetboard/pull/985) ([tuxmea](https://github.com/tuxmea))
+
+**Fixed bugs:**
+
+- Offline mode tries to load external resources [\#988](https://github.com/voxpupuli/puppetboard/issues/988)
+- Facts only showing RedHat [\#961](https://github.com/voxpupuli/puppetboard/issues/961)
+
+**Closed issues:**
+
+- Make it More Apparent that SECRET\_KEY cannot be blank [\#978](https://github.com/voxpupuli/puppetboard/issues/978)
+
+**Merged pull requests:**
+
+- also push to hub.docker.com [\#1004](https://github.com/voxpupuli/puppetboard/pull/1004) ([rwaffen](https://github.com/rwaffen))
+- Bump coverage from 7.3.2 to 7.3.3 [\#993](https://github.com/voxpupuli/puppetboard/pull/993) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pylint from 3.0.2 to 3.0.3 [\#992](https://github.com/voxpupuli/puppetboard/pull/992) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump bandit from 1.7.5 to 1.7.6 [\#991](https://github.com/voxpupuli/puppetboard/pull/991) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump typing-extensions from 4.8.0 to 4.9.0 [\#990](https://github.com/voxpupuli/puppetboard/pull/990) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump idna from 3.4 to 3.6 [\#987](https://github.com/voxpupuli/puppetboard/pull/987) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump certifi from 2023.7.22 to 2023.11.17 [\#986](https://github.com/voxpupuli/puppetboard/pull/986) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump types-setuptools from 68.2.0.0 to 69.0.0.0 [\#984](https://github.com/voxpupuli/puppetboard/pull/984) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump mypy from 1.6.1 to 1.7.1 [\#981](https://github.com/voxpupuli/puppetboard/pull/981) ([dependabot[bot]](https://github.com/apps/dependabot))
+- README: note that `SECRET_KEY` can't be empty [\#979](https://github.com/voxpupuli/puppetboard/pull/979) ([kenyon](https://github.com/kenyon))
+- Bump urllib3 from 2.0.7 to 2.1.0 [\#977](https://github.com/voxpupuli/puppetboard/pull/977) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump flask-apscheduler from 1.13.0 to 1.13.1 [\#974](https://github.com/voxpupuli/puppetboard/pull/974) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump wtforms from 3.1.0 to 3.1.1 [\#973](https://github.com/voxpupuli/puppetboard/pull/973) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump charset-normalizer from 3.3.1 to 3.3.2 [\#972](https://github.com/voxpupuli/puppetboard/pull/972) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pytest from 7.4.2 to 7.4.3 [\#971](https://github.com/voxpupuli/puppetboard/pull/971) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump werkzeug from 3.0.0 to 3.0.1 [\#970](https://github.com/voxpupuli/puppetboard/pull/970) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pylint from 3.0.1 to 3.0.2 [\#968](https://github.com/voxpupuli/puppetboard/pull/968) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump charset-normalizer from 3.3.0 to 3.3.1 [\#967](https://github.com/voxpupuli/puppetboard/pull/967) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pytest-mock from 3.11.1 to 3.12.0 [\#966](https://github.com/voxpupuli/puppetboard/pull/966) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add link to C3.js documentation [\#965](https://github.com/voxpupuli/puppetboard/pull/965) ([mpesari](https://github.com/mpesari))
+- Bump mypy from 1.6.0 to 1.6.1 [\#964](https://github.com/voxpupuli/puppetboard/pull/964) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump urllib3 from 2.0.6 to 2.0.7 [\#962](https://github.com/voxpupuli/puppetboard/pull/962) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump mypy from 1.5.1 to 1.6.0 [\#958](https://github.com/voxpupuli/puppetboard/pull/958) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump wtforms from 3.0.1 to 3.1.0 [\#957](https://github.com/voxpupuli/puppetboard/pull/957) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v5.1.0](https://github.com/voxpupuli/puppetboard/tree/v5.1.0) (2023-10-08)
 
 [Full Changelog](https://github.com/voxpupuli/puppetboard/compare/v5.0.0...v5.1.0)

README.md

@@ -265,7 +265,7 @@ Other settings that might be interesting, in no particular order:
     to `False` gives performance benefits, especially in big Puppet environments (more than few hundreds of nodes).
     Defaults to `True`.
 - `ENABLE_CLASS`: If set to `True` allows the user to view the number of resource events (number of changed resources in the last report) grouped by class.
-    The resource events are grouped by their status ('failure', 'success', 'noop'). 
+    The resource events are grouped by their status ('failure', 'success', 'noop').
 - `CLASS_EVENTS_STATUS_COLUMNS`: A mapping between the status of the resource events and the name of the columns of the table to display.
 - `CACHE_TYPE`: Specifies which type of caching object to use when `SCHEDULER_ENABLED` is set to `True`.
     The cache is used for the classes view (`ENABLE_CLASS` is set to `True`) which requires parsing the events of all the latest reports to group them by Puppet class.
@@ -276,7 +276,7 @@ Other settings that might be interesting, in no particular order:
 - `CACHE_DEFAULT_TIMEOUT`: Cache lifetime in second. Defaults to `3600`.
 - `SCHEDULER_ENABLED`: If set to `True` then a scheduler instance is created in order to execute scheduled jobs. Defaults to `False`.
 - `SCHEDULER_JOBS`: List of the scheduled jobs to trigger within a worker.
-    A job can for example be used to compute a result to be cached. This is the case for the classes view which uses a job to pre-compute at regular intervals the results to be displayed. 
+    A job can for example be used to compute a result to be cached. This is the case for the classes view which uses a job to pre-compute at regular intervals the results to be displayed.
     Each scheduled job must contain the following fields: `id`, `func`, `trigger`, `seconds`.
 - `SCHEDULER_LOCK_BIND_PORT`: Specifies an available port that allows a single worker to listen on it.
     This allows to configure scheduled jobs in a single worker. Defaults to `49100`.
@@ -360,6 +360,10 @@ The preferred format of a commit message:
 If you'd like a more elaborate guide on how to write and format your commit messages have a look at [this post
 by Tim Pope](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 
+### Build a release
+
+please see: [RELEASE.md](RELEASE.md)
+
 ## More Screenshots<a id="more-screenshots"></a>
 
 * Overview / Index / Homepage
@@ -410,7 +414,7 @@ by Tim Pope](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.ht
 
 ![Inventory view](https://raw.githubusercontent.com/voxpupuli/puppetboard/master/screenshots/inventory.png)
 
-* Classes view, group the resource events of the last reports by Puppet class 
+* Classes view, group the resource events of the last reports by Puppet class
 
 ![Classes view](https://raw.githubusercontent.com/voxpupuli/puppetboard/master/screenshots/classes.png)
 

RELEASE.md

@@ -0,0 +1,29 @@
+# How to release
+
+## On a fork do
+
+```shell
+git switch -c release-x.y.z
+```
+
+Edit [version.py](puppetboard/version.py) and set future version.
+
+```shell
+bundle config set --local path .vendor
+bundle config set --local with 'release'
+bundle install
+
+CHANGELOG_GITHUB_TOKEN="token_MC_token-face" bundle exec rake changelog
+git add -A
+git commit -m 'Release X.Y.Z'
+git push origin releae-x.y.z
+```
+
+## as a maintainer on upstream do
+
+```shell
+git switch master
+git pull
+git tag $version
+git push --tags
+```

puppetboard/version.py

@@ -2,4 +2,4 @@
 # Puppetboard version module
 #
 
-__version__ = '5.1.0'
+__version__ = '5.2.0'