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
28 changes: 5 additions & 23 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release

How the AI-Driven Dev Framework ships, and what to follow when you open a change. Weekly rolling releases, with a fast lane for urgent fixes.
How ships, and what to follow when you open a change. Weekly rolling releases, with a fast lane for urgent fixes.

- Branch naming, commit format, release tooling β†’ [`aidd_docs/memory/vcs.md`](aidd_docs/memory/vcs.md).
- Who may merge and release β†’ [`GOVERNANCE.md`](GOVERNANCE.md).
Expand All @@ -10,7 +10,7 @@ How the AI-Driven Dev Framework ships, and what to follow when you open a change
- `main` is production. The marketplace tracks it, so users only ever get released, versioned code.
- `next` is integration. The week's work batches here, and ships in one weekly release.
- A release happens only when there is work, and is cut automatically by release-please.
- A `hotfix/*` skips `next`: it branches from `main` and ships its own release out of cycle, for urgent production fixes.
- A `hotfix/*` skips `next`, it branches from `main` and ships its own release out of cycle, for urgent production fixes.

## πŸ”€ Where your change goes

Expand All @@ -27,34 +27,16 @@ flowchart LR
hotfix["hotfix/*"] -->|PR| main
```

Two merges reach `main`: the weekly promotion PR from `next`, then the auto-merged Release PR that release-please raises.

## 🏷️ What your commit produces

The commit type drives the changelog section it lands under.

| Commit type | Changelog section |
| ----------- | ----------------- |
| `feat` | Features |
| `fix` | Bug Fixes |
| `perf` | Performance |
| `refactor` | Refactoring |
| `docs` | Documentation |
| `chore` | Miscellaneous |
| `revert` | Reverts |

The version bump is release-please's call: `feat` β†’ minor, `fix` β†’ patch, a `!` suffix or `BREAKING CHANGE` footer β†’ major. The other types ride along in a release triggered by a `feat` or `fix`.

## πŸ›Ÿ The two rules that keep it safe

- **The Release PR is auto-merged.** Otherwise `main` briefly holds merged but unversioned code, and a new user installing in that window picks it up.
- **The `main` β†’ `next` back-merge is automatic.** Otherwise the version manifest and the changelog on `next` drift from `main`.

## πŸ—“οΈ Weekly release, step by step

1. Open the promotion PR `next` β†’ `main` once the week's work is ready.
2. release-please opens a Release PR on `main`; it is auto-merged.
3. Tags and version bumps are created; release artifacts are attached.
1. Open the [promotion `next` to `main`](https://github.com/ai-driven-dev/framework/actions/workflows/promote.yml) once the week's work is ready.
2. release-please opens a Release PR on `main`: it is auto-merged.
3. Tags and version bumps are created, release artifacts are attached.
4. `main` is back-merged into `next` automatically.

## πŸš‘ Hotfix
Expand Down
11 changes: 7 additions & 4 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# Roadmap

The live roadmap is the [AIDD Roadmap board](https://github.com/orgs/ai-driven-dev/projects/8): a milestone is a theme, due on a Thursday, and everything without one is the backlog, ordered by priority. That board is the single source of truth.
The live roadmap is the [AIDD Roadmap board](https://github.com/orgs/ai-driven-dev/projects/8): a milestone is a theme, due on a Thursday, and everything without one is the backlog, ordered by priority.

That board is the single source of truth.

Shipped reality lives in [`CHANGELOG.md`](./CHANGELOG.md).

## How to influence

Priority is set by a community vote β€” mechanism (who votes, weighting, polls) in [`GOVERNANCE.md`](./GOVERNANCE.md#-roadmap-voting).
Priority is set by a community vote, full mechanism (who votes, weighting, polls) in [`GOVERNANCE.md`](./GOVERNANCE.md#-roadmap-voting).

To influence it:

- Open an issue or an idea in [GitHub Discussions](https://github.com/ai-driven-dev/framework/discussions) and πŸ‘ / upvote what you want.
- Weekly sync: Thursdays 10:30 on the [Framework channel on Discord](https://discord.com/channels/1173363373115723796/1512081578858119238) decides what the next milestone contains.
- Decide with us on Weekly Discord Event : [Framework Evolution πŸ‡«πŸ‡·πŸ₯–](https://discord.gg/DyzRuZ7SF?event=1514565536695193710)
- Open an issue or an idea in [GitHub Discussions](https://github.com/ai-driven-dev/framework/discussions), and πŸ‘ / upvote what you want.
- Discuss on [Framework channel on Discord](https://discord.com/channels/1173363373115723796/1512081578858119238).
- Sponsored work: see [`.github/FUNDING.yml`](./.github/FUNDING.yml).
197 changes: 0 additions & 197 deletions UPGRADE.md

This file was deleted.