Merge pull request #149 from ecmwf-actions/fix/sync-anemoi-feedback

[file sync] Incorporate Anemoi feedback

Author: figi44

sync-files/anemoi/.github/PULL_REQUEST_TEMPLATE/pull_request_template-core.md

@@ -0,0 +1,15 @@
+{% extends "sync-files/anemoi/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md" %}
+
+{% block testing %}
+-   [ ] I have tested the changes on a single GPU
+-   [ ] I have tested the changes on multiple GPUs / multi-node setups
+-   [ ] I have run the [Benchmark Profiler](https://anemoi.readthedocs.io/projects/training/en/latest/user-guide/benchmarking.html) against the old version of the code
+
+{% endblock %}
+
+{% block documentation %}
+{% endblock %}
+
+{% block dependencies %}
+-   [ ] I have not introduced new dependencies in the inference portion of the pipeline
+{% endblock %}

sync-files/anemoi/.github/pull_request_template.md renamed to sync-files/anemoi/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -22,18 +22,18 @@
 ### Code Performance and Testing
 
 -   [ ] I have added tests that prove my fix is effective or that my feature works
--   [ ] I ran the complete Pytest test suite locally, and they pass
--   [ ] I have tested the changes on a single GPU
--   [ ] I have tested the changes on multiple GPUs / multi-node setups
--   [ ] I have run the Benchmark Profiler against the old version of the code
+-   [ ] I ran the [complete Pytest test](https://anemoi.readthedocs.io/projects/training/en/latest/dev/testing.html) suite locally, and they pass
+{% block testing %}
+{% endblock %}
 
 <!-- In case this affects the model sharding or other specific components please describe these here. -->
 
 ### Dependencies
 
 -   [ ] I have ensured that the code is still pip-installable after the changes and runs
--   [ ] I have not introduced new dependencies in the inference portion of the model
 -   [ ] I have tested that new dependencies themselves are pip-installable.
+{% block dependencies %}
+{% endblock %}
 
 <!-- List any new dependencies that are required for this change and the justification to add them. -->
 
@@ -42,6 +42,8 @@
 -   [ ] My code follows the style guidelines of this project
 -   [ ] I have updated the documentation and docstrings to reflect the changes
 -   [ ] I have added comments to my code, particularly in hard-to-understand areas
+{% block docs %}
+{% endblock %}
 
 <!-- Describe any major updates to the documentation -->
 

sync-files/anemoi/.github/labeler.yml

@@ -1,34 +1,42 @@
+# This is the configuration file for the labeler action.
+# It assigns labels to pull requests based on the files changed in the PR.
+# See more here: https://github.com/actions/labeler
 dependencies:
 - changed-files:
   - any-glob-to-any-file:
-    - "requirements.txt"
-    - "setup.py"
-    - "pyproject.toml"
-    - "Pipfile"
-    - "Pipfile.lock"
-    - "requirements/*.txt"
-    - "requirements/*.in"
+    - "**/requirements.txt"
+    - "**/setup.py"
+    - "**/pyproject.toml"
+    - "**/Pipfile"
+    - "**/Pipfile.lock"
+    - "**/requirements/*.txt"
+    - "**/requirements/*.in"
 
 documentation:
 - changed-files:
   - any-glob-to-any-file:
-    - "docs/**/*"
+    - "**/docs/**/*"
     - "*.md"
     - "*.rst"
 
 config:
 - changed-files:
   - any-glob-to-any-file:
-    - ".pre-commit-config.yaml"
-    - "config/**/*"
-    - "settings/**/*"
-    - "*.ini"
-    - "*.cfg"
-    - "*.conf"
+    - "**/src/**/config/**/*"
 
 CI/CD:
 - changed-files:
   - any-glob-to-any-file:
+    - "**/.pre-commit-config.yaml"
     - ".github/**/*"
     - "tox.ini"
     - ".coveragerc"
+
+tests:
+- changed-files:
+  - any-glob-to-any-file:
+    - "**/tests/**/*"
+    - "**/test/**/*"
+    - "**/test_*.py"
+    - "**/test.py"
+    - "**/conftest.py"

sync-files/anemoi/.github/workflows/downstream-ci-hpc.yml

@@ -1,3 +1,5 @@
+# This workflow triggers tests on dependent packages.
+# The dependency tree itself is defined in ecmwf-actions/downstream-ci/
 name: Test downstream dependent packages on HPC
 
 on:

sync-files/anemoi/.github/workflows/pr-conventional-commit.yml

@@ -1,4 +1,5 @@
-name: "Ensure Conventional Commit in PR title"
+# This workflow ensures that the PR title follows the Conventional Commit format.
+name: "[Pull Request] Ensure Conventional Commit in PR title"
 
 on:
   pull_request_target:

sync-files/anemoi/.github/workflows/pr-label-conventional-commits.yml

@@ -1,4 +1,6 @@
-name: "Pull Request Labeler Conventional Commits"
+# This workflow assigns labels to a pull request based on the Conventional Commits format.
+# This is necessary for release-please to work properly.
+name: "[Pull Request] Label Conventional Commits"
 
 on:
   pull_request:
@@ -37,7 +39,7 @@ jobs:
                 nouns: ['build','rebuild','ci']
                 labels: ['CI/CD']
               - type: 'config'
-                nouns: ['config', 'conf', 'cofiguration']
+                nouns: ['config', 'conf', 'configuration']
                 labels: ['config']
           maintain-labels-not-matched: false
           apply-changes: true

sync-files/anemoi/.github/workflows/pr-label-file-based.yml

@@ -1,13 +1,17 @@
-name: "Pull Request Labeler File-based"
+# This workflow assigns labels to a pull request based on the files changed in the PR.
+# The labels are defined in the `.github/labels.yml` file.
+name: "[Pull Request] Label File-based"
 on:
-- pull_request_target
+  pull_request_target:
+    types: [opened, synchronize]
+
+permissions:
+  contents: read
+  pull-requests: write
 
 jobs:
   labeler:
-    permissions:
-      contents: read
-      pull-requests: write
     runs-on: ubuntu-latest
     steps:
     - name: Assign labels from file changes
-    - uses: actions/labeler@v5
+      uses: actions/labeler@v5

sync-files/anemoi/.github/workflows/pr-label-public.yml

@@ -1,5 +1,5 @@
 # Manage labels of pull requests that originate from forks
-name: Label PRs from public forks
+name: "[Pull Request] Label PRs from public forks"
 
 on:
   pull_request_target:

sync-files/anemoi/.github/workflows/push-to-private.yml

@@ -1,3 +1,4 @@
+# This workflow pushes changes from a public repository to a private repository.
 name: Push to private repository
 
 on:

sync-files/anemoi/.github/workflows/python-publish.yml

@@ -1,4 +1,3 @@
----
 # This workflow will upload a Python Package using Twine when a release is created
 # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
 

sync-files/anemoi/.github/workflows/python-pull-request.yml

@@ -1,3 +1,4 @@
+# This workflow runs pre-commit checks and pytest tests against multiple platforms and Python versions.
 name: Code Quality checks and Testing
 
 on:

sync-files/anemoi/.github/workflows/readthedocs-pr-update.yml

@@ -1,3 +1,5 @@
+# This workflow adds a link to the experimental documentation build to the PR.
+# This does NOT trigger a build of the documentation, this is handled through webhooks.
 name: Read the Docs PR Preview
 on:
   pull_request_target:

sync-files/anemoi/.github/workflows/release-please.yml

@@ -1,9 +1,12 @@
+# This workflow uses an action to run Release Please to create a release PR.
+# It is governed by the config and manifest in the root of the repo.
+# For more information see: https://github.com/googleapis/release-please
 name: Run Release Please
 on:
   push:
     branches:
       - main
-      - hotfix
+      - hotfix/*
 
 permissions:
   contents: write

sync-files/anemoi/README.md

@@ -1,4 +1,4 @@
-# anemoi-utils
+# {{ repo_name }}
 
 **DISCLAIMER**
 This project is **BETA** and will be **Experimental** for the foreseeable future.
@@ -9,7 +9,7 @@ Interfaces and functionality are likely to change, and the project itself may be
 
 ## Documentation
 
-The documentation can be found at https://{{ repo-name }}.readthedocs.io/.
+The documentation can be found at https://{{ repo_name }}.readthedocs.io/.
 
 ## Install
 

sync-files/sync.yml

@@ -1,3 +1,7 @@
+# This configuration file is used by the file broadcasting infrastructure in .github/workflows/sync-files-to-repos.yml.
+# It defines the files to be copied to the repositories listed in the `repos` field.
+# You can use templating and fairly intricate logic to define the files to be copied and replaced.
+# Read more here: https://github.com/BetaHuhn/repo-file-sync-action/
 group:
 ##################
 # Anemoi Files   #
@@ -42,6 +46,7 @@ group:
       short_desc: "Datasets for training data-driven weather forecasts."
     exclude: |
       .release-please-manifest.json
+      .github/PULL_REQUEST_TEMPLATE/pull_request_template-core.md
   repos: |
     ecmwf/anemoi-datasets
 
@@ -57,6 +62,7 @@ group:
       short_desc: "Inference tools for data-driven weather forecasts."
     exclude: |
       .release-please-manifest.json
+      .github/PULL_REQUEST_TEMPLATE/pull_request_template-core.md
   repos: |
     ecmwf/anemoi-inference
 
@@ -72,6 +78,7 @@ group:
       short_desc: "Registry for data-driven weather forecasts."
     exclude: |
       .release-please-manifest.json
+      .github/PULL_REQUEST_TEMPLATE/pull_request_template-core.md
   repos: |
     ecmwf/anemoi-registry
 
@@ -87,6 +94,7 @@ group:
       short_desc: "Miscellanous data transformation functions for training data-driven weather forecasts."
     exclude: |
       .release-please-manifest.json
+      .github/PULL_REQUEST_TEMPLATE/pull_request_template-core.md
   repos: |
     ecmwf/anemoi-transform
 
@@ -102,6 +110,7 @@ group:
       short_desc: "Miscellanous tools for training data-driven weather forecasts."
     exclude: |
       .release-please-manifest.json
+      .github/PULL_REQUEST_TEMPLATE/pull_request_template-core.md
   repos: |
     ecmwf/anemoi-utils
 
@@ -145,18 +154,19 @@ group:
     dest: training/CONTRIBUTORS.md
     template:
       repo_name: anemoi-training
-  - source: sync-files/anemoi/.github/pull_request_template.md
-    dest: .github/pull_request_template.md
+  - source: sync-files/anemoi/.github/PULL_REQUEST_TEMPLATE/pull_request_template-core.md
+    dest: .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
+    template: true
   - source: sync-files/anemoi/.gitignore
     dest: .gitignore
   - source: sync-files/general/python/.github/dependabot.yml
     dest: .github/dependabot.yml
   - source: sync-files/anemoi/.github/workflows/pr-label-public.yml
-    dest: .github/workflows/label-public-pr.yml
+    dest: .github/workflows/pr-label-public.yml
     template:
       repo_name: anemoi-core
-  - source: sync-files/anemoi/.github/workflows/pr-label-conventional-commit.yml
-    dest: .github/workflows/pr-label-conventional-commit.yml
+  - source: sync-files/anemoi/.github/workflows/pr-label-conventional-commits.yml
+    dest: .github/workflows/pr-label-conventional-commits.yml
     template:
       repo_name: anemoi-core
   - source: sync-files/anemoi/.github/workflows/pr-label-file-based.yml