From 17ce8863b99bcfdd7394d65e3996223937420554 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Fri, 19 Feb 2021 11:06:18 +0100
Subject: [PATCH] Add CodeMeta file
---
codemeta.json | 34 ++++++++++++++++++++++++++++++++++
docs/release-process.md | 14 +++++++++-----
2 files changed, 43 insertions(+), 5 deletions(-)
create mode 100644 codemeta.json
diff --git a/codemeta.json b/codemeta.json
new file mode 100644
index 000000000..eff1f1ba4
--- /dev/null
+++ b/codemeta.json
@@ -0,0 +1,34 @@
+{
+ "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
+ "@type": "SoftwareSourceCode",
+ "license": "https://spdx.org/licenses/Apache-2.0",
+ "codeRepository": "https://github.com/cau-se/theodolite",
+ "dateCreated": "2020-03-13",
+ "datePublished": "2020-07-27",
+ "dateModified": "2021-02-11",
+ "downloadUrl": "https://github.com/cau-se/theodolite/releases",
+ "name": "Theodolite",
+ "version": "0.3.0",
+ "description": "Theodolite is a framework for benchmarking the horizontal and vertical scalability of stream processing engines.",
+ "developmentStatus": "active",
+ "referencePublication": "https://doi.org/10.1016/j.bdr.2021.100209",
+ "programmingLanguage": [
+ "Python",
+ "Java"
+ ],
+ "runtimePlatform": [
+ "Kubernetes"
+ ],
+ "author": [
+ {
+ "@type": "Person",
+ "givenName": "Sören",
+ "familyName": "Henning",
+ "email": "soeren.henning@email.uni-kiel.de",
+ "affiliation": {
+ "@type": "Organization",
+ "name": "Department of Computer Science, Kiel University"
+ }
+ }
+ ]
+}
diff --git a/docs/release-process.md b/docs/release-process.md
index c3712c834..4680c50c1 100644
--- a/docs/release-process.md
+++ b/docs/release-process.md
@@ -11,14 +11,18 @@ This document describes how to perform a new Theodolite release.
We assume that we are creating the release `v0.3.1`. Please make sure to adjust
the following steps according to the release, you are actually performing.
-1. Create a new branch `v0.3` if it does not already exists. This branch will never
+1. Update `codemeta.json` to match the new version. In particular, make sure that `version` points to the version you are releasing and `dateModified` points to the date you are relasing this version. [CodeMeata generator](https://codemeta.github.io/codemeta-generator/) may help you in updating the file.
+
+2. Create a new branch `v0.3` if it does not already exists. This branch will never
again be merged into master.
-2. Checkout the `v0.3` branch.
+3. Checkout the `v0.3` branch.
-3. Update all references to Theodolite Docker images to tag `v0.3.1`. These are the Kubernetes resource definitions in
+4. Update all references to Theodolite Docker images to tag `v0.3.1`. These are the Kubernetes resource definitions in
`execution`, the references to *latest* in `run_uc.py`, the Docker Compose files in `docker-test` and the example `theodolite.yaml` job.
-4. Commit these changes.
+5. Commit these changes.
+
+6. Tag this commit with `v0.3.1`. The corresponding Docker images will be uploaded.
-5. Tag this commit with `v0.3.1`. The corresponding Docker images will be uploaded.
+7. Create *releases* for this tag in both, GitLab and GitHub.
--
GitLab