Merge pull request #143 from flatland-association/41-implement-releases

chenkins · web-flow · commit 235b416d590d · 2025-02-12T15:53:19.000+01:00
Implement releases.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -17,14 +17,32 @@ See [here](https://docs.github.com/en/get-started/writing-on-github/working-with
 ## Checklist
 
 - [ ] Tests are included for relevant behavior changes.
-- [ ] Prefix the PR title with one of the labels of [Keep a Changelog](https://keepachangelog.com/).   
+- [ ] Prefix the commits with one of the labels of [Conventional Commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
 <!--
-  - `[Added]`  for new features.
-  - `[Changed]` for changes in existing functionality.
-  - `[Deprecated]` for soon-to-be removed features.
-  - `[Removed]` for now removed features.
-  - `[Fixed]` for any bug fixes.
-  - `[Security]` in case of vulnerabilities. 
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
+
+The commit message should be structured as follows:
+  <type>[optional scope]: <description>
+  
+  [optional body]
+  
+  [optional footer(s)]
+
+
+1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
+2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
+3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
+4. types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends 
+    - build:
+    - chore:
+    - ci:
+    - docs:
+    - style:
+    - refactor:
+    - perf:
+    - test:
+5. footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
+ 
 -->
 - [ ] Document changes in this pull request above.
 - [ ] Documentation is added in the `docs` folder for relevant behavior changes.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -0,0 +1,26 @@
+on:
+  push:
+    branches:
+      - main
+
+# https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
+# https://docs.github.com/en/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-actions
+permissions:
+  contents: write
+  pull-requests: write
+  actions: write
+
+name: release-please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+      - name: Realease FAB frontend and backend images and upload to ghcr.io
+        run: gh workflow run fab-docker.yml -f tag=${{ steps.release.outputs.tag_name }}
+        if: ${{ steps.release.outputs.release_created }}
+      - name: Realease FAB Flatland 3 compute worker, evaluator and submission template images and upload to ghcr.io
+        run: gh workflow run fab-flatland-docker.yml -f tag=${{ steps.release.outputs.tag_name }}
+        if: ${{ steps.release.outputs.release_created }}
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  ".": "0.4.0"
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,70 @@
 # Changelog
 
-All notable changes will be documented under [GitHub Releases](https://github.com/flatland-association/flatland-benchmarks/releases).
-
-The release notes are based on [Keep a Changelog](https://keepachangelog.com/),
+All notable changes will be documented in this file, updated by [release-please](https://github.com/googleapis/release-please) based on [Conventional Commit messages](https://www.conventionalcommits.org/en/v1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [0.4.0](https://github.com/flatland-association/flatland-benchmarks/compare/v0.3.0...v0.4.0) (2025-02-11)
+
+* [Fixed] Fix passing through S3_UPLOAD_PATH_TEMPLATE and S3_UPLOAD_PATH_TEMPLATE_USE_SUBMISSION_ID from compute worker to evaluator. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/95
+* [Changed] Run checks upon push to main and daily on default branch. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/96
+* [Added] Display and store evaluation result by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/101
+* [Security] Update npm packages by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/102
+* [Changed] #31 Publish result when eula accepted by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/106
+* [Changed] #103 Use same theme as flatland.cloud by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/107
+* [Added] #30 Public leaderboard by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/109
+* [Changed] #98 Use python 3.13 for compute worker. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/100
+* [Changed] #81 Get rid of pvc and ad-hoc pod in favor of s3. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/112
+* [Added] #69 Add timeout for k8s jobs. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/110
+* [Changed] #94 UUID for submissions and results by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/113
+* [Added] #75 Make supported client versions configurable. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/115
+* [Changed] #9 Remove submission template in favor of external starterkit. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/111
+* [Changed] Reduce Rabbit healthcheck interval. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/118
+* [Changed] Cleanup pr template. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/121
+* [Added] #78 Evaluate only selected tests by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/117
+* [Changed] #105 Submission flow by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/116
+* [Changed] #10 Download environments from S3 in k8s initContainers. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/126
+* [Added] #99 Fail fast if either submission or evaluation fails. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/119
+* [Changed] #104 #120 Improve submission UX and leaderboard by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/129
+* [Changed] #93 #33 #130 UI updates by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/131
+* [Security] #108 #88 Backend auth guard by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/134
+* [Added] #10 Env generation for Flatland 3. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/128
+
+## [0.3.0](https://github.com/flatland-association/flatland-benchmarks/compare/v0.0.0...v0.3.0) (2025-02-05)
+
+* [Added] #1 Repo Initialization. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/13
+* [Added] Add CHANGELOG.md, CONTRIBUTING.MD and pr template. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/18
+* [Added] #3 Data Model Frontend/Backend by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/17
+* [Added] #2 High-Level Architecture description. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/14
+* [Added] #4 story frontend template by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/19
+* [Changed] Update `pull_request_template.md` by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/24
+* [Added] #8 Cloud Deployment Bootstrapping. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/23
+* [Changed] #4 Minor template cleanup by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/22
+* [Added] #6 `@flatland-association/flatland-ui` library for UI components.. by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/25
+* [Fixed] Fix backend entrypoint. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/28
+* [Changed] Cleanup repo/app name: flatland-benchmarks/Flatland Benchmarks/FAB/fab-. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/29
+* [Added] #4 Bootstrapping Evaluation by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/20
+* [Fixed] #35 Fix RabbitMQ High CPU Usage. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/37
+* [Changed] Cleanup after repo renaming. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/44
+* [Changed] Simplify story issue template to general task. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/61
+* [Added] #27 Cloud Deployment. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/38
+* [Added] #7 #26 refine submission flow by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/51
+* [Added] #56 Bootstrap Unit Test Coverage for fab-flatland3-compute-worker by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/58
+* [Added] #57 Bootstrap Integration Test Coverage for fab-flatland-compute-worker and fab-flatland3-evaluator by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/67
+* [Fixed] #49 Fix nginx config supporting paths. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/77
+* [Fixed] Fix invalid checks.yaml. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/79
+* [Fixed] #49 Fix path, failing in gh by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/80
+* [Added] 59 Update interface documentation by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/84
+* [Added] #65 Pass `output.csv` and `output.json`: `evaluator` -> `compute_worker` -> `redis` (-> `backend`) by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/68
+* [Added] #40 k8s compute worker implementation by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/83
+* [Changed] Use gh releases for changelog keeping. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/85
+* [Changed] #46 Use non-super-user to run compute worker. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/72
+* [Added] #6 Keycloak authentication integration frontend by @Holzchopf in https://github.com/flatland-association/flatland-benchmarks/pull/76
+* [Fix] Fix broken link to ci badge. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/89
+* [Fixed] Fix missing `pandas` dependency in compute worker. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/90
+* [Fixed] Fix compute worker: env var mismatch for redis. Fix missing file. Add config options for evaluator. by @chenkins in https://github.com/flatland-association/flatland-benchmarks/pull/91
+
+## New Contributors
+
+* @Holzchopf made their first contribution in https://github.com/flatland-association/flatland-benchmarks/pull/17
+
 
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 Flatland Benchmarks
 ===================
-[![Main](https://github.com/flatland-association/flatland-benchmarks/actions/workflows/checks.yaml/badge.svg)](https://github.com/flatland-association/flatland-benchmarks/actions/workflows/checks.yaml)
+[![Main](https://github.com/flatland-association/flatland-benchmarks/actions/workflows/checks.yml/badge.svg)](https://github.com/flatland-association/flatland-benchmarks/actions/workflows/checks.yml)
 
 Flatland Benchmarks (FAB) is an open-source web-based platform for running Benchmarks to foster Open Research aiming at:
 
diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
@@ -14,14 +14,16 @@ It is recommended to use [VSCode](https://code.visualstudio.com) with the [ESLin
 [Node.js](https://nodejs.org) must be installed. It runs frontend and backend code as well as local scripts (e.g. `npx lint-staged` which will lint and format staged source files). Node.js includes npm, which is required to install node modules.
 
 To complete your local setup, run
+
 ```bash
 npm ci
 ```
+
 in the project root folder. This will install all required node modules as listed in `package-lock.json`.
 
 The project is configured to lint and format your source code before committing and also on explicit save (when using VSCode as described above). However, if you're not using VSCode or for some reason not using the extensions, your code will still be linted and formatted before a commit. Be aware that in this case lint warnings and errors will abort your commit!
 
->If `lint-staged` fails and **discards** your changes, you can often `git stash pop` them back into existence. Run the `lint` npm script manually beforehand or install the VSCode plugins as described above to limit any surprises.
+> If `lint-staged` fails and **discards** your changes, you can often `git stash pop` them back into existence. Run the `lint` npm script manually beforehand or install the VSCode plugins as described above to limit any surprises.
 
 ## Developper notes
 
@@ -53,4 +55,9 @@ https://www.reddit.com/r/PostgreSQL/comments/1ffqsvw/stop_using_serial_in_postgr
 
 GET endpoints should always treat the `id` paramater as comma-separated list of values in accordance with dev.003.
 
-2025-01-29, Olivier Stuker
+2025-01-29, Olivier Stuker
+
+## Releases
+
+* Release prs are automatically opened by [release-please](https://github.com/googleapis/release-please)/[release-please-action](https://github.com/marketplace/actions/release-please-action) based on [Conventional Commit Messages](https://www.conventionalcommits.org/en/v1.0.0/)
+* [How do I change the version number?](https://github.com/googleapis/release-please?tab=readme-ov-file#how-do-i-change-the-version-number)
diff --git a/release-please-config.json b/release-please-config.json
@@ -0,0 +1,13 @@
+{
+  "packages": {
+    ".": {
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "simple",
+      "bump-minor-pre-major": false,
+      "bump-patch-for-minor-pre-major": false,
+      "draft": false,
+      "prerelease": false
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}
diff --git a/version.txt b/version.txt
@@ -0,0 +1 @@
+0.4.0
