minor updates to docs and workflows

.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,7 +3,7 @@ name: "Feature request"
 about: Suggest an idea for this project
 title: "[New Feature]: "
 labels: enhancement, needs triage
-assignees: ''
+assignees: 'sosey'
 ---
 
 ## Is your feature request related to a problem? Please describe.

.github/workflows/dependabot.yml → .github/dependabot.yml

@@ -7,7 +7,7 @@ updates:
   directory: "/"
   target-branch: "main"
   schedule:
-    interval: weekly
+    interval: monthly
   open-pull-requests-limit: 10
   reviewers:
     - "Roman-Supernova-PIT/software-admins"
@@ -16,14 +16,22 @@ updates:
     - dependency-type: indirect
   commit-message:
     prefix: "fix: "
+  labels:
+    - "CI/CD"
 
 # maintain dependencies for github-actions
 - package-ecosystem: "github-actions"
-  directory: "/"
+  directory: ".github/workflows"
   target-branch: "main"
   reviewers:
-    - "sosey"
+    - "Roman-Supernova-PIT/software-admins"
   schedule:
-    interval: weekly
+    interval: monthly
   commit-message:
-    prefix: "fix: "
+    prefix: "fix: "
+  labels:
+    - "CI/CD"
+  groups:
+    actions:
+      patterns:
+        - "*"

.github/workflows/sphinx-deploy.yml

@@ -1,22 +1,27 @@
-name: "Deploy Sphinx Package Documentation to Pages"
+name: "Deploy Package Documentation to Pages"
 
 on:
   push:
-    branches: [gh-pages] # branch to trigger deployment
+    branches: [main] # branch to trigger deployment
 
   workflow_dispatch:
 
 jobs:
   pages:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     permissions:
       contents: write
     steps:
     - id: deployment
-      uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892 # v3.1
+      uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892  # v3.1
       with:
         publish: false
-    - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e #v4.0.0
+        documentation_path: ./docs
+        pyproject_extras: docs
+    - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e  # v4.0.0
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ${{ steps.deployment.outputs.artifact }}
+        publish_dir: ${{ steps.deployment.outputs.artifact }} 
+        publish_branch: gh-pages  # default: gh-pages
+        commit_message: ${{ github.event.head_commit.message }}
+

README.rst

@@ -39,5 +39,5 @@ The goal of the template is to quickly get you setup with the files described in
 The template currently implements the following optional flags, all of which default to off:
 
 * ``include_example_code``: This option will fill your new package with some example functions to allow you to test it.
-* ``use_compiled_extensions``: This turns on the features needed to support compiled extensions as described in :ref:`extensions`.
-* ``enable_dynamic_dev_versions``: This enables a feature which ensures that ``my_package.__version__`` always returns the current git version as calculated by ``setuptools_scm`` when the package is installed as an editable install. See :ref:`dev-versions` for more details.
+* ``use_compiled_extensions``: This turns on the features needed to support compiled extensions
+* ``enable_dynamic_dev_versions``: This enables a feature which ensures that ``my_package.__version__`` always returns the current git version as calculated by ``setuptools_scm`` when the package is installed as an editable install. 

{{ cookiecutter.package_name }}/.github/workflows/dependabot.yml → {{ cookiecutter.package_name }}/.github/dependabot.yml

@@ -1,28 +1,38 @@
+name: "Dependabot Checks"
 version: 2
 updates:
 
 # maintain dependencies for pip
+# this should help with pyproject.toml
 - package-ecosystem: pip
   directory: "/"
   target-branch: "main"
   schedule:
     interval: weekly
   open-pull-requests-limit: 10
   reviewers:
-    - "sosey"
+    - "{{ cookiecutter.github_username }}"
   allow:
     - dependency-type: direct
     - dependency-type: indirect
   commit-message:
     prefix: "fix: "
+  labels:
+    - "CI/CD"
 
 # maintain dependencies for github-actions
 - package-ecosystem: "github-actions"
-  directory: "/"
+  directory: ".github/workflows"
   target-branch: "main"
   reviewers:
-    - "sosey"
+    - "{{ cookiecutter.github_username }}"
   schedule:
-    interval: weekly
+    interval: monthly
   commit-message:
-    prefix: "fix: "
+    prefix: "fix: "
+  labels:
+    - "CI/CD"
+  groups:
+      actions:
+        patterns:
+          - "*"

{{ cookiecutter.package_name }}/.github/workflows/sphinx-deploy.yml

@@ -1,4 +1,4 @@
-name: "Deploy Sphinx Package Documentation to Pages"
+name: "Deploy Package Documentation to Pages"
 
 on:
   push:
@@ -16,7 +16,7 @@ jobs:
       uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892. # v3.1
       with:
         publish: false
-    - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e. #v4.0.0
+    - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e. # v4.0.0
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ${{ steps.deployment.outputs.artifact }}

{{ cookiecutter.package_name }}/.github/workflows/sub_package_update.yml

@@ -36,9 +36,9 @@ jobs:
             title: Reject new updates from package template
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683. # v4.2.2
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b. # v5.3.0
         with:
           python-version: "3.11"
 
@@ -71,7 +71,7 @@ jobs:
 
       - name: Create pull request
         if: steps.check.outputs.has_changes == '1'
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f. #v7.0.5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           add-paths: ${{ matrix.add-paths }}