github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-07-16 07:04:23 -05:00
Code Issues 3.0k Packages Projects Releases 58 Wiki Activity

[PR #7729] [MERGED] [AI] Document Dev Container option in development-setup docs #126778

New Issue
Closed
opened 2026-06-14 06:10:55 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-06-14 06:10:55 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/7729
Author: @nikhilweee
Created: 5/6/2026
Status: ✅ Merged
Merged: 5/9/2026
Merged by: @MatissJanis

Base: master ← Head: docs-devcontainer-setup

📝 Commits (5)

  • 48ba21b [AI] Document Dev Container option in development-setup docs
  • 026b847 [AI] Add release notes for #7729
  • 030b564 [AI] Update spell-check dictionary for Codespaces
  • 6da4b22 Merge branch 'master' into docs-devcontainer-setup
  • a203d4a Merge branch 'master' into docs-devcontainer-setup

📊 Changes

4 files changed (+40 additions, -1 deletions)

View changed files

📝 .devcontainer/devcontainer.json (+1 -1)
📝 .github/actions/docs-spelling/expect.txt (+1 -0)
📝 packages/docs/docs/contributing/development-setup.md (+32 -0)
➕ upcoming-release-notes/7729.md (+6 -0)

📄 Description

Description

Documents two Docker-based alternatives to the local Node + Yarn setup in the contributor development-setup guide.

Background: the repo has shipped a .devcontainer/ config (and a root Dockerfile + docker-compose.yml) since June 2023 (#1032), but the canonical development-setup.md only ever covered the local Node + Yarn install path. The Dev Container option was only mentioned briefly in packages/desktop-client/README.md inside the VRT instructions — easy to miss.

Changes:

  • Added a :::tip admonition in the Prerequisites section pointing forward to the new options.
  • Added a ## Dev Container section that's tool-agnostic (mentions VS Code, Cursor, JetBrains Gateway, GitHub Codespaces, and the official @devcontainers/cli — since devcontainer.json is an open spec, not a VS Code-only thing).
  • Added a ## Docker Compose section for the plain docker compose up --build path, including a :::note about the native-modules gotcha (host node_modules/ compiled for macOS won't load in the Linux container).
  • Renamed the dev container from Actual development → Actual Devcontainer in .devcontainer/devcontainer.json for clarity (visible in VS Code's status bar and command palette).

Related issue(s)

Relates to #1032 (original Dev Container support, June 2023).

Testing

Both paths verified locally end-to-end:

  • Dev Container via VS Code → Reopen in Container → yarn install ran via postCreateCommand (~44s, including native module rebuilds for Linux), then yarn start inside the container → http://localhost:3001/ loaded successfully.
  • Docker Compose via docker compose up --build from the repo root → container started, Vite ready in ~750ms, curl http://localhost:3001 returned HTTP 200.
  • Pre-push CI checks passed locally: yarn lint (0 errors), yarn typecheck (success on all 6 workspaces), yarn test (success on all workspaces).

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/7729 **Author:** [@nikhilweee](https://github.com/nikhilweee) **Created:** 5/6/2026 **Status:** ✅ Merged **Merged:** 5/9/2026 **Merged by:** [@MatissJanis](https://github.com/MatissJanis) **Base:** `master` ← **Head:** `docs-devcontainer-setup` --- ### 📝 Commits (5) - [`48ba21b`](https://github.com/actualbudget/actual/commit/48ba21b05467320e6ee3d15f5fadbc8523fbbc91) [AI] Document Dev Container option in development-setup docs - [`026b847`](https://github.com/actualbudget/actual/commit/026b847ade7ed03db3e75c837528484c6bae4913) [AI] Add release notes for #7729 - [`030b564`](https://github.com/actualbudget/actual/commit/030b564f288bf0f8754fe0b3333e9fcf316e595d) [AI] Update spell-check dictionary for Codespaces - [`6da4b22`](https://github.com/actualbudget/actual/commit/6da4b22e7b8f15e78253db4d4968d565ea50581d) Merge branch 'master' into docs-devcontainer-setup - [`a203d4a`](https://github.com/actualbudget/actual/commit/a203d4ab915dced1a296ae7690353bd08fa082aa) Merge branch 'master' into docs-devcontainer-setup ### 📊 Changes **4 files changed** (+40 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `.devcontainer/devcontainer.json` (+1 -1) 📝 `.github/actions/docs-spelling/expect.txt` (+1 -0) 📝 `packages/docs/docs/contributing/development-setup.md` (+32 -0) ➕ `upcoming-release-notes/7729.md` (+6 -0) </details> ### 📄 Description ## Description Documents two Docker-based alternatives to the local Node + Yarn setup in the contributor development-setup guide. Background: the repo has shipped a `.devcontainer/` config (and a root `Dockerfile` + `docker-compose.yml`) since June 2023 ([#1032](https://github.com/actualbudget/actual/pull/1032)), but the canonical [development-setup.md](https://github.com/actualbudget/actual/blob/master/packages/docs/docs/contributing/development-setup.md) only ever covered the local Node + Yarn install path. The Dev Container option was only mentioned briefly in `packages/desktop-client/README.md` inside the VRT instructions — easy to miss. Changes: - Added a `:::tip` admonition in the Prerequisites section pointing forward to the new options. - Added a `## Dev Container` section that's tool-agnostic (mentions VS Code, Cursor, JetBrains Gateway, GitHub Codespaces, and the official [`@devcontainers/cli`](https://github.com/devcontainers/cli) — since [`devcontainer.json`](https://containers.dev/) is an open spec, not a VS Code-only thing). - Added a `## Docker Compose` section for the plain `docker compose up --build` path, including a `:::note` about the native-modules gotcha (host `node_modules/` compiled for macOS won't load in the Linux container). - Renamed the dev container from `Actual development` → `Actual Devcontainer` in `.devcontainer/devcontainer.json` for clarity (visible in VS Code's status bar and command palette). ## Related issue(s) Relates to [#1032](https://github.com/actualbudget/actual/pull/1032) (original Dev Container support, June 2023). ## Testing Both paths verified locally end-to-end: - **Dev Container** via VS Code → `Reopen in Container` → `yarn install` ran via `postCreateCommand` (~44s, including native module rebuilds for Linux), then `yarn start` inside the container → `http://localhost:3001/` loaded successfully. - **Docker Compose** via `docker compose up --build` from the repo root → container started, Vite ready in ~750ms, `curl http://localhost:3001` returned HTTP 200. - Pre-push CI checks passed locally: `yarn lint` (0 errors), `yarn typecheck` (success on all 6 workspaces), `yarn test` (success on all workspaces). ## Checklist - [x] Release notes added (see link above) - [x] No obvious regressions in affected areas - [x] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-06-14 06:10:55 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
tech-support
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#126778
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?