Skip to content

Test to see if the doc page will built#5

Merged
CLHatch merged 1 commit intomainfrom
Test
Jan 12, 2026
Merged

Test to see if the doc page will built#5
CLHatch merged 1 commit intomainfrom
Test

Conversation

@CLHatch
Copy link
Contributor

@CLHatch CLHatch commented Jan 12, 2026

Pull request

Purpose
Describe the problem or feature in addition to a link to the issues.

Approach
How does this change address the problem?

Open Questions and Pre-Merge TODOs
Check all boxes as they are completed

  • Use github checklists. When solved, check the box and explain the answer.

Learning
Describe the research stage
Links to blog posts, patterns, libraries or addons used to solve this problem

Requirements
Check all boxes as they are completed

Summary by Sourcery

Add a new Actual Budget 2 application definition and documentation to DockSTARTer.

New Features:

  • Introduce the Actual Budget 2 application with compose templates, labels, ports, storage, and environment scaffolding for deployment.

Documentation:

  • Add a new documentation page describing Actual Budget 2 and pointing users to support for setup assistance.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 12, 2026

Reviewer's Guide

Adds a new Actual Budget 2 application definition with associated Docker Compose fragments and user documentation, mirroring the existing app patterns to test docs build and app wiring.

Flow diagram for composing ActualBudget2 Docker fragments

graph TD
  A[Start_DockSTARTer_configuration] --> B[Select_enable_ActualBudget2_app]
  B --> C[Load_base_actualbudget2_compose_fragment]
  C --> D[Merge_actualbudget2_ports_fragment]
  D --> E[Merge_actualbudget2_storage_fragments_storage_storage2_storage3_storage4]
  E --> F[Merge_actualbudget2_arch_specific_fragment_x86_64_or_aarch64]
  F --> G[Merge_hostname_and_network_mode_fragments]
  G --> H[Resolve_environment_variables_from_env_files]
  H --> I[Generate_final_docker_compose_for_actualbudget__instance]
  I --> J[Deploy_or_update_container_with_Docker]
Loading

File-Level Changes

Change Details Files
Introduce documentation page for Actual Budget 2 matching DockSTARTer docs conventions.
  • Create docs/apps/actualbudget2.md with badges linking to Docker Hub, GitHub, and compose templates.
  • Document a brief description of Actual Budget and link to the official site.
  • Add a generic Install/Setup section pointing users to the DockSTARTer support page.
docs/apps/actualbudget2.md
Add a new Actual Budget 2 app with Docker Compose base service and common configuration.
  • Define the core service, container_name, env_file, timezone, restart policy, and main config volume mapping for the app.
  • Introduce an .env stub and app-specific env file placeholder for configuration.
  • Add folders and migrate stub files for future use by DockSTARTer tooling.
.apps/actualbudget2/actualbudget.yml
.apps/actualbudget2/.env
.apps/actualbudget2/.env.app.actualbudget
.apps/actualbudget2/actualbudget.folders
.apps/actualbudget2/actualbudget.migrate
Configure metadata, ports, storage, and platform-specific images for Actual Budget 2.
  • Add app metadata labels including description, deprecation flag, and nicename.
  • Expose the application on a configurable host port mapped to container port 5006.
  • Define multiple configurable storage volume mappings for different storage backends.
  • Specify architecture-specific images for aarch64 and x86_64 using a configurable tag.
  • Allow customization of hostname and Docker network mode via environment variables.
.apps/actualbudget2/actualbudget.labels.yml
.apps/actualbudget2/actualbudget.ports.yml
.apps/actualbudget2/actualbudget.storage.yml
.apps/actualbudget2/actualbudget.storage2.yml
.apps/actualbudget2/actualbudget.storage3.yml
.apps/actualbudget2/actualbudget.storage4.yml
.apps/actualbudget2/actualbudget.aarch64.yml
.apps/actualbudget2/actualbudget.hostname.yml
.apps/actualbudget2/actualbudget.netmode.yml
.apps/actualbudget2/actualbudget.x86_64.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@CLHatch CLHatch merged commit 6a2efc1 into main Jan 12, 2026
9 of 10 checks passed
@github-actions github-actions bot added the docs Automatic label label Jan 12, 2026
@CLHatch CLHatch deleted the Test branch January 12, 2026 02:51
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 4 issues, and left some high level feedback:

  • The new app is named actualbudget2 in the docs and directory structure, but all service names, env vars, and labels still use actualbudget<__instance> naming; consider aligning the app name consistently so it’s clear whether this is a separate variant or just a duplicate of the existing Actual Budget app.
  • The docs badge link for Compose Templates still points to .apps/actualbudget rather than .apps/actualbudget2; update this if the intent is to reference the newly added app definition.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new app is named `actualbudget2` in the docs and directory structure, but all service names, env vars, and labels still use `actualbudget<__instance>` naming; consider aligning the app name consistently so it’s clear whether this is a separate variant or just a duplicate of the existing Actual Budget app.
- The docs badge link for `Compose Templates` still points to `.apps/actualbudget` rather than `.apps/actualbudget2`; update this if the intent is to reference the newly added app definition.

## Individual Comments

### Comment 1
<location> `.apps/actualbudget2/actualbudget.yml:2-10` </location>
<code_context>
+services:
+  actualbudget<__instance>:
+    image: actualbudget/actual-server:${ACTUALBUDGET<__INSTANCE>__TAG?}
</code_context>

<issue_to_address>
**issue (bug_risk):** Service name and env-prefix appear to collide with the existing `actualbudget` app rather than being unique to `actualbudget2`.

