Merge pull request #5 from RalfG/infrastructure-updates

Infrastructure updates

Author: RalfG

.github/workflows/publish.yml

@@ -1,9 +1,8 @@
 name: Publish to PyPI and GitHub release
 
 on:
-  push:
-    tags:
-    - '*'
+  release:
+    types: [created]
 
 jobs:
   publish:
@@ -28,11 +27,3 @@ jobs:
       run: |
         flit build
         twine upload dist/*
-
-    - name: Create GitHub Release
-      uses: docker://antonyurchenko/git-release:v4
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        DRAFT_RELEASE: "false"
-        PRE_RELEASE: "false"
-        CHANGELOG_FILE: "CHANGELOG.md"

.github/workflows/test.yml

@@ -3,59 +3,68 @@ name: Test Python package
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 
 jobs:
   full_test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.8
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flit flake8
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Install with Flit
-      run: flit install
-    - name: Test with pytest
-      run: |
-        pytest --cov=cascade_config tests
-    - name: Uploade coverage reports to Codecov
-      uses: codecov/codecov-action@v3
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flit flake8
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+      - name: Install with Flit
+        run: flit install
+
+      - name: Test with pytest
+        run: |
+          pytest --cov=cascade_config tests
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
 
   test_platforms:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
     steps:
       - uses: actions/checkout@v2
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install flit flake8
+
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors or undefined names
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+
       - name: Install project
         run: flit install
+
       - name: Test with pytest
         run: |
           pytest

.readthedocs.yml

@@ -0,0 +1,11 @@
+version: 2
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+sphinx:
+  builder: dirhtml

CHANGELOG.md

@@ -1,19 +1,35 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.1] - 03/07/2023
+
+### Fixed
+
+- Fix previous broken build (did not include changes)
+
 ## [0.3.0] - 15/11/2021
+
+### Fixed
+
 - Fix parsing of empty dictionaries and `False` configuration values. These would
   previously be overridden by the downstream configuration.
 
 ## [0.2.0] - 28/09/2021
+
+### Added
+
 - Add none_overrides_value option. Before this change, None values would unexpectedly
   override previously configured values. Now, the previous value will be retained if
   newer values are None. The old behavior can be re-enabled with by setting the
   none_overrides_value argument of CascadeConfig to True.
 
 ## [0.1.0-a0] - 03/08/2020
+
+### Added
+
 - Initial release

CONTRIBUTING.md

@@ -12,44 +12,36 @@ you are welcome to communicate it with the community by creating an issue in
 ## How to contribute
 
 - Fork [cascade-config](https://github.com/ralfg/cascade-config) on GitHub to
-make your changes.
+  make your changes.
 - Commit and push your changes to your
-[fork](https://help.github.com/articles/pushing-to-a-remote/).
+  [fork](https://help.github.com/articles/pushing-to-a-remote/).
 - Open a
-[pull request](https://help.github.com/articles/creating-a-pull-request/)
-with these changes. You pull request message ideally should include:
-   - A description of why the changes should be made.
-   - A description of the implementation of the changes.
-   - A description of how to test the changes.
+  [pull request](https://help.github.com/articles/creating-a-pull-request/)
+  with these changes. You pull request message ideally should include:
+  - A description of why the changes should be made.
+  - A description of the implementation of the changes.
+  - A description of how to test the changes.
 - The pull request should pass all the continuous integration tests which are
   automatically run by
   [GitHub Actions](https://github.com/ralfg/cascade-config/actions).
 
-
 ## Development setup
 
 1. Setup Python 3 and [Flit](https://flit.readthedocs.io/en/latest/)
 2. Clone the [cascade-config repository](https://github.com/ralfg/cascade-config) and
    run `flit install` to setup an editable version of cascade-config.
 
-
 ## Development workflow
 
 - When a new version is ready to be published:
 
-    1. Change the `__version__` in `cascade_config.py` following
-    [semantic versioning](https://semver.org/).
-    2. Update the documentation (`README.md` and `docs/source/usage.rst`) if required.
-    3. Update the changelog (if not already done) in `CHANGELOG.md` according to
-    [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
-    4. Commit all final changes to the `master` branch.
-    4. On `master`, set a new tag with the version number, e.g. `git tag v0.1.5`.
-    5. Push to GitHub, with the tag: `git push; git push --tags`.
-
-- When a new tag is pushed to (or made on) GitHub that matches `v*`, the
-following GitHub Actions are triggered:
-
-    1. The Python package is build and published to PyPI.
-    2. Using the [Git Release](https://github.com/marketplace/actions/git-release)
-    action, a new GitHub release is made with the changes that are listed in
-    `CHANGELOG.md`.
+  1. Change the `__version__` in `cascade_config.py` following
+     [semantic versioning](https://semver.org/).
+  2. Update the documentation (`README.md` and `docs/source/usage.rst`) if required.
+  3. Update the changelog (if not already done) in `CHANGELOG.md` according to
+     [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+  4. Merge all final changes into the `main` branch.
+  5. Create a new GitHub release.
+
+- When a new GitHub release is created, the publish GitHub Action is triggered,
+  building the Python package is build and publishes it to PyPI.

cascade_config.py

@@ -1,6 +1,6 @@
 """Cascading configuration from the CLI and config files."""
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 
 import json
 import os
@@ -55,22 +55,25 @@ def _update_dict_recursively(self, original: Dict, updater: Dict) -> Dict:
         """Update dictionary recursively."""
         for k, v in updater.items():
             if isinstance(v, dict):
-                if not v: # v is not None, v is empty dictionary
+                if not v:  # v is not None, v is empty dictionary
                     original[k] = dict()
                 else:
                     original[k] = self._update_dict_recursively(original.get(k, {}), v)
             elif isinstance(v, bool):
                 original[k] = v  # v is True or False
             elif v or k not in original:  # v is not None, or key does not exist yet
                 original[k] = v
-            elif self.none_overrides_value:  # v is None, but can override previous value
+            elif (
+                self.none_overrides_value
+            ):  # v is None, but can override previous value
                 original[k] = v
         return original
 
     def add_dict(self, *args, **kwargs):
         """
         Add dictionary configuration source to source list.
-        *args and **kwargs are passed to :class:`cascade_config.DictConfigSource()`.
+
+        ``*args`` and ``**kwargs`` are passed to :class:`cascade_config.DictConfigSource()`.
 
         """
         source = DictConfigSource(*args, **kwargs)
@@ -79,7 +82,9 @@ def add_dict(self, *args, **kwargs):
     def add_argumentparser(self, *args, **kwargs):
         """
         Add argumentparser configuration source to source list.
-        *args and **kwargs are passed to :class:`cascade_config.ArgumentParserConfigSource()`.
+
+        ``*args`` and ``**kwargs`` are passed to
+        :class:`cascade_config.ArgumentParserConfigSource()`.
 
         """
         source = ArgumentParserConfigSource(*args, **kwargs)
@@ -88,15 +93,19 @@ def add_argumentparser(self, *args, **kwargs):
     def add_namespace(self, *args, **kwargs):
         """
         Add argparse Namespace configuration source to source list.
-        *args and **kwargs are passed to :class:`cascade_config.NamespaceConfigSource()`.
+
+        ``*args`` and ``**kwargs`` are passed to
+        :class:`cascade_config.NamespaceConfigSource()`.
         """
         source = NamespaceConfigSource(*args, **kwargs)
         self.sources.append(source)
 
     def add_json(self, *args, **kwargs):
         """
         Add JSON configuration source to source list.
-        *args and **kwargs are passed to :class:`cascade_config.JSONConfigSource()`.
+
+        ``*args`` and ``**kwargs`` are passed to
+        :class:`cascade_config.JSONConfigSource()`.
         """
         source = JSONConfigSource(*args, **kwargs)
         self.sources.append(source)