From 190d66484700f16243db8c17628ae7f99bed4ae4 Mon Sep 17 00:00:00 2001 From: Naexon Date: Tue, 21 Mar 2023 16:02:36 +0100 Subject: [PATCH 1/8] testing for gpg signing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2eab463..8a2c0e7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # execDAT -execDAT - remote code execution for research +execDAT - remote code execution for research ## Getting Started From 40b93d770793cbcc86396ae7c010103d40b334a0 Mon Sep 17 00:00:00 2001 From: Naexon Date: Thu, 23 Mar 2023 14:52:32 +0100 Subject: [PATCH 2/8] accepted public-vs-private-data ADR --- docs/adrs/2023-03-16-public-vs-private-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adrs/2023-03-16-public-vs-private-data.md b/docs/adrs/2023-03-16-public-vs-private-data.md index c58aed6..b10e381 100644 --- a/docs/adrs/2023-03-16-public-vs-private-data.md +++ b/docs/adrs/2023-03-16-public-vs-private-data.md @@ -3,7 +3,7 @@ Date: 2023-03-16 ## Status -__PROPOSED__ +__ACCEPTED__ ## Context From edc039c38b0f07677a7ca5657f89540e4eea64cd Mon Sep 17 00:00:00 2001 From: Naexon Date: Thu, 23 Mar 2023 14:52:56 +0100 Subject: [PATCH 3/8] proposed branch-naming ADR --- docs/adrs/2023-03-23-branch-naming.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/adrs/2023-03-23-branch-naming.md diff --git a/docs/adrs/2023-03-23-branch-naming.md b/docs/adrs/2023-03-23-branch-naming.md new file mode 100644 index 0000000..9a577f3 --- /dev/null +++ b/docs/adrs/2023-03-23-branch-naming.md @@ -0,0 +1,25 @@ +# Branch Naming + +Date: 2023-03-23 + +## Status +__PROPOSED__ + +## Context +We want a unified naming scheme for the naming of branches. Currently, no concrete scheme was decided on and we had a discussion between `feature/`, `features/` and `issue/` prefixes for branches beside `dev` or `main`. + +## Decision +We decided on the following namings: +* `main` for the main branch +* `dev` for the development branch +* `feature/` for all branches that implement a new functionality or feature +* `issue/` for all branches that are concerned with a bug-fixe or issue +* `testing/` for all branches that fit neither `feature/` or `issue/` + +We researched Pre-Commit-Hooks to enforce this, however a local installation of the CLI tool would be required and we do not want the added tool requirements and complexity. + +Instead we will use the __branch protection rules__ to pattern match all other names and lock the corresponding branches. This should correspond some type of enforcing. + +## Consequences +* developers need to adhere to the naming scheme for branches +* tighter control over the branch protection rules because we only have a small set of legal names \ No newline at end of file From 215aff6ad29bf3729ce1bb4be3cdf073bc428130 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Hofst=C3=A4tter?= Date: Thu, 23 Mar 2023 15:29:36 +0100 Subject: [PATCH 4/8] Start CICD ADR --- docs/adrs/2023-03-23-cicd-solution.md | 19 +++++++++++++++++++ docs/adrs/2023-03-DD-cicd-solution.md | 26 -------------------------- 2 files changed, 19 insertions(+), 26 deletions(-) create mode 100644 docs/adrs/2023-03-23-cicd-solution.md delete mode 100644 docs/adrs/2023-03-DD-cicd-solution.md diff --git a/docs/adrs/2023-03-23-cicd-solution.md b/docs/adrs/2023-03-23-cicd-solution.md new file mode 100644 index 0000000..58b0135 --- /dev/null +++ b/docs/adrs/2023-03-23-cicd-solution.md @@ -0,0 +1,19 @@ +# Title + +Date: 2023-03-23 + +## Status + +__PROPOSED__ + +## Context + +We need to dicide on a CI/CD solution for our project, so we can automate certain tasks, e.g., building, testing, releasing, etc.. + +## Decision + +We decided to use Github Action Workflows because we already use Github for other related tasks, such as branch naming and protection rules, and therfore we have all of our configuration in one place. + +## Consequences + +What are the consequences of the change? What will be more difficult? What will be easier? \ No newline at end of file diff --git a/docs/adrs/2023-03-DD-cicd-solution.md b/docs/adrs/2023-03-DD-cicd-solution.md deleted file mode 100644 index 2c75292..0000000 --- a/docs/adrs/2023-03-DD-cicd-solution.md +++ /dev/null @@ -1,26 +0,0 @@ -# Title - -Date: YYYY-MM-DD - -## Status - -What is the status if the ADR? - -Possible options: -* __PROPOSED__ -* __ACCEPTED__ -* __REJECTED__ -* __DEPRECATED__ (include reference to the superseding ADR) -* __SUPERSEDED__ (include reference to the deprecating ADR) - -## Context - -What is the context of this ADR? What is the issue that we are seeing? What is motivating this decision or change? - -## Decision - -What is the change we are proposing? What do we plan on doing to solve the issue? - -## Consequences - -What are the consequences of the change? What will be more difficult? What will be easier? \ No newline at end of file From 01afee7fee101b3e1f6ee02aa3c152333fdd535a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Hofst=C3=A4tter?= Date: Thu, 23 Mar 2023 15:46:11 +0100 Subject: [PATCH 5/8] test signed commit --- docs/adrs/2023-03-23-cicd-solution.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adrs/2023-03-23-cicd-solution.md b/docs/adrs/2023-03-23-cicd-solution.md index 58b0135..0be064f 100644 --- a/docs/adrs/2023-03-23-cicd-solution.md +++ b/docs/adrs/2023-03-23-cicd-solution.md @@ -16,4 +16,4 @@ We decided to use Github Action Workflows because we already use Github for othe ## Consequences -What are the consequences of the change? What will be more difficult? What will be easier? \ No newline at end of file +What are the consequences of the change? What will be more difficult? What will be easier? From d76f5501d09307abe4f405bc989f8fc25208b9ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Hofst=C3=A4tter?= Date: Thu, 23 Mar 2023 15:59:06 +0100 Subject: [PATCH 6/8] Fix commit sign --- docs/adrs/2023-03-23-cicd-solution.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/adrs/2023-03-23-cicd-solution.md b/docs/adrs/2023-03-23-cicd-solution.md index 0be064f..3193902 100644 --- a/docs/adrs/2023-03-23-cicd-solution.md +++ b/docs/adrs/2023-03-23-cicd-solution.md @@ -17,3 +17,4 @@ We decided to use Github Action Workflows because we already use Github for othe ## Consequences What are the consequences of the change? What will be more difficult? What will be easier? + From 9f465ade5338d93d67ba8458eeddc971f8c52acd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Hofst=C3=A4tter?= Date: Thu, 23 Mar 2023 16:28:40 +0100 Subject: [PATCH 7/8] Finish CICD ADR --- docs/adrs/2023-03-23-cicd-solution.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/adrs/2023-03-23-cicd-solution.md b/docs/adrs/2023-03-23-cicd-solution.md index 3193902..14c68b7 100644 --- a/docs/adrs/2023-03-23-cicd-solution.md +++ b/docs/adrs/2023-03-23-cicd-solution.md @@ -12,9 +12,8 @@ We need to dicide on a CI/CD solution for our project, so we can automate certai ## Decision -We decided to use Github Action Workflows because we already use Github for other related tasks, such as branch naming and protection rules, and therfore we have all of our configuration in one place. +Some choices for our CICD platform would be GitHub Actions, Tekton, Jenkins or Argo CD. Solutions like Tekton or Argo CD are build up upon Kubernetes, are cloud-native and platform agnostic. GitHub Actions workflows are much simpler and only require a yaml file for configuration. We decided to use GitHub Actions workflows because we already use GitHub for other related tasks, such as branch naming and protection rules, and therfore we have all of our configuration in one place. Additionally, GitHub Actions are much easier to setup and there are many already existing yaml configurations we can build up upon. ## Consequences -What are the consequences of the change? What will be more difficult? What will be easier? - +By choosing GitHub Action workflows, compared to running custom workflows in a Kubernetes environment with other solutions, we have a much simpler setup. But we are also more limited in our possibilities, as you have more options in a custom Kubernetes cluster. From 969b92b7f96b2c2ec856128de388233cb6da65be Mon Sep 17 00:00:00 2001 From: Daniel Date: Sat, 25 Mar 2023 01:53:03 +0100 Subject: [PATCH 8/8] Some small changes to cicd ADR --- docs/adrs/2023-03-23-cicd-solution.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adrs/2023-03-23-cicd-solution.md b/docs/adrs/2023-03-23-cicd-solution.md index 14c68b7..03da31d 100644 --- a/docs/adrs/2023-03-23-cicd-solution.md +++ b/docs/adrs/2023-03-23-cicd-solution.md @@ -12,7 +12,7 @@ We need to dicide on a CI/CD solution for our project, so we can automate certai ## Decision -Some choices for our CICD platform would be GitHub Actions, Tekton, Jenkins or Argo CD. Solutions like Tekton or Argo CD are build up upon Kubernetes, are cloud-native and platform agnostic. GitHub Actions workflows are much simpler and only require a yaml file for configuration. We decided to use GitHub Actions workflows because we already use GitHub for other related tasks, such as branch naming and protection rules, and therfore we have all of our configuration in one place. Additionally, GitHub Actions are much easier to setup and there are many already existing yaml configurations we can build up upon. +Some choices for our CICD platform would be GitHub Actions, Tekton, Jenkins or Argo CD. Solutions like Tekton or Argo CD are build up upon Kubernetes, are cloud-native and platform agnostic. GitHub Actions workflows are much simpler, have predefined workflow steps and only require a yaml file for configuration. We decided to use GitHub Actions workflows because we already use GitHub for other related tasks, such as branch naming and protection rules, and therfore we have all of our configuration in one place. Additionally, GitHub Actions are much easier to setup and there are many already existing yaml configurations we can build up upon. ## Consequences