Skip to content

Commit

Permalink
refactor: update branch names and references in our documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
paullatzelsperger committed Apr 14, 2023
1 parent 406e137 commit a08a28b
Show file tree
Hide file tree
Showing 21 changed files with 57 additions and 57 deletions.
16 changes: 8 additions & 8 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ version: 2
updates:
# Maven
-
package-ecosystem: "maven"
target-branch: develop
package-ecosystem: "gradle"
target-branch: main
directory: /
labels:
- "dependabot"
Expand All @@ -15,7 +15,7 @@ updates:
# Github Actions
-
package-ecosystem: "github-actions"
target-branch: develop
target-branch: main
directory: /
labels:
- "dependabot"
Expand All @@ -26,7 +26,7 @@ updates:
# Docker
-
package-ecosystem: "docker"
target-branch: develop
target-branch: main
directory: ./edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/src/main/docker/
labels:
- "dependabot"
Expand All @@ -35,7 +35,7 @@ updates:
interval: "daily"
-
package-ecosystem: "docker"
target-branch: develop
target-branch: main
directory: ./edc-controlplane/edc-controlplane-postgresql/src/main/docker/
labels:
- "dependabot"
Expand All @@ -44,7 +44,7 @@ updates:
interval: "daily"
-
package-ecosystem: "docker"
target-branch: develop
target-branch: main
directory: ./edc-controlplane/edc-controlplane-memory/src/main/docker/
labels:
- "dependabot"
Expand All @@ -53,7 +53,7 @@ updates:
interval: "daily"
-
package-ecosystem: "docker"
target-branch: develop
target-branch: main
directory: ./edc-dataplane/edc-dataplane-azure-vault/src/main/docker/
labels:
- "dependabot"
Expand All @@ -62,7 +62,7 @@ updates:
interval: "daily"
-
package-ecosystem: "docker"
target-branch: develop
target-branch: main
directory: ./edc-dataplane/edc-dataplane-hashicorp-vault/src/main/docker/
labels:
- "dependabot"
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ on:
push:
branches:
- main
- develop
- releases
tags:
- '[0-9]+.[0-9]+.[0-9]+'
release:
Expand Down Expand Up @@ -136,9 +136,9 @@ jobs:
packages: write
needs: [ secret-presence, build-controlplane, build-dataplane, build-extensions ]

