Merge pull request #91 from openscm/changelog

Update copier template

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v0.4.1
+_commit: v0.5.0
 _src_path: /Users/znicholls/Documents/repos/copier-core-python-repository
 email: zebedee.nicholls@climate-energy-college.org
 initial_setup: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,8 +2,9 @@
 name: Feature Request
 about: Request a feature or suggest an idea for this project
 title: ''
-labels: feature-request
+labels: feature
 assignees: ''
+
 ---
 
 ## The motivation

.github/actions/setup/action.yml

@@ -40,10 +40,10 @@ runs:
       shell: bash
       run: |
         # This line used to be needed, but seems to have been
-        # sorted with newer poetry versions. The check is whether
-        # the right version of python is shown below after running
-        # `poetry run which python` and whether the right version
-        # of python is used in the tests
+        # sorted with newer poetry versions. We can still check whether
+        # the right version of python is used by looking at the output of
+        # `poetry run which python` below and whether the right version
+        # of python is used in the tests (or whatever step is being done)
         # poetry env use "python${{ inputs.python-version }}"
         poetry config virtualenvs.create true
         poetry config virtualenvs.in-project true
@@ -54,6 +54,7 @@ runs:
         poetry install --no-interaction --no-root ${{ inputs.poetry-dependency-install-flags }}
     # Now run same command but let the package install too
     - name: Install package
+      # To ensure that the package is always installed, this step is run even if the cache was hit
       if: ${{ inputs.run-poetry-install == 'true' }}
       shell: bash
       run: |

.github/workflows/bump.yaml

@@ -47,14 +47,21 @@ jobs:
       - name: Create bump and changelog
 
         run: |
-          BASE_VERSION=`poetry version -s`
-          NEW_VERSION=`poetry version -s ${{ github.event.inputs.bump_rule }}`
-          poetry run towncrier build --yes --version v$NEW_VERSION
-
           git config --global user.name "$GITHUB_ACTOR"
           git config --global user.email "$CI_COMMIT_EMAIL"
 
+          # Bump
+          BASE_VERSION=`poetry version -s`
+          NEW_VERSION=`poetry version -s ${{ github.event.inputs.bump_rule }}`
+          echo "Bumping version $BASE_VERSION > $NEW_VERSION"
+          poetry run towncrier build --yes --version v$NEW_VERSION
           git commit -a -m "bump: version $BASE_VERSION -> $NEW_VERSION"
           git tag v$NEW_VERSION
+
+          # Bump to alpha (so that future commits do not have the same
+          # version as the tagged commit)
+          BASE_VERSION=`poetry version -s`
+          NEW_VERSION=`poetry version -s prerelease`
+          echo "Bumping version $BASE_VERSION > $NEW_VERSION"
+          git commit -a -m "bump(pre-release): version $BASE_VERSION > $NEW_VERSION"
           git push && git push --tags
-          echo "Bumped to version $NEW_VERSION"

.github/workflows/ci.yaml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/checkout@v3
       - uses: ./.github/actions/setup
         with:
-          os: ubuntu-latest
+          os: "ubuntu-latest"
           python-version: "3.9"
           venv-id: "docs"
           poetry-dependency-install-flags: "--all-extras --only 'main,dev'"
@@ -31,7 +31,7 @@ jobs:
         uses: actions/checkout@v3
       - uses: ./.github/actions/setup
         with:
-          os: ubuntu-latest
+          os: "ubuntu-latest"
           python-version: "3.9"
           venv-id: "docs"
           poetry-dependency-install-flags: "--all-extras --only 'main,docs'"
@@ -52,7 +52,10 @@ jobs:
     runs-on: "${{ matrix.os }}"
     defaults:
       run:
-        shell: bash  # Need this for windows to not explode apparently
+        # This might be needed for Windows and doesn't seem to affect unix-based systems
+        # so we include it. If you have better proof of whether this is needed or not,
+        # feel free to update.
+        shell: bash
     steps:
       - name: Check out repository
         uses: actions/checkout@v3

.gitignore

@@ -1,3 +1,6 @@
+# ruff
+.ruff_cache
+
 # Notebooks
 *.ipynb
 

Makefile

@@ -18,6 +18,7 @@ endef
 export PRINT_HELP_PYSCRIPT
 
 
+.PHONY: help
 help:  ## print short description of each target
 	@python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 

changelog/89.breaking.md

@@ -0,0 +1,3 @@
+Updated to CICERO-SCM v1.1.1
+
+This also removes the pin on Pandas when installing CICERO-SCM's python port

changelog/91.trivial.md

@@ -0,0 +1,3 @@
+Updated to use v0.5.0 of the copier template
+
+This fixes up the docs theme and some other workflow bits and pieces.

docs/source/conf.py

@@ -143,8 +143,16 @@ def _generate_module_rst_new(*args, **kwargs):
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 # Pick your theme for html output, we typically use the read the docs theme
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
 html_static_path = ["_static"]
+html_theme_options = {
+    "repository_url": "https://github.com/openscm/openscm-runner",
+    "repository_branch": "main",
+    "path_to_docs": "docs/source",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+}
 
 
 # Ignore ipynb files when building (see https://github.com/executablebooks/MyST-NB/issues/363).

docs/source/development.md

@@ -2,6 +2,34 @@
 # Development
 
 Notes for developers. If you want to get involved, please do!
+We welcome all kinds of contributions, for example:
+
+- docs fixes/clarifications
+- bug reports
+- bug fixes
+- feature requests
+- pull requests
+- tutorials
+
+## Workflows
+
+<!---
+This section is auto-generated by the copier template
+and the text below is just a placeholder to get you started.
+The workflows section will likely need to be updated
+to be project specific as the project's norms are established.
+-->
+
+We don't mind whether you use a branching or forking workflow.
+However, please only push to your own branches,
+pushing to other people's branches is often a recipe for disaster,
+is never required in our experience
+so is best avoided.
+
+Try and keep your merge requests as small as possible
+(focus on one thing if you can).
+This makes life much easier for reviewers
+which allows contributions to be accepted at a faster rate.
 
 ## Language