Skip to content
Open
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ Slopsmith uses a **release-centric branching model**. Each version gets its own

| Repo | Role |
|---|---|
| `got-feedback/feedback` | Core — FastAPI server, plugin loader, Docker image |
| `got-feedback/feedback-desktop` | Desktop — Electron wrapper, native audio engine |
| `got-feedback/feedback-plugin-*` | Org plugins — bundled in desktop, lighter governance |
| `got-feedback/feedBack` | Core — FastAPI server, plugin loader, Docker image |
| `got-feedback/feedBack-desktop` | Desktop — Electron wrapper, native audio engine |
| `got-feedback/feedBack-plugin-*` | Org plugins — bundled in desktop, lighter governance |
2 changes: 1 addition & 1 deletion docs/github-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Issue forms gate new issue submissions to a structured format. Disable blank iss
### config.yml — disable blank issues

```yaml
# .github/ISSUE_TEMPLATE/config.yml (in got-feedback/feedback and got-feedback/feedback-desktop)
# .github/ISSUE_TEMPLATE/config.yml (in got-feedback/feedBack and got-feedback/feedBack-desktop)
blank_issues_enabled: false
contact_links:
- name: Plugin issues
Expand Down
2 changes: 1 addition & 1 deletion docs/guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DevOps Guidelines

Guidelines for contributors to `got-feedback/feedback` and `got-feedback/feedback-desktop`. For plugin-specific rules see [plugins.md](plugins.md).
Guidelines for contributors to `got-feedback/feedBack` and `got-feedback/feedBack-desktop`. For plugin-specific rules see [plugins.md](plugins.md).

---

Expand Down
6 changes: 3 additions & 3 deletions docs/pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,15 @@ Trigger: `workflow_dispatch` on `slopsmith-desktop` with inputs:

## Plugin-lock pinning

Org plugins (`got-feedback/feedback-plugin-*`) are cloned by the desktop build at build time. For release builds, they are pinned to specific commits recorded in `plugin-lock.json` on the active `release/*` branch. Nightlies always use tip.
Org plugins (`got-feedback/feedBack-plugin-*`) are cloned by the desktop build at build time. For release builds, they are pinned to specific commits recorded in `plugin-lock.json` on the active `release/*` branch. Nightlies always use tip.

`plugin-lock.json` is created when the release branch is cut (see [runbooks/release.md](../runbooks/release.md)) and can be updated via PR on the release branch if a specific plugin fix needs to ship in the release.

Format:
```json
{
"got-feedback/feedback-plugin-notedetect": "abc1234",
"got-feedback/feedback-plugin-piano": "def5678",
"got-feedback/feedBack-plugin-notedetect": "abc1234",
"got-feedback/feedBack-plugin-piano": "def5678",
"masc0t/slopsmith-plugin-find-more": "ghi9012"
}
```
10 changes: 5 additions & 5 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Slopsmith distinguishes three plugin tiers with different integration levels and

| Tier | Location | Ships via | Versioned with core |
|---|---|---|---|
| **Core plugins** (`bundled: true`) | `got-feedback/feedback/plugins/` | Docker image + desktop | Yes — tied to core release |
| **Org plugins** | `got-feedback/feedback-plugin-*` repos | Desktop only | No — independent cadence |
| **Core plugins** (`bundled: true`) | `got-feedback/feedBack/plugins/` | Docker image + desktop | Yes — tied to core release |
| **Org plugins** | `got-feedback/feedBack-plugin-*` repos | Desktop only | No — independent cadence |
| **Community plugins** | Personal accounts | Desktop only | No — migration target |

---

## Core plugins

Core plugins have `"bundled": true` in their `plugin.json`. They live directly in the `got-feedback/feedback` repository under `plugins/` and are the source of truth for what ships in the Docker image.
Core plugins have `"bundled": true` in their `plugin.json`. They live directly in the `got-feedback/feedBack` repository under `plugins/` and are the source of truth for what ships in the Docker image.

**Governance:** full core contribution workflow applies.
- PR required, CI must pass, 1 approval required
Expand All @@ -34,7 +34,7 @@ Core plugins have `"bundled": true` in their `plugin.json`. They live directly i

## Org plugins

Org plugins live in their own repos under the `slopsmith` GitHub org (`got-feedback/feedback-plugin-*`). The desktop build clones them at build time via `build-common.sh`.
Org plugins live in their own repos under the `slopsmith` GitHub org (`got-feedback/feedBack-plugin-*`). The desktop build clones them at build time via `build-common.sh`.

**Governance:** lighter model. Plugin authors own their workflow.

Expand All @@ -57,7 +57,7 @@ The full core contribution guidelines apply only when a plugin is integrated int
**Reusable CI workflow:** the `plugin-lint` job is defined as a reusable workflow in this repo. Org plugin repos call it rather than maintaining their own lint logic:

```yaml
# .github/workflows/ci.yml in any got-feedback/feedback-plugin-* repo
# .github/workflows/ci.yml in any got-feedback/feedBack-plugin-* repo
jobs:
plugin-lint:
uses: slopsmith/.github/.github/workflows/plugin-lint.yml@main
Expand Down
6 changes: 3 additions & 3 deletions runbooks/hotfix.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Step-by-step checklist for applying an urgent fix to an already-shipped version.
### 1 — Branch from the release branch

```bash
# In got-feedback/feedback
# In got-feedback/feedBack
git fetch origin
git checkout release/vX.Y.Z
git checkout -b hotfix/<issue-number>-short-description
```

Do the same in `got-feedback/feedback-desktop` if the fix touches desktop code.
Do the same in `got-feedback/feedBack-desktop` if the fix touches desktop code.

### 2 — Fix and PR

Expand All @@ -51,7 +51,7 @@ Monitor `release.yml` — Docker image should appear on GHCR as `:vX.Y.Z+1`.
### 5 — Tag desktop

```bash
# In got-feedback/feedback-desktop, on release/vX.Y.Z
# In got-feedback/feedBack-desktop, on release/vX.Y.Z
git tag vX.Y.Z+1
git push origin vX.Y.Z+1
```
Expand Down
2 changes: 1 addition & 1 deletion runbooks/plugin-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Change the entry in `scripts/build-common.sh` from the personal account to the o
<author>/slopsmith-plugin-<name>

# After
got-feedback/feedback-plugin-<name>
got-feedback/feedBack-plugin-<name>
```

Open a PR on the active `release/*` branch of `slopsmith-desktop`. Also update `plugin-lock.json` to point to the new repo's HEAD commit.
Expand Down
6 changes: 3 additions & 3 deletions runbooks/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Step-by-step checklist for cutting a Slopsmith release. Follow in order — step

Do this at the beginning of a development cycle, not just before shipping.

- [ ] Open a milestone tracking issue: **"vX.Y.Z milestone"** in `got-feedback/feedback` listing all planned features. Link relevant issues to it.
- [ ] Open a milestone tracking issue: **"vX.Y.Z milestone"** in `got-feedback/feedBack` listing all planned features. Link relevant issues to it.
- [ ] Cut `release/vX.Y.Z` from `main` on **core**:
```bash
git checkout main && git pull
Expand Down Expand Up @@ -38,14 +38,14 @@ Repeat as needed throughout the development cycle.
- [ ] Confirm CI is green on `release/vX.Y.Z` in both repos
- [ ] Tag core:
```bash
# In got-feedback/feedback, on release/vX.Y.Z
# In got-feedback/feedBack, on release/vX.Y.Z
git tag vX.Y.Z-alpha.1 # or -beta.1, etc.
git push origin vX.Y.Z-alpha.1
```
- [ ] Monitor `release.yml` on core — Docker image should appear on GHCR within ~5 minutes
- [ ] Tag desktop with the same tag:
```bash
# In got-feedback/feedback-desktop, on release/vX.Y.Z
# In got-feedback/feedBack-desktop, on release/vX.Y.Z
git tag vX.Y.Z-alpha.1
git push origin vX.Y.Z-alpha.1
```
Expand Down
2 changes: 1 addition & 1 deletion scripts/apply-ruleset-core-checks.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# apply-ruleset-core-checks.sh
#
# Applies the core-only CI checks to got-feedback/feedback:
# Applies the core-only CI checks to got-feedback/feedBack:
# ci / tailwind-fresh
# ci / manifest-validation
#
Expand Down
2 changes: 1 addition & 1 deletion scripts/apply-ruleset-core.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# apply-ruleset-core.sh
#
# Applies branch protection to got-feedback/feedback and got-feedback/feedback-desktop.
# Applies branch protection to got-feedback/feedBack and got-feedback/feedBack-desktop.
#
# Two rulesets per repo:
# branch-protection (always active) — no force push/delete, PR + 1 approval
Expand Down
2 changes: 1 addition & 1 deletion scripts/apply-ruleset-plugins.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# apply-ruleset-plugins.sh
#
# Applies branch protection to org plugin repos (got-feedback/feedback-plugin-*).
# Applies branch protection to org plugin repos (got-feedback/feedBack-plugin-*).
#
# Two rulesets per repo:
# plugin-branch-protection (always active) — no force push/delete
Expand Down