Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ This guide covers how to contribute code to WLAN Pi projects. For setting up you
branches from `main`, and open pull requests against `main`. The exception is
`wlanpi-kernel`, which keeps one branch per kernel version.

**Debian suite branches** (`debian/<codename>`, e.g. `debian/bullseye`):
- Maintained by the core team only. These preserve support for older Debian releases and are not targets for regular contributor PRs.
- Build matrices on these branches are scoped to their specific suite only.
**Debian suite branches** (`debian/bookworm`, `debian/bullseye`):
- Use these branches only for a hotfix to an old release.
- A hotfix uses that suite branch and that suite's Python. Bookworm is 3.11. Bullseye is 3.9.

See [Repository Reference](REPOS.md) for each repo's default branch.

Expand Down
2 changes: 1 addition & 1 deletion GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ sudo journalctl -u wlanpi-service -f
| Document | Purpose |
|----------|---------|
| [Contributing](CONTRIBUTING.md) | How to contribute code |
| [Repository Reference](REPOS.md) | Stable map of each repo: default branch, package, and how it builds and releases |
| [Repository Reference](REPOS.md) | What each repo should be: role, package, and the build standard |
| [Release Process](RELEASE_PROCESS.md) | Core team release procedures |
| [Packaging Example](PACKAGING_EXAMPLE.md) | Complete packaging tutorial |
| [Architecture](architecture/README.md) | System design and standards |
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ serves HTTPS, for example with Cloudflare redirect rules or GitHub Pages.
| Document | Description |
|----------|-------------|
| [Getting Started](GETTING_STARTED.md) | Development environment setup and first contribution guide |
| [Repository Reference](REPOS.md) | Stable map of each repo: default branch, package, and how it builds and releases |
| [Repository Reference](REPOS.md) | What each repo should be: role, package, and the build standard |
| [Git Workflow Guide](GIT_WORKFLOW.md) | Git fundamentals for beginners |
| [Contributing](CONTRIBUTING.md) | Detailed Git workflow, branch naming, PR guidelines, and code review |
| [Packaging Example](PACKAGING_EXAMPLE.md) | Complete walkthrough of creating a Debian package from scratch |
Expand Down
22 changes: 10 additions & 12 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,17 @@ General branching strategy. May vary per repo.
| Branch | Purpose |
|--------|---------|
| `main` | Only long-lived development branch; PRs target it |
| `debian/<codename>` | Preserved support for older Debian suites (core team only) |
| `debian/bookworm`, `debian/bullseye` | Hotfix to an old release only |
| `feature/<desc>` | Shared long-term feature work |
| `fix/<desc>` | Bug fix branches |
| `chore/<desc>`, `docs/<desc>`, `ci/<desc>` | Non-feature maintenance |
| `security/<desc>` | Security fixes |
| `hotfix/<desc>` | Urgent fixes against `main` |
| `release/<version>` | Version bump for a release |

> `debian/<codename>` branches (e.g. `debian/bullseye`)
> are maintained by the core team. They are branched from a known-good commit
> before trixie-targeted work began. Build matrices on these branches target
> only their specific suite. Contributors should not open PRs against these
> branches.
> `debian/bookworm` and `debian/bullseye` exist only for a hotfix to an old
> release. A hotfix uses that branch and that suite's Python. Bookworm is
> 3.11. Bullseye is 3.9.

### Branch rules

Expand Down Expand Up @@ -105,8 +103,9 @@ git tag -a v1.2.3 -m "Release version 1.2.3"
git push origin v1.2.3
```

Which deploy workflows call `tag-release` is recorded in
[REPOS.md](REPOS.md#applications).
Application deploy workflows call `tag-release`. See
[Standards](REPOS.md#standards). `pi-gen` and `wlanpi-kernel` follow
[Scope](RELEASING.md#scope).

## GitHub workflows

Expand Down Expand Up @@ -134,10 +133,9 @@ Maintained by:
- Workflow files in each repo, which call the reusable workflows above

Promotion from Packagecloud `wlanpi/dev` to `wlanpi/main` is still a manual step.
Deploy workflows upload to `wlanpi/dev` only. `wlanpi-desktop` is the only repo with `promote-to-main.yml`, and that
workflow runs only on `workflow_dispatch`. It builds the package and pushes
the `.deb` to `wlanpi/main`. See
[REPOS.md](REPOS.md#packagecloud-promotion). The planned replacement is [Publish a Release](RELEASING.md#publish-a-release).
Deploy workflows upload to `wlanpi/dev`. An upload to `wlanpi/main` when the
release pull request merges is planned. See
[REPOS.md](REPOS.md#standards) and [Publish a Release](RELEASING.md#publish-a-release).

### Version gate

Expand Down
Loading