# do not run on PR branches, do not run on main
# do not run on PR branches, do not run on releases
if: |
needs.secret-presence.outputs.GPG_PASSPHRASE && needs.secret-presence.outputs.GPG_PRIVATE_KEY && github.event_name != 'pull_request' && github.ref != 'refs/heads/main'
needs.secret-presence.outputs.GPG_PASSPHRASE && needs.secret-presence.outputs.GPG_PRIVATE_KEY && github.event_name != 'pull_request' && github.ref != 'refs/heads/releases'
steps:
# Set-Up
- name: Checkout
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/business-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ on:
- 'docs/**'
- '**/*.md'
branches:
- develop
- releases
- release/**
- main
workflow_dispatch:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/draft-new-release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
head: release/${{ github.event.inputs.version }}
base: main
base: releases
title: Release version ${{ github.event.inputs.version }}
reviewers: ${{ github.actor }}
body: |-
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/helm-chart-release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ on:
paths:
- 'charts/**'
branches:
- main
- releases
workflow_dispatch:

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/helm-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
push:
branches:
- main
- develop
- releases
tags:
- '[0-9]+.[0-9]+.[0-9]+'
paths-ignore:
Expand Down Expand Up @@ -50,7 +50,7 @@ jobs:
name: chart-testing (list-changed)
id: list-changed
run: |
changed=$(ct list-changed --config ct.yaml --target-branch develop)
changed=$(ct list-changed --config ct.yaml --target-branch main)
if [[ -n "$changed" ]]; then
echo "::set-output name=changed::true"
fi
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/kics.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: "KICS"

on:
push:
branches: [main, master, develop]
branches: [main, releases]
pull_request:
branches: [main, master, develop]
branches: [main, releases]
workflow_dispatch:

schedule:
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/publish-new-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: "Publish new release"
on:
pull_request:
branches:
- main
- releases
- support/*
types:
- closed
Expand Down Expand Up @@ -128,7 +128,7 @@ jobs:
git push origin gh-pages
# Release: GitHub tag & release; Merges back main into develop; Starts a new development cycle;
# Release: GitHub tag & release; Merges back releases into main; Starts a new development cycle;
github-release:
name: Publish new github release
needs: [ release-version ]
Expand All @@ -148,7 +148,7 @@ jobs:
name: Checkout
uses: actions/[email protected]
with:
# 0 to fetch the full history due to upcoming merge of main into develop branch
# 0 to fetch the full history due to upcoming merge of releases into main branch
fetch-depth: 0
-
name: Create Release Tag
Expand Down Expand Up @@ -185,15 +185,15 @@ jobs:
distribution: 'temurin'
cache: 'gradle'
-
name: Merge main back into develop and set new snapshot version
if: github.event.pull_request.base.ref == 'main'
name: Merge releases back into main and set new snapshot version
if: github.event.pull_request.base.ref == 'releases'
run: |
# Prepare git env
git config user.name "GitHub actions"
git config user.email [email protected]
# Merge main into develop
git checkout develop && git merge -X theirs main --no-commit --no-ff
# Merge releases into main
git checkout main && git merge -X theirs releases --no-commit --no-ff
# Extract release version
IFS=. read -r RELEASE_VERSION_MAJOR RELEASE_VERSION_MINOR RELEASE_VERSION_PATCH<<<"${{ env.RELEASE_VERSION }}"
Expand All @@ -204,8 +204,8 @@ jobs:
# Persist the "version" in the gradle.properties
sed -i "s/version=.*/version=$SNAPSHOT_VERSION/g" gradle.properties
# Commit and push to origin develop
# Commit and push to origin main
git add gradle.properties
git commit --message "Introduce new snapshot version $SNAPSHOT_VERSION"
git push origin develop
git push origin main
4 changes: 2 additions & 2 deletions .github/workflows/trivy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
workflows: ["Build"]
branches:
- main
- develop
- releases
- release/*
- hotfix/*
tags:
Expand Down Expand Up @@ -84,7 +84,7 @@ jobs:
if: always()
uses: aquasecurity/trivy-action@master
with:
image-ref: "ghcr.io/${{ github.repository }}/${{ matrix.image }}:sha-${{ needs.git-sha7.outputs.value }}"
image-ref: "tractusx/${{ matrix.image }}:sha-${{ needs.git-sha7.outputs.value }}"
format: "sarif"
output: "trivy-results-${{ matrix.image }}.sarif"
exit-code: "1"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/verify.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on:
push:
branches:
- main
- develop
- releases
tags:
- '[0-9]+.[0-9]+.[0-9]+'
release:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ spec:
## DATA PLANE ##
################

# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/develop/edc-extensions/dataplane-selector-configuration
# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/dataplane-selector-configuration
- name: "EDC_DATAPLANE_SELECTOR_DEFAULTPLANE_URL"
value: {{ include "txdc.dataplane.url.control" . }}/transfer
- name: "EDC_DATAPLANE_SELECTOR_DEFAULTPLANE_SOURCETYPES"
Expand Down Expand Up @@ -276,7 +276,7 @@ spec:
###########

{{- if .Values.vault.hashicorp.enabled }}
# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/develop/edc-extensions/hashicorp-vault
# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/hashicorp-vault
- name: "EDC_VAULT_HASHICORP_URL"
value: {{ .Values.vault.hashicorp.url | required ".Values.vault.hashicorp.url is required" | quote }}
- name: "EDC_VAULT_HASHICORP_TOKEN"
Expand Down Expand Up @@ -317,7 +317,7 @@ spec:
## DATA ENCRYPTION ##
#####################

# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/develop/edc-extensions/data-encryption
# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/data-encryption
- name: "EDC_DATA_ENCRYPTION_KEYS_ALIAS"
value: {{ .Values.vault.secretNames.transferProxyTokenEncryptionAesKey | quote }}
- name: "EDC_DATA_ENCRYPTION_ALGORITHM"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ spec:
###########

{{- if .Values.vault.hashicorp.enabled }}
# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/develop/edc-extensions/hashicorp-vault
# see extension https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/hashicorp-vault
- name: "EDC_VAULT_HASHICORP_URL"
value: {{ .Values.vault.hashicorp.url | required ".Values.vault.hashicorp.url is required" | quote }}
- name: "EDC_VAULT_HASHICORP_TOKEN"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To improve stability, reproducibility and maintainability of releases, tractusx-
- use release versions of EDC in releases. Release branches must not change upstream dependency versions, unless there
is a clear and concise reason to do so.
- slightly update branching model
- if possible, bugs/defects should be fixed on `develop` and be backported to the respective `hotfix/` branch
- if possible, bugs/defects should be fixed on `main` and be backported to the respective `hotfix/` branch
- only hotfixes for critical security bugs will be provided as defined by the committers for the
currently released version. Nothing else.
- feature development happens _in developers' forks only_ to keep the Git reflog of the `origin` clean.
Expand All @@ -31,15 +31,15 @@ Every release version published by tractusx-edc must be reproducible at any time

During feature development we only use `-SNAPSHOT` versions of EDC packages. It is assumed that when the build breaks
due to changes in upstream, the fix can be done quickly and easily, much more so than working off technical
debt that would otherwise accumulate over several months. Builds on `develop` are therefore _not repeatable_, but that
debt that would otherwise accumulate over several months. Builds on `main` are therefore _not repeatable_, but that
downside is easily offset by the tighter alignment with and smaller technical debt and integration pain with the
upstream EDC.

### Use release versions of EDC in releases

First, a new branch `releases/X.Y.Z` based off of `develop` is created. This can either be done
First, a new branch `release/X.Y.Z` based off of `main` is created. This can either be done
on `HEAD`, or - if desired - on a particular ref. The latter case is relevant if there are already features
in `develop` that are not scoped for a particular release.
in `main` that are not scoped for a particular release.

Second, the dependency onto EDC is updated to the most recent build. For example, if a release is
created on March 27th 2023, the most recent nightly would be `0.0.1-20230326`.
Expand Down Expand Up @@ -79,13 +79,13 @@ Once a release is published, for example `0.3.1` it will receive no further deve
hotfix branches are created based off of the release branch, here `releases/0.3.1`, thus, `hotfix/0.3.1`. From this,
three scenarios emerge:

1. The actual fix is done on `develop` and can be cherry-picked into the `hotfix/0.3.1` branch. No new commits are
1. The actual fix is done on `main` and can be cherry-picked into the `hotfix/0.3.1` branch. No new commits are
made directly in that branch.
2. The actual fix is done on `develop` and must be manually ported into the `hotfix/0.3.1` branch. One or several new
2. The actual fix is done on `main` and must be manually ported into the `hotfix/0.3.1` branch. One or several new
commits are made on `hotfix/0.3.1`. This is needed when cherry-picking is not available due to incompatibilities
between `develop` and the hotfix branch due to intermittent changes.
3. The fix is only relevant for the `0.3.1` hotfix, it is not needed in `develop`. This can happen, when the problem is
not present on `develop`, because it was already implicitly fixed, or otherwise doesn't exist.
between `main` and the hotfix branch due to intermittent changes.
3. The fix is only relevant for the `0.3.1` hotfix, it is not needed in `main`. This can happen, when the problem is
not present on `main`, because it was already implicitly fixed, or otherwise doesn't exist.

This might produce many branches, and the first `hotfix` makes the release obsolete, but it will greatly help
readability and make a release's history readily apparent.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ This section explains _at which point in time_ we should execute which test. Thi
| Unit test | when running tests locally, without any parameters, on every commit on every branch | |
| Integration test | on every commit on every branch | |
| System/End-To-End test | on pull request branches except when marked as `draft` | |
| Deployment test | before merging pull requests and on every commit on `develop` | |
| Deployment test | before merging pull requests and on every commit on `main` | |
| Performance test | Only on a specific schedule, e.g. once per day or week | |
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/edc-controlplane/edc-controlplane-memory-hashicorp-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/LICENSE)
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-memory-hashicorp-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)

## Used base image

Expand Down
4 changes: 2 additions & 2 deletions edc-controlplane/edc-controlplane-memory/notice.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/edc-controlplane/edc-controlplane-memory/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/LICENSE)
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-memory/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)

## Used base image

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/LICENSE)
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)

## Used base image

Expand Down
4 changes: 2 additions & 2 deletions edc-controlplane/edc-controlplane-postgresql/notice.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/edc-controlplane/edc-controlplane-postgresql/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/LICENSE)
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-postgresql/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)

## Used base image

Expand Down
4 changes: 2 additions & 2 deletions edc-dataplane/edc-dataplane-azure-vault/notice.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/edc-dataplane/edc-dataplane-azure-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/LICENSE)
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-dataplane/edc-dataplane-azure-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)

## Used base image

Expand Down
4 changes: 2 additions & 2 deletions edc-dataplane/edc-dataplane-hashicorp-vault/notice.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/edc-dataplane/edc-dataplane-hashicorp-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/develop/LICENSE)
- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-dataplane/edc-dataplane-hashicorp-vault/src/main/docker/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)

## Used base image

Expand Down
2 changes: 1 addition & 1 deletion pr_etiquette.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Submitting pull requests in EDC should be done while adhering to a couple of sim
- No surprise PRs please. Before you submit a PR, open a discussion or an issue outlining your planned work and give
people time to comment. It may even be advisable to contact committers using the `@mention` feature. Unsolicited PRs
may get ignored or rejected.
- Create your working branch in your fork of TractusX-EDC, and create the PR against the upstream `develop` branch
- Create your working branch in your fork of TractusX-EDC, and create the PR against the upstream `main` branch
- Create focused PRs: your work should be focused on one particular feature or bug. Do not create broad-scoped PRs that
solve multiple issues as reviewers may reject those PR bombs outright.
- Provide a clear description and motivation in the PR description in GitHub. This makes the reviewer's life much
Expand Down

0 comments on commit a08a28b

Please sign in to comment.