Merge branch 'main' into refactor/contributors

lwjohnst86 · web-flow · commit 056ce877a276 · 2025-12-05T10:53:44.000+01:00
diff --git a/.cz.toml b/.cz.toml
@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "0.16.0"
+version = "0.16.1"
 bump_message = "build(version): :bookmark: update version from $current_version to $new_version"
 version_schema = "semver"
 version_provider = "commitizen"
diff --git a/.github/workflows/add-to-project.yml b/.github/workflows/add-to-project.yml
@@ -11,12 +11,14 @@ on:
       - reopened
       - opened
 
-permissions:
-  pull-requests: write
+# Limit token permissions for security
+permissions: read-all
 
 jobs:
   add-to-project:
     uses: seedcase-project/.github/.github/workflows/reusable-add-to-project.yml@main
+    permissions:
+      pull-requests: write
     with:
       board-number: 18
       app-id: ${{ vars.ADD_TO_BOARD_APP_ID }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,3 +12,5 @@ permissions: read-all
 jobs:
   test-copier:
     uses: seedcase-project/.github/.github/workflows/reusable-test-copier.yml@main
+    with:
+      test-recipe: "_tests"
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,16 +10,18 @@
   "quarto.visualEditor.markdownWrapColumn": 72,
   "editor.tabCompletion": "on",
   "editor.snippetSuggestions": "inline",
-  "conventional-branch.type": [
-    "build", // Changes that affect the build system or external dependencies
-    "ci", // Changes to our CI configuration files and scripts
-    "docs", // Documentation only changes
-    "feat", // A new feature
-    "fix", // A bug fix
-    "refactor", // A code change that neither fixes a bug nor adds a feature
-    "style", // Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-    "test", // Adding missing tests or correcting existing tests
-    "chore", // Misc things, like renaming or deleting files
+   "conventional-branch.type": [
+    "build",
+    "ci",
+    "docs",
+    "feat",
+    "fix",
+    "refactor",
+    "style",
+    "test",
+    "chore",
+    "revert",
+    "perf"
   ],
   "conventional-branch.format": "{Type}/{Branch}",
   "[quarto][qmd][jinja]": {
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,25 @@
+# Changelog
+
+Since we follow [Conventional
+Commits](https://decisions.seedcase-project.org/why-conventional-commits),
+we're able to automatically create a release based on the commit message
+by using
+[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen).
+This means that releases can happen quite often, sometimes several in
+a day. It also means any individual release will not have many changes
+within it. Below is a list of releases along with what was changed
+within it.
+
+## 0.16.1 (2025-12-05)
+
+### Refactor
+
+- :recycle: update copier vars (#184)
+- :recycle: update remaining config files (#183)
+- :recycle: update workflows (#181)
+- :recycle: update supporting files (#180)
+- :recycle: move releases to changelog (#177)
+
 ## 0.16.0 (2025-11-14)
 
 ### Feat
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,30 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect
+all people who contribute through reporting issues, posting suggestions,
+updating any material, submitting pull requests, and other activities.
+
+We are committed to making participation in this project a
+harassment-free experience for everyone, regardless of level of
+experience, gender, gender identity and expression, sexual orientation,
+disability, personal appearance, body size, race, ethnicity, age, or
+religion.
+
+Examples of unacceptable behavior by participants include the use of
+sexual language or imagery, derogatory comments or personal attacks,
+trolling, public or private harassment, insults, or other unprofessional
+conduct.
+
+Project maintainers have the right and responsibility to remove, edit,
+or reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct. Project
+maintainers who do not follow the Code of Conduct may be removed from
+the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant
+(https://contributor-covenant.org), version 1.0.0, available at
+https://contributor-covenant.org/version/1/0/0/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -47,3 +47,14 @@ When testing the template, copier can only use content kept in the Git
 history. Meaning that if you make changes to the template and try to
 test it, it won't be able to test those changes. You have to commit the
 changes first in order for copier to use them.
+
+When committing changes, please try to follow [Conventional
+Commits](https://decisions.seedcase-project.org/why-conventional-commits)
+as Git messages. Using this convention allows us to be able to
+automatically create a release based on the commit message by using
+[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen).
+If you don't use Conventional Commits when making a commit, we will
+revise the pull request title to follow that format, as we use [squash
+merges](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/squashing-commits/about-squash-merges)
+when merging pull requests, so all other commits in the pull request
+will be squashed into one commit.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ Check out our
 information, such as a
 [guide](https://template-data-package.seedcase-project.org/docs/guide/)
 for using the template. For a list of changes, see our
-[changelog](https://template-data-package.seedcase-project.org/docs/releases/)
+[changelog](https://template-data-package.seedcase-project.org/CHANGELOG/)
 page.
 
 ## Contributing
@@ -42,8 +42,8 @@ for information on how to contribute to the project, including how to
 set up your development environment.
 
 Please note that this project is released with a [Contributor Code of
-Conduct](https://github.com/seedcase-project/.github/blob/main/CODE_OF_CONDUCT.md).
-By participating in this project you agree to abide by its terms.
+Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
+to abide by its terms.
 
 ### Contributors
 
diff --git a/README.qmd b/README.qmd
@@ -17,12 +17,12 @@ the necessary files and configurations in place, including for
 developing the Data Package. See the features section below for details
 on what is included in this template.
 
-Check out our [website](https://{{< meta repo >}}.seedcase-project.org/) for more
-information, such as a
-[guide](https://{{< meta repo >}}.seedcase-project.org/docs/guide/) for using the template.
-For a list
-of changes, see our
-[changelog](https://{{< meta repo >}}.seedcase-project.org/docs/releases/) page.
+Check out our [website](https://{{< meta repo >}}.seedcase-project.org/)
+for more information, such as a
+[guide](https://{{< meta repo >}}.seedcase-project.org/docs/guide/) for
+using the template. For a list of changes, see our
+[changelog](https://{{< meta repo >}}.seedcase-project.org/CHANGELOG/)
+page.
 
 ## Contributing
 
@@ -31,8 +31,8 @@ for information on how to contribute to the project, including how to
 set up your development environment.
 
 Please note that this project is released with a [Contributor Code of
-Conduct](https://github.com/seedcase-project/.github/blob/main/CODE_OF_CONDUCT.md).
-By participating in this project you agree to abide by its terms.
+Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
+to abide by its terms.
 
 ### Contributors
 
diff --git a/_publish.yml b/_publish.yml
@@ -1,5 +1,4 @@
 - source: project
   netlify:
-    # TODO: Include correct ID
     - id: "73514699-e6a4-404a-ae41-f76a39c4f77c"
       url: "https://seedcase-template-data-package.netlify.app"
diff --git a/_quarto.yml b/_quarto.yml
@@ -22,10 +22,10 @@ website:
         menu:
           - text: "Welcome"
             href: index.qmd
-          - text: "Releases"
-            href: docs/releases.qmd
           - text: "Contributing"
             href: CONTRIBUTING.md
+          - text: "Changelog"
+            href: CHANGELOG.md
       - text: "Guide"
         href: docs/guide.qmd
     tools:
diff --git a/copier.yaml b/copier.yaml
@@ -9,7 +9,7 @@ _tasks:
 # Message to show after generating or regenerating the project successfully
 _message_after_copy: |
 
-  Your project "{{ package_abbrev }}" has been created successfully!
+  Your project "{{ github_repo }}" has been created successfully!
 
   See the [guide](https://template-data-package.seedcase-project.org/docs/guide) for more detail
   on the next steps. Briefly:
@@ -49,14 +49,14 @@ _message_after_copy: |
     ```
 
 # Questions:
-package_github_repo:
+github_user:
   type: str
-  help: "What is the GitHub repository spec for the package?"
-  placeholder: "user/repo"
-  validator: |
-    {% if package_github_repo and not (package_github_repo | regex_search('^[\w.-]+\/[\w.-]+$')) %}
-    Must be in the format `user/repo` and contain only alphanumeric characters and `_`, `-`, or `.`.
-    {% endif %}
+  help: "What is the name of the GitHub user or organisation where the repository will be or is stored?"
+
+github_repo:
+  type: str
+  help: "What is the name of the GitHub repository where the data package will be or is stored? We strongly recommend using the default given."
+  default: "{{ _folder_name }}"
 
 author_given_name:
   type: str
@@ -70,16 +70,10 @@ author_email:
   type: str
   help: "What is your email address?"
 
-package_abbrev:
-  type: str
-  help: "What is the abbreviated name of the package? This could be the name of your GitHub repository and should be a short, lowercase name without spaces or special characters. For example, 'template-data-package'."
-  default: "{{ _copier_conf.dst_path | basename }}"
-
 review_team:
   type: str
   help: What GitHub team is responsible for reviewing pull requests?
-  default: >-
-    {{ "@%s/developers" % package_github_repo.split('/')[0] if package_github_repo else "" }}
+  default: "{{ '@%s/developers' % github_user if github_user else '' }}"
 
 github_board_number:
   type: str
@@ -89,12 +83,18 @@ github_board_number:
     The board number must be an integer.
     {% endif %}
 
-copyright_year:
-  type: str
-  default: "{{ copyright_year | default('%Y' | strftime) }}"
-  when: false
-
 cc0_license:
   type: bool
   default: true
   help: "Do you want to use the CC0 license for the data in this data package?"
+
+# Configurations not asked
+github_repo_spec:
+  type: str
+  default: "{{ github_user }}/{{ github_repo }}"
+  when: false
+
+copyright_year:
+  type: str
+  default: "{{ copyright_year | default('%Y' | strftime) }}"
+  when: false
diff --git a/docs/releases.qmd b/docs/releases.qmd
diff --git a/index.qmd b/index.qmd
@@ -52,3 +52,7 @@ share your ideas or contribute code. Your input makes us better!
 ### Contributors
 
 {{< include /docs/includes/_contributors.qmd >}}
+
+## Licensing
+
+This project is licensed under the [MIT License](/LICENSE.md).
diff --git a/justfile b/justfile
@@ -46,8 +46,8 @@ test:
     --vcs-ref=$commit \
     --defaults \
     --trust \
-    --data package_abbrev=$test_name \
-    --data package_github_repo="first-last/${test_name}" \
+    --data github_repo=$test_name \
+    --data github_user="first-last" \
     --data author_given_name="First" \
     --data author_family_name="Last" \
     --data author_email="first.last@example.com" \
@@ -81,8 +81,8 @@ test:
     --defaults \
     --trust \
     --overwrite \
-    --data package_abbrev=$test_name \
-    --data package_github_repo="first-last/${test_name}" \
+    --data github_repo=$test_name \
+    --data github_user="first-last" \
     --data author_given_name="First" \
     --data author_family_name="Last" \
     --data author_email="first.last@example.com" \
diff --git a/template/.github/CODEOWNERS.jinja b/template/.github/CODEOWNERS.jinja
@@ -1,12 +1,2 @@
 # All members on Developers team get added to review PRs
 * {{ review_team }}
-
-# Ignore these so we don't get added to sync PRs
-/.github/
-/.vscode/
-justfile
-.editorconfig
-.gitignore
-ruff.toml
-pyproject.toml
-uv.lock
diff --git a/template/.github/workflows/update-from-template.yml b/template/.github/workflows/update-from-template.yml
diff --git a/template/.vscode/settings.json b/template/.vscode/settings.json
diff --git a/template/CITATION.cff.jinja b/template/CITATION.cff.jinja
diff --git a/template/LICENSE-MIT.md.jinja b/template/LICENSE-MIT.md.jinja
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
