From 12e80b540693f5fc3ec525afc7ef61c0d5c8b87e Mon Sep 17 00:00:00 2001 From: samwinebrake Date: Tue, 4 Feb 2025 11:29:18 -0500 Subject: [PATCH 1/2] fix submission picture online --- docs/source/modules/submission.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/modules/submission.rst b/docs/source/modules/submission.rst index 5ed8f3709..f6d2a3239 100644 --- a/docs/source/modules/submission.rst +++ b/docs/source/modules/submission.rst @@ -4,7 +4,7 @@ Submission System To submit a model or benchmark to the Brain-Score leaderboard, Brain-Score provides an automated submission system. This allows us to publicly score new models on existing benchmarks and score existing models against new benchmarks. -.. image:: docs/source/modules/brainscore_submission.png +.. image:: brainscore_submission.png :width: 400px :align: center :height: 200px From 2c20cade8bc9a900b5e2cbccb35e6d6b3f500f8a Mon Sep 17 00:00:00 2001 From: samwinebrake Date: Tue, 4 Feb 2025 14:08:55 -0500 Subject: [PATCH 2/2] readthedocs version bumping documentation --- docs/source/modules/version_bumping.rst | 43 +++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/source/modules/version_bumping.rst diff --git a/docs/source/modules/version_bumping.rst b/docs/source/modules/version_bumping.rst new file mode 100644 index 000000000..ad0ed84bb --- /dev/null +++ b/docs/source/modules/version_bumping.rst @@ -0,0 +1,43 @@ +Version Bumping +=============== + +Brain-Score Vision now features an automated version bumping process that follows +`Semantic Versioning `_ (MAJOR.MINOR.PATCH) and is triggered via a GitHub Action. +This ensures that any significant changes to the codebase lead to an appropriate version update. + +How It Works +------------ + +1. **Pull Request Analysis:** + When a pull request (PR) is submitted, a GitHub Action (see the + `workflow file `_) + analyzes the changes. If any files outside the plugin directories—namely, ``benchmarks``, + ``data``, ``metrics``, and ``models``—are modified, the version bump process is initiated. Changes confined to + plugin directories are considered non-breaking and therefore do not necessitate a version increment. + +2. **Determining the Bump Type:** + The type of version bump is determined by labels applied to the PR: + + - **MAJOR:** Apply the ``major update`` label to trigger an increase in the major version. + - **MINOR:** Apply the ``minor update`` label to trigger an increase in the minor version. + - **PATCH:** If neither label is applied, the version will automatically increment the patch number. + +3. **Version Increment and PR Creation:** + The tool `bump-my-version `_ uses the latest + version tag to calculate the new version number. After bumping the version, a new PR is automatically + created containing the updated version. This PR is auto-approved, undergoes status checks, and is then + merged automatically. + +Version Releases +---------------- + +After the version is bumped, release notes are automatically generated. These notes include all commit +details since the previous version bump and can be viewed in the +`Releases section `_ of the repository. + +PyPI Publishing +--------------- + +A version bump also triggers a publishing job that builds the new package and uploads it to PyPI. +You can always find the latest package available on PyPI at the +`PyPI project page `_. \ No newline at end of file