Because this lives under `.apps/actualbudget2/`, using `actualbudget<__instance>` and `ACTUALBUDGET<__INSTANCE>__...` will likely clash with the existing `actualbudget` app if both are enabled. Please consider renaming these to `actualbudget2<__instance>` with a corresponding `ACTUALBUDGET2<__INSTANCE>__...` prefix to keep the two apps isolated.
</issue_to_address>

### Comment 2
<location> `.apps/actualbudget2/actualbudget.labels.yml:6` </location>
<code_context>
+    labels:
+      com.dockstarter.appinfo.deprecated: "false"
+      com.dockstarter.appinfo.description: "Super fast, privacy-focused app for managing your finances."
+      com.dockstarter.appinfo.nicename: "ActualBudget<__Instance>"
</code_context>

<issue_to_address>
**issue (bug_risk):** The nicename placeholder casing (`<__Instance>`) may not match the templating convention used elsewhere.

Elsewhere in this config the placeholder is consistently `<__instance>`, but here it’s `<__Instance>`. If the templating engine is case-sensitive, this value may not be replaced and could render literally as `ActualBudget<__Instance>`. Please align the casing with the other placeholders (e.g. `ActualBudget<__instance>`) unless this variant is intentionally supported.
</issue_to_address>

### Comment 3
<location> `docs/apps/actualbudget2.md:9` </location>
<code_context>
+
+## Description
+
+[Actual Budget](https://actualbudget.org) is a fast, privacy-focused, and open-source personal finance app built with a local-first approach. It’s written in NodeJS and is 100% free to use. With Actual, you own your data-manage your finances confidently knowing you can do whatever you want with your information, including syncing changes seamlessly across all your devices, with optional end-to-end encryption for maximum privacy.
+
+## Install/Setup
</code_context>

<issue_to_address>
**issue (typo):** Clarify the phrase "data-manage" to avoid it reading like a typo.

This reads as if "data-manage" is a single, unusual word. Consider adding a conjunction (e.g., "you own your data and manage your finances confidently") or an em dash ("you own your data—manage your finances confidently") to make the meaning clear.

```suggestion
[Actual Budget](https://actualbudget.org) is a fast, privacy-focused, and open-source personal finance app built with a local-first approach. It’s written in NodeJS and is 100% free to use. With Actual, you own your data and manage your finances confidently knowing you can do whatever you want with your information, including syncing changes seamlessly across all your devices, with optional end-to-end encryption for maximum privacy.
```
</issue_to_address>

### Comment 4
<location> `docs/apps/actualbudget2.md:14` </location>
<code_context>
+## Install/Setup
+
+This application does not have any specific setup instructions documented. If
+you need assistance setting up this application please visit our
+[support page](https://dockstarter.com/basics/support).
</code_context>

<issue_to_address>
**issue (typo):** Add a comma before "please" for correct sentence structure.

In the sentence `you need assistance setting up this application please visit our`, add a comma before "please" (`…application, please visit our`) to improve readability and match standard grammar.

```suggestion
you need assistance setting up this application, please visit our
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +2 to +10
actualbudget<__instance>:
container_name: ${ACTUALBUDGET<__INSTANCE>__CONTAINER_NAME?}
env_file: .env.app.actualbudget<__instance>
environment:
- TZ=${TZ?}
restart: ${ACTUALBUDGET<__INSTANCE>__RESTART?}
volumes:
- /etc/localtime:/etc/localtime:ro
- ${DOCKER_VOLUME_CONFIG?}/actualbudget<__instance>:/data
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): Service name and env-prefix appear to collide with the existing actualbudget app rather than being unique to actualbudget2.

Because this lives under .apps/actualbudget2/, using actualbudget<__instance> and ACTUALBUDGET<__INSTANCE>__... will likely clash with the existing actualbudget app if both are enabled. Please consider renaming these to actualbudget2<__instance> with a corresponding ACTUALBUDGET2<__INSTANCE>__... prefix to keep the two apps isolated.


## Description

[Actual Budget](https://actualbudget.org) is a fast, privacy-focused, and open-source personal finance app built with a local-first approach. It’s written in NodeJS and is 100% free to use. With Actual, you own your data-manage your finances confidently knowing you can do whatever you want with your information, including syncing changes seamlessly across all your devices, with optional end-to-end encryption for maximum privacy.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Clarify the phrase "data-manage" to avoid it reading like a typo.

This reads as if "data-manage" is a single, unusual word. Consider adding a conjunction (e.g., "you own your data and manage your finances confidently") or an em dash ("you own your data—manage your finances confidently") to make the meaning clear.

Suggested change
[Actual Budget](https://actualbudget.org) is a fast, privacy-focused, and open-source personal finance app built with a local-first approach. It’s written in NodeJS and is 100% free to use. With Actual, you own your data-manage your finances confidently knowing you can do whatever you want with your information, including syncing changes seamlessly across all your devices, with optional end-to-end encryption for maximum privacy.
[Actual Budget](https://actualbudget.org) is a fast, privacy-focused, and open-source personal finance app built with a local-first approach. It’s written in NodeJS and is 100% free to use. With Actual, you own your data and manage your finances confidently knowing you can do whatever you want with your information, including syncing changes seamlessly across all your devices, with optional end-to-end encryption for maximum privacy.

## Install/Setup

This application does not have any specific setup instructions documented. If
you need assistance setting up this application please visit our
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Add a comma before "please" for correct sentence structure.

In the sentence you need assistance setting up this application please visit our, add a comma before "please" (…application, please visit our) to improve readability and match standard grammar.

Suggested change
you need assistance setting up this application please visit our
you need assistance setting up this application, please visit our

CLHatch added a commit that referenced this pull request Jan 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Automatic label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant