Skip to content

Commit 02ff272

Browse files
committed
Add a breaking changes warning and an explanation of legacy with main-db1.
1 parent 247d812 commit 02ff272

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

.github/workflows/prerelease-on-merge-to-main.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- main
7+
- main-db1
78
schedule:
89
- cron: '0 23 * * 1-5' # This is 1:00 AM Berlin time from Monday to Friday
910
workflow_dispatch: # Allows manual triggering
@@ -274,6 +275,8 @@ jobs:
274275
run: |
275276
if [ "${{ github.ref }}" == "refs/heads/main" ]; then
276277
echo "tag=main" >> $GITHUB_OUTPUT
278+
elif [ "${{ github.ref }}" == "refs/heads/main-db1" ]; then
279+
echo "tag=legacy" >> $GITHUB_OUTPUT
277280
else
278281
echo "tag=develop" >> $GITHUB_OUTPUT
279282
fi

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,29 @@
1+
## ⚠️ Important Notice: Breaking Changes in `main`
2+
3+
The `main` branch contains **breaking changes** compared to previous versions of the system.
4+
5+
These changes may require adjustments in existing integrations, configurations, or deployments. Please review the changes carefully before upgrading.
6+
7+
### What This Means
8+
- Existing setups may no longer work without modification
9+
- Migration effort may be required
10+
- Db Schema has changed
11+
- -NET 9.0 is used now
12+
13+
### Legacy Support
14+
15+
If you need to continue working with the previous version, please use the dedicated legacy branch:
16+
17+
➡️ **`main-db1`**
18+
19+
This branch is maintained to support the older version and ensure compatibility with existing systems. Docker images for main-db1 are tagged legacy.
20+
21+
### Recommendation
22+
23+
- Use `main` for all **new development** and future-ready integrations
24+
- Use `main-db1` only if you depend on the **legacy implementation**
25+
26+
127
# Eclipse AASPE Server
228

329
> ### Status

0 commit comments

Comments
 (0)