Files
sencho/MANUAL_STEPS.md
T
Anso 9f9de482ce chore: GitHub workflow revamp — GitHub Flow, community files, CI updates (#101)
* chore: add comprehensive .gitignore

* ci: update CI workflow for GitHub Flow

- Change triggers from develop to main (PRs to main + pushes to main)
- Add concurrency controls to cancel stale runs
- Update docker/build-push-action to v6
- Add descriptive job names for branch protection status checks
- Update screenshot refresh and docs sync to trigger on main pushes

* ci: update docker-publish for GitHub Flow

- Remove develop branch trigger (no more dev tag)
- Keep v* tag trigger for releases
- Update docker/build-push-action to v6

* docs: add community and governance files

- CONTRIBUTING.md with dev setup and PR guidelines
- SECURITY.md with vulnerability reporting policy
- CODE_OF_CONDUCT.md (Contributor Covenant v2.1 reference)
- PR template with conventional commits checklist
- Issue templates for bug reports and feature requests
- CODEOWNERS defaulting to @AnsoCode
- Dependabot config for npm (root, backend, frontend) and GitHub Actions

* docs: add README with badges, quick start, and contributing section

* chore: add LICENSE placeholder and open license decision issue (#100)

* docs: update CLAUDE.md for GitHub Flow branching model

- Replace develop-based Git Flow with GitHub Flow (main only)
- All branches now created off main, PRs target main
- Simplify release checklist (no develop-to-main merge step)
- Update testing strategy to reference Vitest and Playwright
- Fix docs.json reference (was mint.json)

* chore: track CLAUDE.md in version control

Remove CLAUDE.md from .gitignore so project workflow instructions
are versioned alongside the code they govern.

* docs: add MANUAL_STEPS.md for GitHub settings that require UI configuration
2026-03-24 22:32:44 -04:00

2.1 KiB

Manual Steps Required

These actions could not be performed automatically and need to be done manually in the GitHub UI.

1. Branch Protection Rules for main

Go to Settings > Branches > Add branch ruleset for main:

  • Require a pull request before merging
    • Required approvals: 0 (solo dev — you merge your own PRs after CI passes)
    • Dismiss stale reviews when new commits are pushed: ON
  • Require status checks to pass before merging
    • Add these job names: Backend (Build, Test, Lint), Frontend (Build, Lint), Docker Build & Scan, E2E Tests (Playwright)
  • Require conversation resolution before merging
  • Do not allow bypassing the above settings (even you must go through PRs)
  • Do not allow deletions
  • Require signed commits (optional — future improvement)

2. Repository Settings

Go to Settings > General > Pull Requests:

  • Check "Automatically delete head branches"
  • Set squash merge as default merge strategy

3. Security Settings

Go to Settings > Code security and analysis:

  • Enable Dependabot alerts
  • Enable Dependabot security updates
  • Enable Secret scanning
  • Enable Secret scanning push protection
  • Enable Private vulnerability reporting

4. Default Branch

Verify that main is set as the default branch:

  • Go to Settings > Branches > Default branch
  • Should already be main

5. Delete develop Branch (When Ready)

The develop branch has 1 unmerged commit (37f751c docs: refresh screenshots).

Before deleting, decide whether to:

  • Cherry-pick that commit to main via a PR, OR
  • Let it go (it's just a screenshot refresh)

Then delete via: Branches page > delete develop

Also clean up stale feature branches that have been merged:

  • chore/refresh-screenshots
  • fix/editor-loading
  • fix/release-please-config
  • feat/automated-versioning
  • fix/docker-publish-tag-trigger
  • feat/arm64-docker-build
  • chore/migrate-to-docs-json
  • fix/sync-docs-rsync-excludes-git
  • fix/ci-docs-jobs, fix/ci-docs-jobs-v2

6. Delete This File

Once all manual steps are complete, delete MANUAL_STEPS.md from the repo.