chore: introduce the stable-4.x branch (#2888)

### Description

Related to https://github.com/libretime/libretime/issues/2887
This commit is contained in:
Jonas L 2024-01-13 12:50:51 +01:00 committed by GitHub
parent 4c40fab58e
commit f6d57d5f2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 27 additions and 26 deletions

View File

@ -10,7 +10,7 @@
"automerge": true, "automerge": true,
"automergeType": "branch" "automergeType": "branch"
}, },
"baseBranches": ["main", "stable"], "baseBranches": ["main"],
"labels": ["dependencies"], "labels": ["dependencies"],
"packageRules": [ "packageRules": [
{ {

View File

@ -3,7 +3,7 @@ name: Analyzer
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/analyzer.yml - .github/workflows/analyzer.yml
@ -12,7 +12,7 @@ on:
- tools/python* - tools/python*
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/analyzer.yml - .github/workflows/analyzer.yml

View File

@ -3,7 +3,7 @@ name: API Client
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/api-client.yml - .github/workflows/api-client.yml
@ -12,7 +12,7 @@ on:
- tools/python* - tools/python*
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/api-client.yml - .github/workflows/api-client.yml

View File

@ -3,7 +3,7 @@ name: API
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/api.yml - .github/workflows/api.yml
@ -12,7 +12,7 @@ on:
- tools/python* - tools/python*
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/api.yml - .github/workflows/api.yml

View File

@ -3,9 +3,9 @@ name: Container
on: on:
push: push:
tags: ["[0-9]+.[0-9]+.[0-9]+*"] tags: ["[0-9]+.[0-9]+.[0-9]+*"]
branches: [main, stable] branches: [main, stable-*]
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}

View File

@ -2,14 +2,14 @@ name: Docs
on: on:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/vale/** - .github/vale/**
- .github/workflows/docs.yml - .github/workflows/docs.yml
- docs/** - docs/**
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/vale/** - .github/vale/**
- .github/workflows/docs.yml - .github/workflows/docs.yml

View File

@ -3,14 +3,14 @@ name: Legacy
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/legacy.yml - .github/workflows/legacy.yml
- api/** - api/**
- legacy/** - legacy/**
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/legacy.yml - .github/workflows/legacy.yml
- api/** - api/**

View File

@ -3,7 +3,7 @@ name: Playout
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/playout.yml - .github/workflows/playout.yml
@ -13,7 +13,7 @@ on:
- tools/python* - tools/python*
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/playout.yml - .github/workflows/playout.yml

View File

@ -3,10 +3,10 @@ name: Project
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
pull_request: pull_request:
types: [opened, reopened, synchronize, edited] types: [opened, reopened, synchronize, edited]
branches: [main, stable] branches: [main, stable-*]
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}

View File

@ -3,7 +3,7 @@ name: Shared
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/shared.yml - .github/workflows/shared.yml
@ -11,7 +11,7 @@ on:
- tools/python* - tools/python*
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/shared.yml - .github/workflows/shared.yml

View File

@ -3,7 +3,7 @@ name: Worker
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/worker.yml - .github/workflows/worker.yml
@ -11,7 +11,7 @@ on:
- tools/python* - tools/python*
pull_request: pull_request:
branches: [main, stable] branches: [main, stable-*]
paths: paths:
- .github/workflows/_python.yml - .github/workflows/_python.yml
- .github/workflows/worker.yml - .github/workflows/worker.yml

View File

@ -13,8 +13,8 @@ LibreTime development workflows follow the standardized [C4 development process]
- [2.4. Development Process](https://rfc.zeromq.org/spec/42/#24-development-process) - [2.4. Development Process](https://rfc.zeromq.org/spec/42/#24-development-process)
- `16.` Maintainers MAY NOT merge incorrect patches. - `16.` Maintainers MAY NOT merge incorrect patches.
- [2.5. Branches and Releases](https://rfc.zeromq.org/spec/42/#25-branches-and-releases) - [2.5. Branches and Releases](https://rfc.zeromq.org/spec/42/#25-branches-and-releases)
- `1.` The project SHALL have a development branch (`main`) that always holds the latest in-progress version and SHOULD always build. The project MAY have a bug fixes only branch (`stable`) that always holds the current stable version and SHOULD always build. - `1.` The project SHALL have a development branch (`main`) that always holds the latest in-progress version and SHOULD always build. The project MAY have a bug fixes only branch (`stable-*`) that always holds the current stable version and SHOULD always build.
- `3.` To make a stable release a Maintainer shall tag the repository. Stable releases SHALL always be released from the repository `main` or `stable` branches. - `3.` To make a stable release a Maintainer shall tag the repository. Stable releases SHALL always be released from the repository `main` or `stable-*` branches.
## Contribute financially ## Contribute financially

View File

@ -7,7 +7,7 @@ title: Development workflows
LibreTime uses [Github pull requests to manage changes](https://docs.github.com/en/get-started/quickstart/contributing-to-projects). The workflow looks like this: LibreTime uses [Github pull requests to manage changes](https://docs.github.com/en/get-started/quickstart/contributing-to-projects). The workflow looks like this:
- [Create a fork of the project](https://docs.github.com/en/get-started/quickstart/fork-a-repo). - [Create a fork of the project](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
- Check out the `main` branch. If you're making a minor or small documentation change you can check out the `stable` branch. - Check out the `main` branch.
- Create a new branch based on the checked out branch. - Create a new branch based on the checked out branch.
- Work on your changes locally. Try to keep each commit small to make reviews easier. - Work on your changes locally. Try to keep each commit small to make reviews easier.
- Lint and test the codebase, for example using the `make lint` or `make test` commands inside the app folder you want to check. - Lint and test the codebase, for example using the `make lint` or `make test` commands inside the app folder you want to check.

View File

@ -15,8 +15,8 @@ Once a release is desired, checkout the release branch:
```bash ```bash
# For a release on the main branch # For a release on the main branch
git checkout release-please--branches--main--components--libretime git checkout release-please--branches--main--components--libretime
# For a release on the stable branch # For a release on the stable-4.x branch
git checkout release-please--branches--stable--components--libretime git checkout release-please--branches--stable-4.x--components--libretime
``` ```
### 2. Release note ### 2. Release note

View File

@ -30,3 +30,4 @@ New releases target the current stable distributions release, and development sh
| Versions | | | | | | Versions | | | | |
| 3.0.x | deprecated | deprecated | recommended | recommended | | 3.0.x | deprecated | deprecated | recommended | recommended |
| 3.1.x | | | recommended | recommended | | 3.1.x | | | recommended | recommended |
| 4.0.x | | | recommended | recommended |