Compare commits

...

888 Commits

Author SHA1 Message Date
github-actions[bot]
102f80eecd Remove used release notes 2025-11-27 10:08:24 +00:00
Matt Fiddaman
3b91151388 Merge branch 'master' into prerelease 2025-11-27 10:07:35 +00:00
dependabot[bot]
33610fee78 Bump node-forge from 1.3.1 to 1.3.2 (#6260)
* Bump node-forge from 1.3.1 to 1.3.2

Bumps [node-forge](https://github.com/digitalbazaar/forge) from 1.3.1 to 1.3.2.
- [Changelog](https://github.com/digitalbazaar/forge/blob/main/CHANGELOG.md)
- [Commits](https://github.com/digitalbazaar/forge/compare/v1.3.1...v1.3.2)

---
updated-dependencies:
- dependency-name: node-forge
  dependency-version: 1.3.2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* note

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-27 09:44:18 +00:00
Juulz
9d94e1268c Update Spending.tsx - add left margin to separator between Average and Filter - Fixes #6003 (#6261)
* Update Spending.tsx - add margin to avg button

* Add left margin to separator after Average button in Spending report.
2025-11-27 07:45:56 +00:00
Juulz
52d013cb86 Update Reconciliation document to current UI - follows #6220 (#6225)
* Revise reconciliation instructions for clarity

Updated the reconciliation documentation to clarify the process and improve readability.

* Update button text for reconciling action

Changes wording of 'Done reconciling' button to 'Exit reconciling'.

* Modify button text for reconciliation process

Updates button wording based on reconciliation status.

* Update button wording in release notes

* Refine language in reconciliation documentation

Updated wording for clarity and consistency throughout the reconciliation documentation.

* Add files via upload

* Update reconciliation screenshots

* Update reconciliation images for 2025

* Add files via upload

* Clarify exit option in reconciliation process

Added a note about exiting reconciliation without locking transactions.

* Fix cleared transactions total in reconciliation guide

Corrected the cleared transactions total from 324.82 to -82.60 in the reconciliation instructions.

* Update reconciliation.md

* Update reconciliation.md to resolve conflicts

* Add files via upload

* Update reconciliation.md unlocking transactions

* Update 6220.md

* Update 6220.md
2025-11-26 19:54:56 +00:00
github-actions[bot]
21da11df12 Remove used release notes 2025-11-26 14:12:54 +00:00
gopstr
31509d3629 Add Belarusian Ruble currency (#6252)
* Add Belarusian Ruble currency

* Fix upcoming release notes filename

---------

Co-authored-by: pstribuk <pstribuk@ibagroup.eu>
2025-11-26 14:12:54 +00:00
Matt Fiddaman
ab3d5bc92a add prerelease notes 2025-11-26 14:12:54 +00:00
github-actions[bot]
ae91d7fb55 Remove used release notes 2025-11-26 14:01:45 +00:00
Matt Fiddaman
d1510cb91a generate release notes 2025-11-26 13:57:45 +00:00
gopstr
e0afbcfd96 Add Belarusian Ruble currency (#6252)
* Add Belarusian Ruble currency

* Fix upcoming release notes filename

---------

Co-authored-by: pstribuk <pstribuk@ibagroup.eu>
2025-11-26 13:54:31 +00:00
Michael Clark
9ceb74cf6e :electron: Make it easier to download the desktop app installers (#6246)
* make it easier to download the desktop app artifacts

* release notes

* naming the artifacts *.zip becuase zips are mandatory

* Revert "naming the artifacts *.zip becuase zips are mandatory"

This reverts commit 02f9fcaa69.
2025-11-25 20:30:23 +00:00
youngcw
ba00a25c85 🐛 fix the running balance on mobile for large accounts (#6241)
* fix the running balance on mobile for large accounts

* typecheck

* don't calculate if not needed
2025-11-25 17:59:46 +00:00
Michael Clark
3df3b5e145 :electron: Add workflow for nightly signed desktop app (#6242)
* add workflow for nightly signed desktop app build

* release ntoes
2025-11-24 22:22:36 +00:00
Juulz
c17fa45692 Add PWA install instructions and links to Pikapods doc - fixes #6191 (#6215)
* Update pikapods.md

* Update pikapods.md

Added info and links to PWA installation

* Update pikapods.md

* Update pikapods.md

A couple of formatting changes

* Update pikapods.md

* Update notification method for PikaPods

* Update packages/docs/docs/install/pikapods.md

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

* Update pikapods.md

* Update pikapods.md

* Update expect.txt - add 'taskbar'

* Update expect.txt

* Update pikapods.md

* Update packages/docs/docs/install/pikapods.md

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

* Update pikapods.md

* Update pikapods.md

* Update pikapods.md

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-24 13:39:40 +00:00
Yaroslav Halchenko
7613de013e Two typos codespell found (#6237) 2025-11-24 11:15:12 +00:00
Michael Clark
f3cd0f2091 📜 Docs: Update downloads page table to have less duplication (#6231)
* update downloads page table to have less duplication

* color from variable

* add component to exclude for spell check

* adding workflow to docs files for release notes exclusion

* release notes

* cli tool added to the server download list
2025-11-22 22:12:03 +00:00
Matiss Janis Aboltins
9824a47a86 Revert "Add workflow to auto-assign maintainers to PRs on comment/review" (#6230)
* Revert "Add workflow to auto-assign maintainers to PRs on comment/review (#6156)"

This reverts commit dc2dd2ee6f.

* Add release notes for PR #6230

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-22 20:56:07 +00:00
Martin Chen
daa126523a Disable fontSizeChanged to prevent undo stack exceeding limit after dashboard reset (#6094)
* fix: temporarily disable fontSizedChanged to prevent infinite update loop after dashboard reset

* chore: add release note for disabling fontSizeChanged to prevent undo stack exceeding limit after dashboard reset

Revert "chore: add release note for disabling fontSizeChanged to prevent undo stack exceeding limit after dashboard reset"

This reverts commit eea0a161bf3ddbaf0b2f76ec3c91ac015d4f1a76.

chore: add release note for disabling fontSizeChanged to prevent undo stack exceeding limit after dashboard reset

* Revert "fix: temporarily disable fontSizedChanged to prevent infinite update loop after dashboard reset"

This reverts commit a83fd74ae60a426c4888c9f5c5718273d1af4ec7.

* fix: prevent infinite loop by disabling fontSizeChanged

* Clean up SummaryCard by removing unused code

Removed commented-out code to prevent confusion.

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2025-11-22 18:17:36 +00:00
Juulz
975bb3b692 Change Done Reconciling button text - fixes #6196 (#6220)
* Rename button text from 'Done reconciling' to 'Complete Reconciling'

* Change button text from 'Done' to 'Complete'

* Update button text in reconciliation test

* Update button text for reconciliation completion

* Modify reconciliation completion messages

Updated reconciliation messages to provide clearer instructions.

* Change button text from 'Complete Reconciliation' to 'Exit reconciling'

* Fix capitalization in 'Exit Reconciling' text

* [autofix.ci] apply automated fixes

* Update release notes for reconciliation changes

Changes wording for clarity and adds exit option.

* Update release notes with button wording changes

Changes wording for clarity and adds a new exit option.

* Update category and button wording in release notes

Changes the category from 'Changes' to 'Enhancements' and updates button wording.

* Clarify wording for reconciliation exit options

* Update test expectation for reconciled message

* Update test to check for reconciled message

* [autofix.ci] apply automated fixes

* Clean up reconciliation view text

Removed unnecessary line breaks and exit message from the reconciliation view.

* [autofix.ci] apply automated fixes

* Update reconciliation test for improved text matching

* [autofix.ci] apply automated fixes

* Update packages/desktop-client/src/components/accounts/Reconcile.tsx

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

* [autofix.ci] apply automated fixes

* Change button click from 'Exit reconciling' to 'Lock transactions'

* Enhance release notes for reconciliation button changes

Updates authors and clarifies button wording for reconciliation.

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-22 16:19:23 +00:00
Matiss Janis Aboltins
4081a6f5e5 Fix typechecker - update mismatched type in DiscoverScheduleEntity (#6227)
* Fix typechecker - update mismatched type in DiscoverScheduleEntity

* Add merge_group to GitHub Actions workflows for better concurrency management
2025-11-22 16:20:11 +00:00
Matiss Janis Aboltins
6f17ee17ca API: add missing TypeScript types (#6109) 2025-11-22 09:18:01 +00:00
Matiss Janis Aboltins
b7c44d0fd6 Revert "Fix flaky merkle test by enforcing deterministic key ordering" (#6217) 2025-11-21 08:38:45 +00:00
Matiss Janis Aboltins
8f8d3e7712 Exclude test files from build artifacts (#6216)
* Exclude test files from build artifacts

- Update crdt tsconfig.dist.json to exclude test files from dist output
- Update desktop-electron tsconfig.dist.json to exclude test files from build output

This prevents test files from being compiled into dist directories and
ensures they won't be picked up by test runners in CI/CD.

* Add release notes for PR #6216

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-20 22:21:43 +00:00
Matiss Janis Aboltins
dc2dd2ee6f Add workflow to auto-assign maintainers to PRs on comment/review (#6156) 2025-11-20 21:20:41 +00:00
Matiss Janis Aboltins
2dfd62adb8 Improve schedule edit form responsiveness for mobile support (#6178) 2025-11-20 08:39:10 +00:00
Juulz
9b535b42c3 Update payees.md - fixes #6184 (#6203)
* Update payees.md

Updated Payee document to include Category Learning links and formatting updates.

* Update payees.md

speklling

* Update payees.md

docusaurus admonitions fix

* Update payees.md

Resolve comments

* Add files via upload

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6203

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-19 17:17:33 -07:00
Michael Clark
0bac101e61 🎨 Update PWA icons to new one (#6204)
* update pwa icons to new one

* release notes

* icon

* color update for menu

* icon tiny bit smaller

* favicons as well - why not

* keeping the old icons for reference

* last icon archived

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6204

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-19 17:17:06 -07:00
Matiss Janis Aboltins
a1183755c1 Fix flaky cash flow chart e2e test by disabling animations (#6208) 2025-11-19 23:25:00 +00:00
Matiss Janis Aboltins
957bfe240d Fix flaky merkle test by enforcing deterministic key ordering (#6165) 2025-11-19 18:04:25 +00:00
Matiss Janis Aboltins
38145975ec Fix rule edit page crashing (#6175) 2025-11-19 18:03:51 +00:00
Matt Fiddaman
6834f4d669 change merge keybind to "g" (#6200) 2025-11-19 15:15:03 +00:00
sys044
98174089c9 fix: balance rule action template variable (#6198)
* fix: balance rule action template variable for transactions without category

* added release notes

---------

Co-authored-by: Tom Griffin <tom.griffin@citypantry.com>
Co-authored-by: Tom Griffin <tomgriffin@Toms-MBP.communityfibre.co.uk>
2025-11-18 14:48:27 -07:00
James
be65d295d0 feat(currency): Add Malaysian Ringgit (MYR) currency (#6195) 2025-11-18 10:58:29 -07:00
Joel Jeremy Marquez
97dec0d3c8 [Maintenance] Update types for budget table components (#6022)
* [Maintenance] Update types for budget table components + new hooks to reduce prop drilling

* Require BudgetCategories props
2025-11-18 09:45:53 -08:00
Matt Fiddaman
f3419a4ee2 fix flaky reports tests (#6193)
* add isTestEnv hook

* disable all recharts animations in test env

* note

* drop all reports snapshots

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6193

* disable animation instead of zeroing duration

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-18 17:35:49 +00:00
Juulz
7a4ec20bac Update Settings doc - fixes issue #6183 (#6197)
* Update index.md

New screenshots. Add new settings

* Add files via upload

New screenshots for setting page

* Update index.md

Small adjustments

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6197

* Update index.md

More small adjustments to formatting.

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-18 09:57:42 -07:00
Matt Fiddaman
7e34ddd356 prevent reports from unmounting when out of viewport (#6194) 2025-11-18 09:57:36 +00:00
Matt Fiddaman
30f4a7fa9d make docs issue titles consistent (#6192) 2025-11-18 01:13:10 +00:00
Michael Süssemilch
9870e93c87 feat(currency): add idr currency (#6173)
* feat(currency): add IDR

* add release notes

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6173

* fix: Rp. to Rp

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6173

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6173

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-18 00:17:11 +00:00
dependabot[bot]
c48a201378 Bump js-yaml from 3.14.1 to 3.14.2 (#6174) 2025-11-17 20:42:40 +00:00
Matiss Janis Aboltins
2c9d2a0d63 Fix mobile settings page horizontal scroll (#6100) 2025-11-17 20:30:43 +00:00
Stefan McKinnon Edwards
bc8fbe26cc Remove dollar symbols from template-string examples in GoalTemplateModal.tsx (#5946)
* Update GoalTemplateModal.tsx

Removed dollar symbol from template string examples.

* Update packages/desktop-client/src/components/modals/GoalTemplateModal.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix note

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: youngcw <calebyoung94@gmail.com>
2025-11-17 11:38:36 -07:00
Matt Fiddaman
2819ebb52d fix schedules page crash (#6169)
* handle null schedule conditions

* note
2025-11-17 16:27:32 +00:00
Matiss Janis Aboltins
de04af9ff0 ForceReload: update service worker refresh logic (#6162) 2025-11-16 21:11:41 +00:00
Matt Fiddaman
1ce2280a49 ⬆️ mid month dependency bump (#6159)
* bump various dependencies

* note

* fix types

* [autofix.ci] apply automated fixes

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6159

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-16 17:04:34 +00:00
Matiss Janis Aboltins
ead8ff7293 Add blog post: Fighting AI Slop (#6104) 2025-11-15 21:33:39 +00:00
Matiss Janis Aboltins
3d02350d4a Extract schedule edit form into separate reusable component (#6150)
- Created ScheduleEditForm component with all form fields, transactions table, and footer buttons
- Moved NoTransactionsMessage component to ScheduleEditForm
- Updated ScheduleEditModal to use the new form component
- Form component is now reusable for mobile schedules page
2025-11-15 18:56:02 +00:00
Matiss Janis Aboltins
f84ebe668c Fix bundle stats comment markdown formatting (#6152)
Add missing newlines after summary tags in bundle stats comment to fix broken markdown rendering
2025-11-15 18:55:48 +00:00
Nik
36f6a080a6 Allow categories to be added via a plus button in the group header (#6110)
* Allow category to be added from sidebar group

* [autofix.ci] apply automated fixes

* Small add category adjustments
- Add tooltip on add button hover
- Fix NotesButton padding for proper border radius rendering
- Add ability to disable tooltip pointer events so that the tooltip does not float when the trigger disappears

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6110

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-15 16:27:26 +00:00
tabedzki
e31ac3fa7c Update Feedback Link for Experimental CrossoverReport (#6148) 2025-11-15 16:23:02 +00:00
Martin Chen
dc7f80024f [WIP] Fix <input type="date"> on iOS 26 Safari (#6145) 2025-11-14 18:21:56 +00:00
Benedikt Müller
3be66e7683 Recognize HTTP GET parameters to prefill new transaction on mobile (#6050) 2025-11-13 18:14:33 +00:00
Matiss Janis Aboltins
7648fc6809 Combine bundle stats comments in PR (#6101)
* Combine bundle stats comments in PR

* Refactor bundle stats comment generation to use a mapping approach for base and head stats, improving argument parsing and validation in the CI action.

* Enhance size comparison workflow by adding steps to checkout the base branch and set up the environment, ensuring accurate build status checks for pull requests.

* Implement size comparison job in GitHub Actions workflow, replacing the deprecated size-compare.yml. This new job downloads build stats from both the base and head branches, processes the stats files, and generates a combined comment for pull requests, enhancing visibility into bundle size changes.

* Add release notes for bundle size stats update, consolidating workflow and PR comment generation.

* Refactor GitHub Actions workflows by removing the deprecated size comparison job from build.yml and introducing a new size-compare.yml workflow. This new workflow enhances build status checks and ensures accurate reporting of bundle size changes for pull requests.

* chore: update action versions and improve error messages in bundle stats scripts

- Updated GitHub Actions to specific commit versions for `upload-artifact` and `checkout`.
- Enhanced error messages in `bundle-stats-comment.mjs` and `update-bundle-stats-comment.mjs` for better clarity and consistency, replacing standard quotes with typographic quotes.

* fix: standardize error messages in bundle-stats-comment.mjs

- Updated error messages in `bundle-stats-comment.mjs` to remove typographic quotes for consistency and clarity.
2025-11-13 18:11:34 +00:00
Matt Fiddaman
033fd2d7e1 change terminology used in count-points script (#6138)
* terminology

* note
2025-11-13 17:57:09 +00:00
Georg Hartmann
ed77caf947 Add COP (Colombian Peso) to Currencies (#6115)
* Add COP

* Create 6115.md

---------

Co-authored-by: G <g@Mac.fritz.box>
2025-11-13 07:27:58 -07:00
Matt Fiddaman
774e3b7f92 amend the contributor points calculation logic to handle the docs merge (#6127) 2025-11-12 23:03:35 +00:00
Ishan Jain
d3d6b68bfe fix: do not clear notes field on action.op change (#6046)
* fix: do not clear notes field on action.op change

* [autofix.ci] apply automated fixes

* Update upcoming-release-notes/6046.md

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-12 13:48:44 -07:00
Matiss Janis Aboltins
f23bcaa9d5 TypeScript: make vite config files strict TS compliant (#6121) 2025-11-12 19:32:44 +00:00
Digvijay Singh
d0f02c7272 Fix OpenID token expiration to correctly use seconds from config (#6130) 2025-11-12 16:51:39 +00:00
Matt Fiddaman
73dfe47d9c delete docs-only release notes (#6129) 2025-11-12 15:44:46 +00:00
Matt Fiddaman
d9c590bf54 fix VRT workflow artifact download (#6126) 2025-11-12 13:33:16 +00:00
Matt Fiddaman
03e3cdbc65 fix error in feature request workflow (#6125) 2025-11-12 13:32:19 +00:00
Matt Stillwell
b22579bdeb docs: update api reference for incorrect category parameter (#6123)
* docs: update api reference for incorrect category parameter

* remove release note

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-12 11:32:56 +00:00
Matt Fiddaman
004b5287c7 remove release note check for documentation changes (#6122)
* don't check for release note on docs changes

* note
2025-11-12 11:01:04 +00:00
youngcw
cac4be7d38 Add in mobile running balance (#5513)
* Revert "Revert "Mobile running balance" because its causing extreme slowness …"

This reverts commit 6e2154d401.

* Fix rebase error

* Release notes

* [autofix.ci] apply automated fixes

* Cleanup

* Rename some props

* Delete upcoming-release-notes/5219.md

* Do not calculate running balance if searching or non-account

* Temporarily increase timeout

* Do not show running balance on non-account views

* Fix merge error

* Fix lint

* Coderabbit feedback

* Update TransactionList dependencies

* Remove test.slow()

* [autofix.ci] apply automated fixes

---------

Co-authored-by: Joel Jeremy Marquez <joeljeremy.marquez@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-11-11 16:54:04 -07:00
Matt Fiddaman
e64a042f0c fix github action version resolution (#6114)
* pin to sha

* note
2025-11-11 23:26:07 +00:00
Matiss Janis Aboltins
914cc6503e ForceReload: change web update logic from .reload() to .applyAppUpdate() (#6119) 2025-11-11 23:21:21 +00:00
Matt Fiddaman
b142cf6cda 📚 remove references to the old docs repository (#6113)
* remove references to docs repo

* note
2025-11-11 22:19:36 +00:00
Matiss Janis Aboltins
611be5dd45 Fix FAQ: Correct information about upload size limits (#6103) 2025-11-11 19:26:26 +00:00
Matiss Janis Aboltins
f41386b753 Convert FiltersMenu to TypeScript (#6091) 2025-11-10 21:40:05 +00:00
Matiss Janis Aboltins
717a7db9e7 Docs: remove account type reference (#6106) 2025-11-10 21:39:48 +00:00
Matiss Janis Aboltins
b307cbc7ea docs: fix incorrect ActualQL function usage in aggregate examples (#6105)
Fixed incorrect usage of amount field in  aggregate function examples.
Changed 'amount' to '' to match ActualQL syntax requirements.
2025-11-10 21:39:30 +00:00
Matiss Janis Aboltins
1d8580cead Fix mobile bank sync full width (#6098) 2025-11-10 18:45:16 +00:00
Matiss Janis Aboltins
da3f4c3091 Add force reload button to settings (#6090) 2025-11-10 18:01:19 +00:00
Matt Fiddaman
0e8aa7ddc4 initial cleanup post docs merge (#6095) 2025-11-10 11:38:48 +00:00
Ishan Jain
a1a7c45068 Added tilde(~) separator to CSV parser (#6045) 2025-11-10 11:05:32 +00:00
Copilot
2e061daa5e Default custom reports to include hidden categories and uncategorized transactions (#6092) 2025-11-09 20:30:08 +00:00
Matt Fiddaman
37b62d0941 merge actualbudget/docs into main repo (#6029) 2025-11-08 22:18:30 +00:00
Julian Dominguez-Schatz
dedf0cd6f8 Fix style issues after Stack migration (#6086)
* Fix style issues after Stack migration

* Add release notes
2025-11-08 15:50:03 -05:00
Julian Dominguez-Schatz
31455d475c Fix automations not saving on modal close (#5811)
* Fix automations not saving on modal close

* Add release notes

* CodeRabbit feedback

* Fix

* PR feedback

* Revert unnecessary change
2025-11-08 15:49:20 -05:00
Michael Süssemilch
47c09ffcfa feat(currency): add currency support to templates and goals (#5955)
* feat(currency): add currency support to templates and goals

* fix: linting

* fix: add weekly guard as per coderabbit suggestion

* fix: add decimalPlaces to removeFraction

* test: add tests for JPY

* simplify currency usage in template
2025-11-08 10:19:33 -07:00
Matiss Janis Aboltins
1138fc10cf Convert TransactionEdit to TypeScript (#5998) 2025-11-08 08:35:11 +00:00
Jonathan Bramley
2e7e0b520b Sync cleared error (#6082) 2025-11-08 00:21:04 +00:00
Michael Clark
ffe55244e5 :electron: Remove unneeded prop on flathub store metainfo (#6085)
* display length is no longer valid on newer version of appstream

* release notes
2025-11-07 21:18:06 +00:00
Carlos Simon
b7841d0313 Added Guatemalan quetzal (GTQ) and Danish krone (DKK) (#6084)
* chore: initialize add-gtq-dkk branch

* feat: add gtq and dkk currencies

* chore: add release-note
2025-11-07 19:20:19 +00:00
Matt Fiddaman
1889b8762a remove yarn.lock 2025-11-07 18:20:11 +00:00
Matt Fiddaman
c870fa9de9 note 2025-11-07 18:20:11 +00:00
Matt Fiddaman
7904310be8 cleanup lint/typecheck errors 2025-11-07 18:20:11 +00:00
Matt Fiddaman
aa9cea78e2 integrate docs into workspace 2025-11-07 18:20:11 +00:00
Matt Fiddaman
5a0e8b3621 Merge docs repository into packages/docs 2025-11-07 18:17:15 +00:00
Matt Fiddaman
dab3ffc762 Moved docs into packages/docs directory 2025-11-07 18:17:14 +00:00
Juulz
dbfb4e5206 Update Credit Card Section Fixes #742 (#814)
I am unable to upload images from my fork. They are here:

[images](https://github.com/Juulz/docs/tree/master/static/img/credit-cards)

Updated Credit Cards:

- Rewrote index.md to explain how Actual treats credit cards
- Split off Paying in Full - Within the Budget and rewrote with
screenies
- Rewrote Carrying debt with screenies 

Please add Citi and Citibank to allowed words. Thank you.

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-07 08:34:10 -07:00
scojo
44768370e0 Add documentation page for Crossover Point Report experimental feature (#817)
The feature is proposed in PR
[5554](https://github.com/actualbudget/actual/pull/5554)
2025-11-07 08:33:42 -07:00
scojo
b80c2d002b Add Crossover Report (#5554)
* Add Crossover Report

* Fix lint and typecheck

* Use useFormat hook for formatting, make spreadsheet always return cents

* Change defaults to all categories and accounts. Return 0 when no categories selected

* Change error handling to use addNotification

* Detect if crossover has already happened before projecting

* [autofix.ci] apply automated fixes

* lint:fix. Only get first crossoverIdx

* Annualize historical return via compounding, not multiplication
Use effective monthly rate from annual return
Guard against undefined starting balance

* Optional guard in median helper for future-proofing
Use consistent rounding when checking the projected crossover
Avoid O(n^2) lookups when aggregating balances by month

* Add Crossover Report Feature Flag

* Add option to show hidden categories

* Remove estimated return placeholder text since the formatting was unclear

* Initialize defaults when widget meta is absent

* Hidden categories remain in expense totals

* [autofix.ci] apply automated fixes

* Update packages/loot-core/src/types/prefs.ts

Fix merge conflict semi-colon

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update prefs.ts

Try again to fix merge conflict.

* Fix percentage inputs showing trailing zeros for some numbers

* Fix projection not happening if crossover happens historically but then reverts

* some tweaks for consideration.  Remove if undesired

* go back to original math

* Fix change in percentage formatting for CrossoverCard

* Optimize date range calculation and add cleanup to CrossoverCard
Use format utility for years to retire
Replaced hardcoded color with theme token

* [autofix.ci] apply automated fixes

* Try again to standardize display and storage of percentages without repeating decimals

* Add tooltips with descriptions to crossover chart inputs

* Refactor Crossover component to use translation for 'N/A' strings and simplify estimatedReturn assignment

* Refactor Crossover components to improve date range calculations and ensure proper handling of the latest month

* Fix typo in Crossover component: corrected "retirment" to "retirement" in user instructions

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-11-07 08:33:22 -07:00
Michael Clark
42c184acb9 :electron: Adding 512x512 image to the icns file (#6076)
* making the linux icon explicit

* putting flatpak back

* regen icns

* adding the 512px image to the icns file

* release notes
2025-11-07 08:58:55 +00:00
rodriguestiago0
c600bde17a [WIP] Update community docs (#824) 2025-11-06 18:02:27 -07:00
Matiss Janis Aboltins
88313c029b Typescript: GenericInput (#5976) 2025-11-06 23:02:41 +00:00
Matiss Janis Aboltins
3825e65693 Add edit payee functionality to mobile page (#5874) 2025-11-06 20:58:03 +00:00
Matiss Janis Aboltins
1e6fde571e TypeScript: make component-library strict ts compliant (almost) (#6026) 2025-11-06 18:28:07 +00:00
Joel Jeremy Marquez
da8072ffbd Re-implement useDisplayPayee to use context to minimize SQL queries (#5795)
* Re-implement useDisplayPayee to use context to minimize SQL queries

* Rename ScrollProvider to useScrollListener and move to hooks folder

* Add DisplayPayeeContextProvider to TransactionsTable.test.tsx

* Set higher page count

* Fix payee autocomplete search

* [autofix.ci] apply automated fixes

* Fix highlight of Create payee

* Show search if there are 100 payees

* Cleanup

* Rename to DisplayPayeeProvider

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #5795

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #5795

* Fix new payee not being created in tests

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #5795

* Update rules test to use pressSequentially

* [autofix.ci] apply automated fixes

* Coderabbit suggestion

* Fix typecheck error

* Cleanup

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #5795

* Revert VRT

* Move DisplayPayeeProvider location

* Recert https on E2E start url

* Fix lint

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-06 09:31:04 -08:00
Joel Jeremy Marquez
0043577695 Allow entering amount when covering overspent/overbudgeted (#5988)
* Allow entering amount when covering overspent/overbudgeted

* Remove space

* [autofix.ci] apply automated fixes

* Fix typecheck error

* Positive amounts on cover amount

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-11-06 09:14:00 -08:00
Matt Fiddaman
6bb90efad3 add prompt to convert future transactions to single time schedules (#6065) 2025-11-06 15:51:03 +00:00
Adam Millerchip
979171a591 Update roadmap-for-new-users.md (#823)
The current roadmap only contained a subset of the options for setting
up a server. Rather than maintain two copies of the same information (or
preferring one method over the other), I think it's best to simply link
to the relevant section.
2025-11-06 08:41:42 -07:00
Matt Fiddaman
407a0d2f7f fix GitHub workflows in the compare sizes action (#6079)
* fix compare sizes workflow versions

* note
2025-11-06 01:01:12 +00:00
Matt Fiddaman
74cb141dd9 fix failing import of removed Stack component (#6077)
* fix missing stack import

* note
2025-11-06 00:44:28 +00:00
Matt Fiddaman
32bd929ed5 add CTRL/CMD + Enter as keyboard shortcut to only add single transaction (#6037)
* add ctrl/cmd + enter as shortcut to only add single transaction

* note

* add same logic to add button

* add keyboard shortcut

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #6037

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-11-06 00:12:18 +00:00
Michael Clark
7e2fe5e8dc :electron: Adding hotkeys for mac (#6067)
* adding hotkeys for mac

* release notes

* window mac menu

* fix window
2025-11-05 23:58:37 +00:00
Matt Fiddaman
3d6e9919b2 make SelectLinkedAccountModal responsive (#5984)
* make SelectLinkedAccountModal responsive

* fix table headers

* note

* coderabbit

* fix feedback

* coderabbit

* cast to string

* Fix for unlinking account only

* Code Rabbit reviews

---------

Co-authored-by: lelemm <lelemm@gmail.com>
2025-11-05 23:57:25 +00:00
Lewis Chan
12923a87eb fix: openId.issuer config not loading from env vars (#6061)
* fix: openId.issuer config loading from env vars

* add release note

* [autofix.ci] apply automated fixes

* remove unused directive

* move test to the right place

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-11-05 23:57:02 +00:00
Henri Cook
a2fa74ca8d Select the user's current country as default when opening bank sync, instead of no value (uses browser locale) (#6054)
Co-authored-by: Henri Cook <henri.cook@linklaters.com>
2025-11-05 23:56:43 +00:00
Jayant Jeet Tomar
d1fa9b2210 [Bug]: Net worth graph doesn't show current week (#6042)
* [Bug]: Net worth graph doesn't show current week
Fixes #5986

* Fixed lint errors

* Update upcoming-release-notes/6042.md

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-05 23:56:35 +00:00
parapsychic
bb79f12435 Prevent duplicate filters from being applied (#6000)
* Fix an issue where the user could add duplicate filters (#5999)

* Add release note (#5999)

* [autofix.ci] apply automated fixes

* Changed from JSON.stringify to isEqual (#5999)

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-11-05 23:56:27 +00:00
Matt Fiddaman
25f9ea3f97 ⬆️ bump github action versions (#6014)
* actions/checkout v5

* actions/setup-node v6

* actions/upload-artifact v5

* actions/download-artifact v6

* actions/stale v10

* aidan-mundy/react-to-issue v1

* twk3/rollup-size-compare-action v1

* actions/github-script v8

* dawidd6/action-download-artifact v11

* fountainhead/action-wait-for-check v1

* peter-evans/create-or-update-comment v5

* docker/build-push-action v6

* note
2025-11-05 23:56:17 +00:00
Matt Fiddaman
f8b793069d ⬆️ vitest v4 (#6060)
* vitest 4

* config changes

* remove unused v8 coverage dependency

* note
2025-11-05 23:55:47 +00:00
Stephen Brown II
f8514556c5 Add option to trim lines from CSV imports (#5879) 2025-11-05 22:31:38 +00:00
Matiss Janis Aboltins
8f84164ff7 Convert mobile BudgetTable component to TypeScript (#5997) 2025-11-05 22:16:24 +00:00
Matiss Janis Aboltins
b690302998 ♻️ (typescript) Convert BudgetCategories to TypeScript (#5961) 2025-11-05 22:15:38 +00:00
Matiss Janis Aboltins
1a845583ef Fix scheduled transfers not linking when payee account is imported first (#6025) 2025-11-05 22:15:11 +00:00
Matiss Janis Aboltins
e786bdc398 refactor: Replace all Stack component usages with SpaceBetween (#6039) 2025-11-05 22:14:15 +00:00
Michael Clark
f0b3884b4b Create org.flathub.VerifiedApps.txt for flathub verification (#825)
Adds flathub verification file so we can prove the domain belongs to us.


https://deploy-preview-825.www.actualbudget.org/.well-known/org.flathub.VerifiedApps.txt

When merged it will be:
https://actualbudget.com/.well-known/org.flathub.VerifiedApps.txt
2025-11-05 21:50:14 +00:00
Julian Dominguez-Schatz
9e1edfb7df 🔖 (25.11.0) (#822)
https://github.com/actualbudget/actual/pull/6059
2025-11-03 19:28:19 -05:00
github-actions[bot]
3d47469be3 🔖 (25.11.0) (#6059)
* 🔖 (25.11.0)

* Empty

* Remove used release notes

* Empty

---------

Co-authored-by: jfdoming <9922514+jfdoming@users.noreply.github.com>
Co-authored-by: Julian Dominguez-Schatz <julian.dominguezschatz@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-11-03 18:12:18 -05:00
racehd
c95a4bfc78 link simplefin docs in bank-sync.md (#818)
GoCardless is linked but SimpleFin is not. Improves navigation
2025-11-03 04:43:06 +00:00
frank_zhang
dd66a24103 Update budget.md (#775)
Corrected functions in specific month's budget categories.
2025-11-03 04:42:15 +00:00
Stephen Brown II
8ce7420199 Update auto_stop_machines setting in fly.md (#819)
- Updated auto_stop_machines setting to 'stop' to match fly.io
documentation.
- Added min_machines_running setting, set to 0.

See https://fly.io/docs/reference/configuration/#the-services-sections
2025-11-03 04:40:37 +00:00
Matt Fiddaman
cbac6116d4 fix rerender issue with formula card (#6058)
* fix infinite rerender

* note

* remove React import
2025-11-03 01:30:32 +00:00
Michael Clark
e83cfba357 Remove plugin worker temporarily (#6052)
* remove plugin worker temporarily

* releas enotes

* clarifying comment

* remove plugin worker temporarily

* releas enotes

* clarifying comment
2025-11-02 10:18:49 +00:00
Matiss Janis Aboltins
0cac66b203 Remove isGlobal preference functionality (#6049) 2025-11-01 14:18:08 +00:00
Michael Clark
7983ee45e1 :electron: New appx icons (#6043)
* new appx icons

* updates the windows store appx icons to the new style
2025-10-31 21:45:23 +00:00
Michael Clark
844cd3433a :electron: Flathub MetaInfo (#6033)
* updates to flathub metainfo

* update to summary

* release notes

* omit :light

* Update upcoming-release-notes/6033.md

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>

* actual budget

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-10-30 17:15:47 +00:00
dbequeaith
ae6bea2b15 Import qfx safari mobile (#6020)
* Supports selecting qfx files on safari mobile

Fixes #4283

accept explicit MIME types associated with qfx files

* generated release notes

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-10-28 14:20:58 +00:00
Michael Clark
37481535e7 ☁️ Fix server sync file download when server-files are in .config (#6010)
* fix server sync file download when server-files are in .config directory on linux

* extra security

* release notes

* putting it back after testing

* also accounting for directories

* derp
2025-10-27 20:11:40 +00:00
Matiss Janis Aboltins
45a4f0a40d Add sort_by field to custom reports (#6005) 2025-10-27 19:59:53 +00:00
Matt Fiddaman
9a3e33c0d7 fix inconsistent widths of bank sync field mapping selects on mobile (#6007) 2025-10-27 11:56:38 +00:00
Matiss Janis Aboltins
25d072944e Refactor account header to use SpaceBetween component for spacing (#5994) 2025-10-24 20:52:59 +01:00
Joel Jeremy Marquez
cf8a4b6e6a Fix InitialFocus not working on some fields (#5987)
* Fix InitialFocus not working on some fields

* Fix typecheck and lint errors

* Fix lint error

* Add ref type

* Add types

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #5987

* Revert vrt

* Update VRT screenshots

Auto-generated by VRT workflow

PR: #5987

* Cleanup

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-10-23 11:34:41 -07:00
David Genord II
55b1ed170b Bump Alpine docker image to 3.22 upgrading from node 18 to 22 (#5989) 2025-10-23 00:42:48 +01:00
Matiss Janis Aboltins
6c58e77ebb Add faq about budget file size shrinking (#816) 2025-10-22 22:51:07 +02:00
Jessica L
d712891921 Update nynab.md (#815)
Added instructions for using jq to pretty print budget list and find
budget id

---------

Co-authored-by: Stephen Brown II <Stephen.Brown2@gmail.com>
2025-10-22 19:11:43 +01:00
Matt Fiddaman
07224b1dfd drop support for node 20 (#811)
Supplements https://github.com/actualbudget/actual/pull/5937
2025-10-22 17:17:08 +01:00
Stephen Brown II
9bb5c18ef5 Add balance to rule template docs (#813)
Relates to https://github.com/actualbudget/actual/pull/5925

Documentation improvements:

* Added `balance` as a supported template variable, describing its type
and value in the template variables table.
* Updated spacing to fix some markdown lints.
2025-10-18 08:23:33 -07:00
Andrew
0e09aec9fd Remove condition regarding split transactions (#812)
---
category: Enhancements
authors: [AndrewG147]
---

Transfers can now be created from split transactions (changed in
[25.9.0](https://github.com/actualbudget/actual/pull/5604)). The former
condition is not valid anymore
2025-10-18 07:48:40 -07:00
Karim Kodera
117b77d6d7 Documentation for Schedule API based on CRUD. (#729) 2025-10-10 22:55:38 +01:00
Matiss Janis Aboltins
9087add617 Blog post: continuing contributor payments (#808) 2025-10-06 18:58:32 +01:00
Matiss Janis Aboltins
f607f3dd79 Update Yarn configuration and dependencies; migrate to Yarn 4.10.3 (#809) 2025-10-04 10:27:42 +01:00
Matt Fiddaman
a60cef1f3f 🔖 (25.10.0) (#806)
Actual: https://github.com/actualbudget/actual/pull/5834
Docs: https://github.com/actualbudget/docs/pull/806

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
2025-10-02 12:30:30 +01:00
Dustin
2f260699ee Update text widget description in index.md (#807)
Updated text widget description since it does not actually run or
generate a report.
2025-10-02 01:00:27 +01:00
Jonas
aebaf42eed rule-templating: clarify meaning of sub prefix in date functions (#803) 2025-09-28 00:09:15 +01:00
Eric J
f0fcdf41e4 Update Tips and Tricks (#805)
Added section highlighting the ability to use math operators in amounts
2025-09-25 14:43:24 +01:00
Martyn Ranyard
c19cd3ce57 Added more notice that GoCardless no longer accepts new accounts. (#799)
Users will attempt to install actual, and connect it, but then find they
cannot sign up, so pointing this out earlier is a good thing.

Ideally in the docs page actual should stop advertising it at all, and
simply leave the instructions there for people who already have
accounts, but not mention it in the features and such.
2025-09-23 13:58:46 +01:00
Matt Fiddaman
9a7df9b05d document api quiet mode (#802)
For https://github.com/actualbudget/actual/pull/5762
2025-09-22 13:01:32 +01:00
Ruben Olsen Lærk
ea349af32f Closing 787 by clarifying example image. (#790)
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-09-22 10:18:38 +01:00
Haritha Hasathcharu
e6ffa63aaa Fix minor spelling error (#801)
Fix a minor spelling error in `docs/advanced/restart.md`.
2025-09-21 10:16:30 -07:00
Amr Awad
58dcc66e50 [WIP] Add Lunch Flow to community projects (#800) 2025-09-20 21:58:09 +01:00
Matt Fiddaman
23a943a05b remove BANKS_WITH_LIMITED_HISTORY override instructions (#798)
https://github.com/actualbudget/actual/pull/5714
2025-09-11 15:48:28 +01:00
Matt Fiddaman
f1a8522b79 add warning for GoCardless sign up instructions (#797) 2025-09-11 15:48:14 +01:00
Abraham
277967c722 Fixing typo in documentation (#796) 2025-09-11 15:39:12 +01:00
Julian Dominguez-Schatz
afc97220b9 🔖 (25.9.0) (#794)
https://github.com/actualbudget/actual/pull/5663
2025-09-03 21:08:50 -04:00
Matiss Janis Aboltins
902f57a4a4 Fix contributor list by moving @alecbakholdin (#795) 2025-09-03 23:00:14 +01:00
Jonathan
fb5c47d13d Make Experimental Features installation instructions more obvious (#792)
I could not find instructions on the [Budget
Templates](https://actualbudget.org/docs/experimental/goal-templates)
experimental feature docs page for how to enable the feature. I did not
look closely enough at the advanced settings to realize I had to click a
link, even though I had looked at the setting page.

After asking in discord, I was told how to enable the feature, and even
found that there was a parent page [Experimental
Features](https://actualbudget.org/docs/experimental/) which had the
instructions I would have needed.

This PR simply adds a short sentence with a link back to that root page
on the experimental features pages. This would have helped me find my
own solution without needing to ask.

I did not add anything to the [Pluggy.ai
Setup](https://actualbudget.org/docs/experimental/pluggyai) page because
it has the blurb `Pluggy integration is experimental at this point, so
before you can use it you need to enable it under Settings -> Advanced
Settings -> Experimental Features -> Pluggy.ai Bank Sync` in the page
and didn't have the same callout sections at the warning callout
sections as the other pages at the top.
2025-09-02 08:33:51 -07:00
frank_zhang
0b926b86b1 Update sync.md (#786)
Add the lacking double quote in the sub-title: What Does Resetting Sync"
Mean
2025-08-15 06:21:41 -07:00
frank_zhang
9397bdd733 Made some adjustments to make the doc more readable (#788) 2025-08-15 06:21:07 -07:00
frank_zhang
5919ad79a1 Update restore.md (#784)
Completed the beginning introduction of Restoring a Backup doc

**P.S. The first screenshot illustrating where to close the finance file
needs to be updated to comply with that in the current version.**
<img width="384" height="402" alt="截屏2025-08-15 09 48 32"
src="https://github.com/user-attachments/assets/c44012df-ecc3-4d76-8280-858001c68aa8"
/>
2025-08-14 19:00:40 -07:00
frank_zhang
4d02e1edd9 Update filters.md (#782)
Make descriptions match picture
2025-08-13 20:29:26 -07:00
frank_zhang
5f6f430aed Update index.md (#779)
Making the sentence more accurate and easy-to-read.
2025-08-13 20:27:29 -07:00
frank_zhang
52c9849aed Update schedules.md (#778)
corrected a grammatical error
2025-08-13 20:26:31 -07:00
Pheggas
ea2d334c40 [WIP] Better readability and fixes (#754)
I changed two docs pages - multi user and oauth (opeid provider).

There were some minor inconsistencies and errors. I also fixed the
redirect URI from `<domain>/path/openid/callback` to
`<domain>/openid/callback` as the first one was incorrect for my
keycloak instance.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-11 16:05:25 +02:00
Michael Clark
5e6efe0f45 Change search plugin to a more accurate one (#771)
The search tool we use has always been a bit clunky for me. There's no
keyboard shortcut support, it doesn't look great, doesn't support react
19, and I had to write a theme sync function for it to work properly
with Docusaurus V3.

The package I've upgraded here fixes all those issues. I've also updated
all the packages to the latest version, and aligned the node support
with the Actual repo.

**Old (very inaccurate search):**

<img width="885" height="573" alt="image"
src="https://github.com/user-attachments/assets/eae157de-8282-412f-b89c-618f3e3e99e5"
/>

**New:** 

<img width="676" height="605" alt="image"
src="https://github.com/user-attachments/assets/145db22f-8216-4e3f-9a98-a8bd469f1494"
/>

It also comes with a fancy new search page when you click _See all
results_
2025-08-10 19:56:26 +01:00
Ruben Olsen Lærk
8e193f4887 Download page is now centered. (#774)
Fixing an old annoyance :-)
2025-08-10 20:18:37 +02:00
Ruben Olsen Lærk
e5da8818d5 Fixing #745 - Limitations of privacy filter not disclosed in docs (#772)
- Amended main explanation in Tips And Tricks
- Linked to the caveats from the Tour dealing with the UI.
- Bonus: Fixed ALT TEXT on images.
2025-08-10 18:16:03 +02:00
Ruben Olsen Lærk
e8b6d9a7b0 Another starting fresh method (#761)
Based on a discussion in #general-chat about starting fresh from
https://discord.com/channels/937901803608096828/940290142579605514/1400170231556603954

Thanks to Magnus Burnsides for this kick in the butt :-D
2025-08-10 16:22:37 +02:00
Michael Clark
622d97c06f Upgrade docusaurus (#769)
> [!NOTE]  
> Important This will need a decent amount of testing of images, links,
sidebar, rss feed, etc

Upgrading Docusaurus to the latest.

- We can now use Mermaid diagrams
- It's supposed to have better performance
- It's actively supported (v2 wasn't)

Throughout this PR you'll notice 

- Formatting updates (they are required for the build process)
- Some CSS updates - some default styling was changed in the plugins we
use. The updates I've made should make the style near identical to
what's currently live
- Some updates & fixes to bring our docs in line with the v3 way of
writing

Overall, the docs should look the same.


## Known issues:

- The top page nav is flickering when clicking links in the top page
nav. It's happening on the main Docusuarus website
https://docusaurus.io/blog
- If we upgrade we'll have to accept it until they fix it on their end
2025-08-09 14:52:21 +01:00
Alex Camilleri
43bc27e00f [WIP] Adding bank: fixed instructions order (#766)
I encountered this issue when I [created a
PR](https://github.com/actualbudget/actual/pull/5479) to add a new bank
to Actual.
The docs were instructing me to first create the PR and then generate
the docs.

At the same time, when I tried to open the PR, the default template
message was instructing me to generate the release notes *before*
opening the PR.

```
<!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. -->
```

I am not sure who is telling the truth here, but given the emphasis that
the template put on *before* I am inferring that the docs had the wrong
order. If this is not the case, of course feel free to nuke this PR and
update the GitHub template instead.
2025-08-07 07:58:24 +02:00
fritz
6ae701b389 fix: mention ACTUAL_DATA_DIR is now dataDar in config (#758)
<!-- The process for Actual Budget Community Documentation pull requests
is documented at
https://actualbudget.org/docs/contributing/#submitting-a-pull-request
-->

Fixes
[actualbudget/actual/#5395](https://github.com/actualbudget/docs/issues/759)

**TL;DR** ACTUAL_DATA_DIR works as an env variable but not in the
config.json anymore. That comes up if you are migrating from the old
server to the new.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-06 21:48:12 +02:00
Matt Fiddaman
c8fb61e270 add paying contributors page to sidebar (#764)
I found this through the blog post, but the page wasn't set up correctly
with a title and didn't appear in the sidebar.

Before:
https://actualbudget.com/docs/contributing/leadership/paying-contributors

After:
https://deploy-preview-764.www.actualbudget.org/docs/contributing/leadership/paying-contributors

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-06 13:43:33 +02:00
POGMAN
cf1cafa46b Add Tags documentation (#756)
Add documentation for notes tagging and how to change their colors.

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-02 12:17:22 -04:00
Matt Fiddaman
f9a33a14d6 🔖 (25.8.0) (#763)
Actual PR: https://github.com/actualbudget/actual/pull/5447
2025-08-02 12:17:11 -04:00
Amit Palti
07db8696cb add a link to moneyman importer (#762)
found this importer named Moneyman,
It can import from most banks in Israel 
see
https://github.com/daniel-hauser/moneyman
2025-07-31 12:18:19 -07:00
Ruben Olsen Lærk
76c0e615af Added information on how to manage spelling errors in the docs (#760)
People are unsure on how to handle the spelling bot errors.
2025-07-31 08:35:39 +02:00
Henry Bley-Vroman
27a632d186 update fly setup cli flow (#449) (#732)
- Fixes https://github.com/actualbudget/docs/issues/449 which was closed
early

The CLI flow for setting up a new Fly app has changed and simplified.
This PR brings the Actual docs up to date.

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-07-29 06:38:00 +02:00
youngcw
ed11581d5e updates to template docs (#743)
This adds the documentation for
actualbudget/actual#5288
actualbudget/actual#5295
actualbudget/actual#5301

And also some minor additions in other places.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-07-29 06:34:47 +02:00
Falke Carlsen
a9c8aff56f [WIP] Add promox helper scripts link (#752)
These scripts are useful for quickly provisioning on a Proxmox instance
2025-07-28 22:05:22 +02:00
Matiss Janis Aboltins
b82b9f3837 Revert "apple container docs" (#757)
Reverts actualbudget/docs#725

See explanation in
https://github.com/actualbudget/docs/pull/725#issuecomment-3119926083
2025-07-28 21:44:50 +02:00
Michael Clark
a0a1ca4855 Fix ctrl/cmd issue on tips and tricks page (#751)
Prevented `cmd` mod from getting changed to `ctrl` when users were not
on Macs.
2025-07-23 22:36:20 +01:00
Henry Bley-Vroman
a28f137bbd add contribution docs to repo; add PR template with PR process docs link comment (#733) 2025-07-23 21:29:54 +02:00
FF-Ibb-PD
c16b31267d Update Apache httpd with correct ProxyPass and ProxyPassReverse settings (#753)
Fixed an Error:
Proxy Pass & Proxy Pass reversed need the tailing / - otherwise static
assets like /static/js/ won't be accessable.

Improvement:
"ProxyPreserveHosts on" submits the host to ActualBudget (e.g.
"budget.example.com")

RequestHeader set X-Forwarded-Proto "https" 
RequestHeader set X-Forwarded-Proto "443" 
Preserve an loop, if the app requires to be run with SSL
2025-07-21 13:06:50 +01:00
deathblade666
36815ad579 Fix Bank Sync in docs and add new picture (#750) 2025-07-19 14:13:17 +01:00
Joshua Taillon
e3bc160e3f add new shortcut key references (#748)
Documentation updates related to
https://github.com/actualbudget/actual/pull/5330
2025-07-19 10:53:56 +01:00
atgrey24
7730789033 Update rule-templating.md to include payee_name (#747) 2025-07-14 10:31:26 -04:00
Darius
5c09fae3fc chore: added link to correct gocardless service (#741)
After registering for a completely unnecessary GoCardless main account,
I found out you actually need GoCardless Bank Account Data acount. Lets
point other new users in the right direction.
2025-07-09 07:28:03 -07:00
youngcw
15529c3255 🔖 v25.7.1 (#740)
[web PR](https://github.com/actualbudget/actual/pull/5272)

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-07-03 06:56:29 -07:00
youngcw
59e51412d6 auto hold (#699)
matches actualbudget/actual#4778

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-07-01 14:06:02 -07:00
Julian Dominguez-Schatz
6f206e5f1a 🔖 (25.7.0) (#738)
https://github.com/actualbudget/actual/pull/5260
2025-07-01 16:52:23 -04:00
Ruben Olsen Lærk
04801d2b81 Closing #696 - total rewrite of the Schedule tool. (#734)
- Was expected to only close #696: _Add information about upcoming
schedule length._
- Added sections for Managing Schedules, Schedule Length, Find
Schedules.
- Added introductory section.
- Added clarification on the approximation on amounts
- Rewrote most of the document.
- New screen shots - and deleting old ones.
- Rewrote the intro section to reflect the planning aspects of schedules
and not the automation aspect.
- Added Account Register view screen shot and moved information on
account register view under the Adjusting the Upcoming Length heading.
- Removed "Schedule Options That Are Not Supported" section and moved
information about not supporting holidays as a note under schedule
creation.
2025-06-30 21:28:03 +02:00
Ruben Olsen Lærk
e75e9b95aa Added Warning callout as this was missing (#737)
We use warnings several places, especially with regards to experimental
features.
2025-06-30 15:35:11 +02:00
Ruben Olsen Lærk
fac96d2e3e Adding tips on using emojis in the budget. (#735) 2025-06-30 12:26:24 +02:00
Jin
6fc739a514 [WIP] Fixing a typo in the documentation (#736) 2025-06-29 20:00:30 +02:00
Ruben Olsen Lærk
7402e4bb66 Fixing #728 - add command palette documentation in Tips and Tricks page. (#731)
- Also adding screenshot of command palette.
- Fixed misc headers
- Removed section global shortcuts in the electron app as they don't exist
2025-06-28 09:09:46 +02:00
Matiss Janis Aboltins
a00b584126 Add Cursor IDE documentation (#730)
- Introduced a new document for Cursor IDE, detailing setup, automation,
and custom rules.
- Updated the new core contributors guide to include a link to the
Cursor IDE documentation for additional tips.
2025-06-25 20:55:40 +01:00
Matiss Janis Aboltins
ad88007829 Document payment system for core contributors and update proposal status (#723) 2025-06-23 18:42:11 +01:00
Taylor Jones
8f5b8aad31 Add iOS Widget Community Project: community-repos.md (#727)
Adds a listing to the Community Projects doc page for an iOS widget
project.
2025-06-21 07:57:47 -07:00
Matt Farrell
dcfd0e2e92 apple container docs (#725)
Adds documentation to run Actual in the newly released Apple Containers.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-06-19 06:15:09 +02:00
Michael Clark
0f3716a206 Add reset password to cli tool docs (#726)
Updated the CLI tool page with docs for the new reset-password option:
- https://deploy-preview-726.www.actualbudget.org/docs/install/cli-tool


Updated this blurb to be more specific:
-
https://deploy-preview-726.www.actualbudget.org/docs/install/desktop-app#exposing-your-local-server-to-the-internet
2025-06-17 22:06:19 +01:00
André Roggeri Campos
b6c52df888 Update pluggy.ai dashboard url (#724)
Updating the URL to pluggy.ai console (now called dashboard). There are
some screenshots still using the console name that I can rename if you
prefer.
2025-06-15 11:51:43 -04:00
youngcw
e8db6672c1 add experimental page (#718)
Adds a base page for the experimental features section. This says what
experimental features are and how to enable them.
2025-06-14 08:59:14 -07:00
Spencer-Sawyer
4f9e4581f3 Update contributing/project-details (#714)
- Desktop electron works with self hosted out of the box now.
- Made Sync Server a third level header for consistency since it's no
longer in a separate repo.
2025-06-14 07:55:16 -04:00
Michael Clark
456ffa6f5b Update core team (#722)
Teprifer joined Alumni on 2025-05-10 


https://discord.com/channels/937901803608096828/1106842738239995904/1370882805587775640
2025-06-12 21:21:48 +01:00
Matiss Janis Aboltins
70468a8a64 📝 (proposal for spending community funds) (#709)
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-06-08 16:01:33 +01:00
Matt Farrell
ac766221f2 [WIP] ActualTap documentation (#719)
Current documentation includes ActualTap-Py which is a fork of
https://github.com/MattFaz/actualtap *(which I use/maintain)*.

Adding in the original ActualTap repo and updating ActualTap-Py to
clarify differences.
2025-06-07 06:23:22 -07:00
Matiss Janis Aboltins
8699fc2865 Add sponsored Cursor subscription details for core contributors (#721) 2025-06-07 13:46:20 +01:00
Matiss Janis Aboltins
c441df5377 Add triaging issues guidelines to contributing documentation (#720) 2025-06-07 13:45:20 +01:00
Matt Fiddaman
612ae400c5 🔖 (25.6.1) (#717)
https://github.com/actualbudget/actual/pull/5099
2025-06-04 18:21:00 -04:00
youngcw
7a9a34d142 move multi user docs since its been released (#712) 2025-06-04 04:36:30 -07:00
Michael Clark
5dabea55b3 Desktop server docs (#716)
Introduces some docs for the Desktop App. 

**Pages chnged:** 

-
https://deploy-preview-716.www.actualbudget.org/docs/install/desktop-app/
2025-06-04 00:42:24 -04:00
Julian Dominguez-Schatz
62eee6404a 🔖 (25.6.0) (#715)
https://github.com/actualbudget/actual/pull/5083
2025-06-04 00:37:25 -04:00
Ruben Olsen Lærk
1c13389e4d Syncs transactions from banks like Akahu and Up to Actual Budget (#713) 2025-06-01 17:43:14 +02:00
Adam Millerchip
6609580f72 add an alternative Synology guide (#710)
Add a link to [my guide](https://adamu.jp/blog/actual_budget_nas) to
installing Actual on a Synology NAS that uses a different method than
the existing guide: using Docker's [Container
Manager](https://kb.synology.com/DSM/help/ContainerManager/docker_desc?version=7)
app, and additional TLS certificate options.
2025-06-01 12:40:41 +02:00
Pan
63343d32e2 Fix ambiguous examples in goal-templates page (#707)
The last two examples for the goals have created confusion because the
template and goals line shows in one line:

https://discord.com/channels/937901803608096828/1372691110614274170/1376211790639136779

This PR makes sure that any `#template` and `#goal` lines that are meant
to go together are displayed on top of each other instead of inline.

It also makes sure that all uses of `#template` show with inline
code-formatting for overall conistency.
(Let me know if you'd rather have this in a separate PR and I'll splice
out that commit.)
2025-05-27 08:32:04 -07:00
POGMAN
57b2c36145 List Arch AUR packages (#706)
There was one package in the doc (actual-appimage) but there is more
actually :D
2 Desktop clients based on the AppImage and a server based on the
@actual-app/sync-server NPM package.
2025-05-26 07:27:56 +02:00
Julian Dominguez-Schatz
d0fc4949be Update release docs with the latest changes (#705) 2025-05-23 19:07:18 -04:00
Spencer
74a1182381 Fixed Typo on apache reverse proxy page (#704)
Also changed the proxy pass to be http instead of https since the
default for an Actual container is http.
2025-05-23 16:44:29 -04:00
Ruben Olsen Lærk
d1f9d8e125 Fixing miscalculation (#703)
Fixing #702
2025-05-21 16:34:18 +02:00
POGMAN
340e49f480 Update community-repos.md to add actual-userscripts (#701)
PR to add a link to a collection of userscripts to use with Actual web
client.

https://github.com/pogman-code/actual-userscripts
2025-05-21 14:53:21 +02:00
Mitch B.
29e1af364b Pocket ID tested with OAuth (#697) 2025-05-15 21:28:55 +02:00
Ruben Olsen Lærk
2c1d5eeeff Fixing #608 by documenting the actual process. (#698)
- Adding new screenshots.
- Deleting old screenshot.
- Also did some language changes on the rest of the page.

This should address @youngcw wrote in a comment on PR
https://github.com/actualbudget/docs/pull/599 _The restore page is a
little weird where it says you need to logout before you can do a
restore. That should be changed at some point._
2025-05-15 10:26:55 +02:00
Ruben Olsen Lærk
e80805276a Adding some fancy reporting dashboards to the front page (#694)
Also as a teaser on the customer report documentation page. We need to
show of some cool stuff.
2025-05-13 06:17:36 +02:00
Ruben Olsen Lærk
eeae707229 Fixing #663 Privacy Filter / Scramble and Hide data documenation (#693)
The privacy filer / scrambling function has so far only been briefly
mention on the first page of the tour guide.

I added some screenshots + text to the tips and tricks page.

As a bonus I also added ALT text to the existing images.
2025-05-13 06:16:58 +02:00
Matt Fiddaman
4e243420fa change minimum version of Node.js to version 20 (#692)
I think I got all instances where we specify a version, there seem to
only be two places in the docs.

We'll also call it out in the release notes.

https://github.com/actualbudget/actual/pull/4978
2025-05-12 19:17:10 +02:00
Ruben Olsen Lærk
73838c8ec6 Add link til Arch Linux User Repository (AUR) package (#691)
See
https://discord.com/channels/937901803608096828/1027831463103696928/1349820333221478431.

Ordered the list alphabetically.
2025-05-12 10:50:32 +02:00
Michael Clark
135719f7be Ngrok reverse proxy docs (#688)
I think this might be useful for people running the Actual Desktop app
with the sync server.

I might add the link to this in the desktop app dedicated docs page
(when I've made it). In that page, I'll mention that a reverse proxy can
expose Actual Server to the internet for free.

-
https://deploy-preview-688.www.actualbudget.org/docs/config/reverse-proxies
-
https://deploy-preview-688.www.actualbudget.org/docs/install/build-from-source

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-05-12 09:18:29 +01:00
azrikahar
9cc802cd28 Minor tweaks to the Caddy compose file (#689)
Changes made with some justification, in order of commits:
- removed port mapping for `actual-server` service since we're using
Caddy as the reverse proxy, similar to how there's no port mapping for
the Traefik example
- minor consistency changes by referring to the Traefik example:
  - moved `image: caddy:alpine` to the top
  - add restart policy
  - swapped one inconsistent single-quoted port mapping to double quotes
2025-05-09 07:19:56 -07:00
Julian Dominguez-Schatz
4184496010 🔖 (25.5.0) (#687)
code: https://github.com/actualbudget/actual/pull/4916

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Julian Dominguez-Schatz <jfdoming@users.noreply.github.com>
2025-05-03 14:19:28 -04:00
Michael Clark
0bc8db4ed5 Docs for new sync-server npm package (#680)
**To be merged on the next release.**

Goes with the new @actual-app/sync-server package:
https://github.com/actualbudget/actual/pull/4798

**Pages changed:**
- https://deploy-preview-680.www.actualbudget.org/docs/install/
- https://deploy-preview-680.www.actualbudget.org/docs/install/cli-tool
-
https://deploy-preview-680.www.actualbudget.org/docs/contributing/releasing
- https://deploy-preview-680.www.actualbudget.org/docs/config

**Notable changes**
- New CLI Tool docs
- Cutting a release - we no longer need to manually publish any npm
packages.

---------

Co-authored-by: Julian Dominguez-Schatz <julian.dominguezschatz@gmail.com>
2025-05-03 13:56:44 -04:00
dgsouzabr
a332889db9 [WIP] Update pluggyai.md - Adding missing required setting step (#679)
Adding required step to enable Pluggy under current version
2025-04-23 18:54:16 +01:00
Matiss Janis Aboltins
9cbcc035ac Update index.md (#686) 2025-04-23 18:52:38 +01:00
Henry Bley-Vroman
499ee4e58c [WIP] downloads: intel and apple silicon mac labels [#681] (#682)
- Closes #681

Adds Intel and Apple Silicon to the relevant macOS downloads.
2025-04-23 18:52:13 +01:00
Cameron Jackson
ed9a3a7204 [WIP] Update actual-server-repo-move.md (#672)
Put Windows-specific step in parens to differentiate it from the rest of
the steps

Also gave clarification upfront to inform users what the end-goal is.
2025-04-23 18:51:36 +01:00
ale1800
326398cc3f [WIP] free tier clarification in gocardless.md (#666) 2025-04-23 18:50:28 +01:00
Remilia Da Costa Faro
a77f83ed31 [WIP] Removed GPS informations from matt-fidd.jpeg (#675)
Hello!

I'm using [a plugin in my
browser](https://github.com/allanlw/gps-detect) to be notified when an
image contains GPS data in the metadata of images, and I noticed while
reading the latest release notes that matt-fidd.jpeg contained some GPS
coordinates, so this pull requests is just to remove those from the
image.

Have a nice day
2025-04-23 18:49:49 +01:00
lelemm
8feae65e37 Openid config changed with convict config (#685) 2025-04-23 13:55:31 -03:00
Landon Gavin
015a8d682a Update community-repos.md to correct tool name from "Actual Budget Auth Sync" to "Actual Budget Auto Sync". (#684) 2025-04-22 13:43:40 -07:00
deathblade666
5671c598b9 Update https.md to include config.json creation through terminal (#662)
Add instructions for creating the config.json via a single terminal
command.

Reasoning - Assisted a MacOS deploy where they had everything setup
correctly but when they made the config.json file their instance
crashed, this was due to using the default GUI text editor which saved
the file as a .rtf and they renamed to .json. Doing this will leave
metadata in the file and actual wont know what to do with it causing an
infinite restart loop.

This addition provides a simple method to create the file without the
possibility of extra formatting bits causing issues
2025-04-22 07:45:51 -07:00
ftbboy2115
54f833b9c4 Update schedules.md (#654)
Added details regarding expected functionality surrounding repeating
schedules and the end of the month.
2025-04-22 07:44:58 -07:00
Kennedy242
82c8e9f98c Update Reports Documentation (#668)
More reports have been added! 

Update the docs to reflect this.
2025-04-22 07:42:38 -07:00
Landon Gavin
959d2044ca Update community-repos.md to add actual-auto-sync (#683)
PR to add a link to a tool to auto-sync accounts on a schedule.

https://github.com/seriouslag/actual-auto-sync
2025-04-22 07:39:44 -07:00
Alec Bakholdin
48c41e8015 added documentation for merging transactions (#678)
See implementation in this PR:
https://github.com/actualbudget/actual/pull/4739

Co-authored-by: Alec Bakholdin <abakho@icims.com>
2025-04-21 10:15:50 +01:00
Stefan Gloutnikov
3705e27330 Added instructions for disabling automatic rule creation (#677)
Added instructions to the rules documentation for disabling future
automatic rule creation.
2025-04-06 19:19:19 -04:00
youngcw
8c4af1f5ef fix download links (#676) 2025-04-06 11:13:15 -07:00
Matt Fiddaman
ece822e1c5 call out electron sync server embedding in 25.4.0 release (#674) 2025-04-05 00:40:57 -04:00
Matt Fiddaman
1062a51226 🔖 (25.4.0) (#673)
- web https://github.com/actualbudget/actual/pull/4728
- docs https://github.com/actualbudget/docs/pull/673
2025-04-04 23:50:56 -04:00
lelemm
173090c2fd Added pluggy warning trial (#671) 2025-03-31 14:41:12 -03:00
Michael Clark
a604e19ac4 Updating repo move instructions to include bash requirement (#669)
It should help people moving to the new repo on Windows:

Based on this:

https://discord.com/channels/937901803608096828/1355224207541276826/1355229374986719242
2025-03-31 13:59:11 +01:00
lelemm
51f93861e4 Added callback url to openid page (#670) 2025-03-28 17:14:25 -03:00
lelemm
6e4a06528b Pluggy docs (#667)
Adding a draft for pluggy.ai docs
2025-03-26 12:27:59 -03:00
Alec Bakholdin
a30b406781 Update documentation to include new yarn generate:release-notes script (#665)
Referenced script is introduced here
https://github.com/actualbudget/actual/pull/4664
2025-03-26 00:05:12 -04:00
Michael Clark
88a9ba6cba Adding git bash as a prereq for Windows & renaming local install to Build from source (#664)
- Added desktop app to installation options "on your own machine" 
- For building from source
- Windows Users will need Git Bash so that they can build the web client
using the bash scripts.
  - Added a warning on the build from source page
- Reordered the _Build from source_ link to the bottom to encourage the
simpler options insted


![image](https://github.com/user-attachments/assets/d1dd032f-0482-444d-9e2d-2d0fe5cab980)


![image](https://github.com/user-attachments/assets/694f9303-d35e-44ba-b00e-2c6c3187bb88)
2025-03-19 21:08:25 +00:00
Michael Clark
d5b6e40c81 Update docs with new instructions for workspace reference in server (#661)
Should be merged with: https://github.com/actualbudget/actual/pull/4569

**Changed pages:** 
- https://deploy-preview-661.www.actualbudget.org/docs/install/local
-
https://deploy-preview-661.www.actualbudget.org/docs/contributing/project-details/
-
https://deploy-preview-661.www.actualbudget.org/docs/contributing/releasing/
-
https://deploy-preview-661.www.actualbudget.org/docs/contributing/windows/
-
https://deploy-preview-661.www.actualbudget.org/docs/actual-server-repo-move/
2025-03-14 09:08:50 +00:00
Quiwy
feb68dc7f8 Add missing doc about env vars. (#660)
Closes #658
2025-03-06 08:01:30 -07:00
lelemm
ad53fcb3c6 Added environment variables to OpenID page (#650)
Added environment variables to OpenID page

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-03-04 21:47:34 -03:00
daniefdz
1bd2964e15 add gcp cloud run install option (#648)
I created a repository with steps to deploy Actual Budget as a Cloud Run
service. I believe this is a better way to deploy in GCP and it's less
complicated.
2025-03-04 23:38:15 +00:00
Julian Dominguez-Schatz
4c3368bd13 Fix blog post date (#657) 2025-03-02 21:13:39 -05:00
Julian Dominguez-Schatz
ee4d9d65af 🔖 (25.3.1) (#656)
https://github.com/actualbudget/actual/pull/4497
2025-03-02 20:17:11 -05:00
Michael Clark
7dc34a9b99 Update missing start server command (#655)
Missed an instance of ```yarn start:server```
2025-03-02 15:35:45 +00:00
Julian Dominguez-Schatz
9d646f9d12 Add docs on data to move (#653) 2025-02-28 19:39:55 -07:00
youngcw
0bfa988f2b Note on fixing nYNAB duplicates after import (#625)
goes with actualbudget/actual#4294

Merge in at release of v25.3.0

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-02-28 19:01:19 -07:00
Michael Clark
37b570c302 Update github container reference to new repo (#652)
Updating to point to the new github container located here:
https://ghcr.io/actualbudget/actual

This is to accommodate this change:
https://github.com/actualbudget/actual/pull/4483
2025-02-28 20:57:38 -05:00
Julian Dominguez-Schatz
05e187092a 🔖 (25.3.0) (#651)
Release docs for https://github.com/actualbudget/actual/pull/4478
2025-02-28 20:52:41 -05:00
Matt Fiddaman
531cdc264a add lelemm to maintainer list (#649) 2025-02-26 17:23:13 +00:00
David Kaufman
199ebb499f Add SimpleFIN where GoCardless mentioned in Accounts docs (#643)
Replace: Link to GoCardless
With: Link (to GoCardless for Eurpean Banks or SimpleFin for North
American Banks)
2025-02-17 17:17:02 +00:00
Michael Clark
bf8dd4d345 Update sync server config information (#646)
Making it clearer where the config.json file lives and adding it to the
repo move instructions.
2025-02-17 09:16:03 +00:00
Michael Clark
ba49c1651e Upating Local install docs for people on a clean clone (#645)
Issue reported here: https://github.com/actualbudget/actual/issues/4377

https://deploy-preview-645.www.actualbudget.org/docs/install/local

It turns out that yarn doesn't let you run scripts without first
installing dependencies, so users will have to type it in the install
manually.

The other alternative is to run the script with npm but that would add
confusion.

I think yarn workspace focus is the best option to pick but here was the
options:

- Instruct users to ```yarn install``` (which would install all deps) -
1.07GB
- Instruct users to ```yarn workspaces focus @actual-app/sync-server
--production``` (which is a long command) - 60.6MB
- Create a new shell script to run the command ```
./install-server.sh```

In future we might want to consider packaging the server up into an
executable. That way the user wont have to install node/deal with any of
this stuff.

Here's an example packager - i've never used it:
https://github.com/nexe/nexe
2025-02-17 09:15:36 +00:00
David Kaufman
ea180dc924 Two small corrections to config docs page (#640)
- s/want to Actual to serve/want Actual to serve/
- s/allowed to authentic with/allowed to authenticate with/
2025-02-16 22:59:12 +00:00
David Kaufman
ca7164b01c Small doc correction to local.md install instructions (#639)
s/below/above/ referring to the startup output (which is now actually
"above" the paragraph)
2025-02-16 22:58:43 +00:00
David Kaufman
25ad8353d8 [WIP] Grammar correction to starting-fresh.md page (#641)
s/like bill and groceries/like bills and groceries/
2025-02-16 22:56:43 +00:00
David Kaufman
116508aa47 Correct Rule link syntax, url and drop-down menu item name on schedul… (#642)
…es.md page

Corrected:
- link [Rules][rules] to [Rules](/docs/budgeting/rules)
- s/Click Link Selection/Click Link schedule/
2025-02-16 22:56:08 +00:00
David Kaufman
4028ba448d [WIP] Small grammar correction to filters docs page (#644)
s/To clear out the any/To clear out any/
2025-02-16 22:52:32 +00:00
Simon Mayerhofer
1c7b8e2e5f Add Priotecs MoneyControl importer reference (#624)
I created a new importer to migrate from [Priotecs
MoneyControl](https://primoco.me/) to Actual Budget and linked it in the
docs.
2025-02-16 16:53:53 +00:00
Matt Farrell
1434ed8711 Documenting percentage adjustments feature for actual PR #4257 (#631)
Goes with https://github.com/actualbudget/actual/pull/4257
2025-02-13 16:53:41 -07:00
Matt Fiddaman
275e6da9e8 update payees page (#634)
Closes https://github.com/actualbudget/docs/issues/505
2025-02-13 03:36:01 +00:00
Matt Fiddaman
bfc1b0ef3f update filtering page (#635)
Closes https://github.com/actualbudget/docs/issues/604

Budget used (for future reference if these need revisiting): 

[docs-filtering-budget.zip](https://github.com/user-attachments/files/18776247/docs-filtering-budget.zip)
2025-02-13 03:35:50 +00:00
Matt Fiddaman
f55a67c009 add release dates to releases page (#636)
Closes https://github.com/actualbudget/docs/issues/493
2025-02-13 03:35:37 +00:00
Matt Fiddaman
cd1b5f1052 add docs for rule action templating experimental feature (#632)
Closes https://github.com/actualbudget/docs/issues/480

Feedback issue for the reference
https://github.com/actualbudget/actual/issues/3606

This is a starting point for a more fleshed out version, adding examples
in the future would be good
2025-02-13 01:54:16 +00:00
Matt Fiddaman
55e41fbf97 update reconciliation page (#633)
Closes https://github.com/actualbudget/docs/issues/485

This is probably hard to review through GitHub as the file name ordering
has been fixed too, best look at it through the deploy too.
2025-02-13 01:09:21 +00:00
Julian Dominguez-Schatz
e341630e8c Add docs for i18n on local install (#630) 2025-02-11 19:15:13 -05:00
Michael Clark
a0a0d5de51 Updating references to Actual-Server to point to Actual repository (#620) 2025-02-10 22:29:03 +00:00
Michael Clark
6308598f29 Documenting the server repo move (#629)
Documenting the repo move. I'll attach this doc to the Server readme so
people are more informed


https://deploy-preview-629.www.actualbudget.org/docs/actual-server-repo-move
2025-02-09 20:18:32 +00:00
Matt Fiddaman
ed9999be4c 🔖 (25.2.1) fix desktop apps and reports page (#628)
What commits will be included in the release?

https://github.com/actualbudget/actual/compare/v25.2.1?expand=1

---

- web: https://github.com/actualbudget/actual/pull/4319
- server: https://github.com/actualbudget/actual-server/pull/565
- docs: https://github.com/actualbudget/docs/pull/628
2025-02-06 19:05:27 +00:00
Julian Dominguez-Schatz
7cf8d3a96b 🔖 (25.2.0) (#626)
- web: actualbudget/actual#4296
- server: actualbudget/actual-server#561
- docs: actualbudget/docs#626
2025-02-05 16:53:06 -05:00
Julian Dominguez-Schatz
b5b3b533bf Add docs about releasing translations (#627) 2025-02-05 16:19:54 -05:00
Szymon Sakowicz
a559fda57f Add actual-budget-prometheus-exporter (#623)
Hello, 

I've created a prometheus metrics exporter and want to share it with a
community :)
2025-02-03 14:06:09 -07:00
ftbboy2115
f8440b62a8 Update 2024-07-01-ynab_v_actual.md (#617)
Corrected typo - "the don't worry" -> "then don't worry"
2025-01-30 22:42:53 +00:00
ftbboy2115
11ae860f5c Update envelope-budgeting.md (#615)
Capitalized and Italicized "to budget", where appropriate to improve
context clues.
2025-01-30 22:42:36 +00:00
ftbboy2115
d4614ee1ab Update 2025-01-02-roadmap-for-2025.md (#618)
Typo - "a opinionated" -> "an opinionated"
2025-01-30 22:41:57 +00:00
ftbboy2115
804a09e4ad Update https.md (#619)
Clarified sentence - "If this is desired" -> "If access from the
internet is desired"
2025-01-27 08:09:07 -07:00
Zachary Milonas
dc43a680e9 Fix link to main.ts in API docs. (#621) 2025-01-27 08:07:29 -07:00
ftbboy2115
344448560e Update reconciliation.md (#622)
Added lock emoji, clarified location of icon on webpage, and corrected
spelling.
2025-01-27 08:06:16 -07:00
nojohnny101
06aaab0277 [WIP] Update faq.md (#614)
small fix for typo
2025-01-24 15:19:05 +00:00
Andrew Buskov
48bf49c2d5 Update envelope-budgeting.md numbering (#616)
Corrected numbering
2025-01-24 08:13:39 -07:00
Kennedy242
8116279300 Update docker compose command (#613)
Update to newer docker compose command.

From the docs: From July 2023 Compose V1 stopped receiving updates. It’s
also no longer available in new releases of Docker Desktop.
See the docs: https://docs.docker.com/compose/releases/migrate
2025-01-22 15:27:33 +00:00
youngcw
b020e84b72 [Goals]: tweaks for clarity and note on lines (#611) 2025-01-19 00:00:55 +01:00
Travis Lesicka
15b7169529 Add Page for Multi-Currency Support (#594)
Adding a page to Using Actual/Budgeting to demonstrate how to implement
multi-currency using Rule Templates.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-01-15 13:38:23 -07:00
DJ Mountney
c5285aa512 Add auth proxies config to the docs (#581) 2025-01-13 20:17:39 +00:00
youngcw
2682f3bca8 reworking template docs (#606)
This is the start of getting the existing template setup ready to
mainline. We can consider making each template type its own file if this
feels too long.

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-01-13 08:00:49 -07:00
Julian Dominguez-Schatz
4fd70cab8f Update translation docs (#610) 2025-01-11 15:28:39 -05:00
Khiet Tam Nguyen
677c227f16 changed effect (noun) to affect (verb) (#609)
> Off budget accounts don't effect the budget and are meant to track
stuff like investments and mortgages. Transactions in off budget
accounts can't be categorized; they simply track balances over time.

Should be `affect`, a verb, instead of `effect`, a noun.
2025-01-10 09:40:32 -07:00
Ruben Olsen Lærk
1e935baf01 Fixing #566 - documenting ACTUAL_DATA_DIR environment variable. (#589) 2025-01-10 06:36:39 +01:00
Ruben Olsen Lærk
11b20e7961 Community repos ICS Cards and Amazon Order CVS file generators. (#602)
- https://github.com/IeuanK/AmazonExporter/
- https://github.com/IeuanK/ICS-Exporter/
See
https://discord.com/channels/937901803608096828/1027831463103696928/1325627562080206878

Changed a heading to _Bank Export and Importers_ as this is more correct
given the kind of contributions we see here.
Also, did I move the _My Edenred_ entry to its proper alphabetical
place.
2025-01-10 06:35:30 +01:00
Ruben Olsen Lærk
ee33b5c82b Export from commercial Actual Budget app-page and associated image is no longer relevant for the documentation. (#599)
Reason:  The commercial https://app.actualbudget.com has been axed. 

For export from the current open-source offering use the existing
documentation.

Replacment pages is found at
https://actualbudget.org/docs/backup-restore/backup and
https://actualbudget.org/docs/backup-restore/restore
2025-01-10 06:34:46 +01:00
Adam Monsen
89c0254df4 document multi-user usage of same budget file (#496)
Discussed in:

*
https://discord.com/channels/937901803608096828/969693280226906162/1288542693814960260
*
https://discord.com/channels/937901803608096828/1290073711730495599/1290073711730495599

Could someone with intimate knowledge of the syncing
architecture/CRDTs/etc. validate and help me perfect the text? I took
the conservative approach with my "To be safe..." comment, but if it
truly is fine to edit simultaneously, we should say so less
conservatively. Moreso, if simultaneous edits are supported behavior, we
should also take this page out of "experimental".

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-01-09 12:39:16 -07:00
Klemen Košir
7c3084fbc4 Update instructions for enabling Tracking Budget (#607)
This PR updates the instructions for enabling Tracking Budget. The
feature is no longer experimental, but the documentation still treats it
as such.
2025-01-09 12:31:38 -07:00
Ruben Olsen Lærk
2fa1d34d17 #470 - added section on Pay Yourself First strategy (#473)
A go at #470
2025-01-08 19:53:20 +01:00
Julian Dominguez-Schatz
7666337df6 Update releasing.md for release notes (#605)
Goes with https://github.com/actualbudget/actual/pull/4105
2025-01-07 18:36:00 -05:00
lelemm
af64b7484d Multiuser and OpenId (#447)
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-01-07 07:54:04 -07:00
Julian Dominguez-Schatz
dcf277afb3 🔖 (25.1.0) (#601)
- web: actualbudget/actual#4095
- server: actualbudget/actual-server#536
- docs: #601
2025-01-07 08:47:44 -05:00
Ruben Olsen Lærk
56ab44301b Adding Portuguese prepaid meal card tracking from @rodriguestiago0. (#598)
Also grouped this with with the Coinbase sync under a new heading called
Other Importers, as they are not necessarily pure banking-related
importers.
2025-01-06 19:56:34 +01:00
Ruben Olsen Lærk
296ffabee0 Fixing #582 Migration Link Broken by clarifying the content. (#600) 2025-01-06 19:53:31 +01:00
Matiss Janis Aboltins
17057027d5 📝 add UnderKoen and RubenOlsen to maintainer list (#595) 2025-01-04 13:55:17 +00:00
Zach Young
cd724027fb Update index.md (#561) 2025-01-03 13:04:36 +00:00
Ruben Olsen Lærk
0a20a82d01 [WIP] Fixing spellbot errors to prevent #561 to go stale (#592) 2025-01-03 13:32:34 +01:00
redshiftltd
9163c0a64e Update local.md - Adding Linux systemd unit file instructions (#489)
I wrote some steps on how to automate non-Dockerized Actual starting up
with Linux systems using systemd. I'm using this on my server and so far
so good.

If this is too much for this page please consider putting it on its own
page. I think it's useful info for anyone who wants to do self-hosted on
a VPS with a non-Docker instance.

---------

Co-authored-by: Brandon Fotiu <bfotiu@bgsu.edu>
2025-01-03 13:20:30 +01:00
Ruben Olsen Lærk
88d63d544e Fixing spellbot errors to prevent #561 to go stale (#591) 2025-01-03 13:16:18 +01:00
Joel Jeremy Marquez
c3590d8ce7 Use consistent terms regarding on-budget and off-budget accounts (#504)
Co-authored-by: Jeremy Marquez <jmarquez@starlinewindows.com>
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-01-03 08:26:31 +01:00
Matiss Janis Aboltins
6b74c58714 📝 (op-ed) looking ahead to 2025 (#588)
Recounting my journey from YNAB to Actual. Giving a brief roadmap for
2025. And lastly answering some comments/questions I keep seeing on the
internet.

https://deploy-preview-588.www.actualbudget.org/blog/roadmap-for-2025
2025-01-02 18:04:20 +00:00
quarklark
292877ab83 Closes #585 (#587)
Closes https://github.com/actualbudget/docs/issues/585 

I'm guessing the original intention for the index page was for it to be
associated with the Budgeting menu item.
2024-12-26 08:29:44 -07:00
Jason Axelson
151b409e0e Add dashboard and tracking budget links to latest release notes (#559) 2024-12-25 00:30:35 +00:00
Kai Chevannes
b704fbbf7c [WIP] fix envelope budgeting numbering typo (#584)
4 was duplicated, changed second occurrence to 5.
2024-12-23 14:40:58 +00:00
Robert Dyer
7b7f6c904c Add example of orderBy with a descending order (#583)
This adds an example to show how to change the sort order.
2024-12-23 14:34:45 +00:00
Matt Fiddaman
9fccd1e6dd Improve release documentation for maintainers (#580) 2024-12-16 17:17:42 +00:00
bpaulien
bab4b799d8 Update reference.md (#557)
title case, edited for clarity
2024-12-11 23:58:35 +00:00
bpaulien
06ca5a87f4 Update index.md (#556)
title case, edited for clarity
2024-12-11 23:58:30 +00:00
bpaulien
d01528b2cf Update tips-tricks.md (#555)
title case,
2024-12-11 23:58:22 +00:00
bpaulien
4e041ce5bf Update types.js (#554)
edited for clarity
2024-12-11 23:58:10 +00:00
Adivardhan Maheshwari
2ed1add5bc Update reconciliation instructions and images to reflect current UI (#560)
When I setup my actual account, I noticed that there was no
reconciliation button as described in documentation. Found out after
hunting, that the UI has changed resulting in this issue. I have created
this PR to update that.

Let me know if the language or images need to be changed.

Caused because of: https://github.com/actualbudget/actual/pull/3684
2024-12-11 23:56:03 +00:00
bpaulien
553d18e938 Update index.md (#569)
title case, punctuation
2024-12-11 23:55:19 +00:00
bpaulien
af720eecac Update index.md (#570)
punctuation, grammar, clarified name of nYNAB
2024-12-11 23:55:12 +00:00
bpaulien
d23eb40401 Update migrations.md (#573)
punctuation
2024-12-11 23:54:56 +00:00
bpaulien
b590d68a92 Update new-core-contributors-guide.md (#579)
punctuation, title case
2024-12-11 23:54:37 +00:00
bpaulien
dbca4c9962 Update writing-docs.md (#578)
punctuation, title case,
2024-12-11 23:54:30 +00:00
bpaulien
020f9c7dc0 Update releasing.md (#576)
punctuation, title case
2024-12-11 23:54:22 +00:00
bpaulien
11c2ec4255 Update preview-builds.md (#575)
capitalization, wording, remove duplicated paragraph
2024-12-11 23:54:16 +00:00
bpaulien
3687e7ae09 Update i18n.md (#574)
title case
2024-12-11 23:54:09 +00:00
bpaulien
eafd128c63 Update feature-flags.md (#572)
title case, punctuation, added clarifying words
2024-12-11 23:54:01 +00:00
bpaulien
51bbdcf1c4 Update database.md (#571)
punctuation, phrasing for better understanding
2024-12-11 23:53:54 +00:00
bpaulien
a2f14ee30b Update edge-browser.md (#568)
fixed punctuation
2024-12-11 23:53:35 +00:00
bpaulien
ad194555ee Update reset_password.md (#567)
title case
2024-12-11 23:53:26 +00:00
bpaulien
3d27dd91f0 Update server.md (#565)
title case
2024-12-11 23:53:19 +00:00
bpaulien
7ca1486bb0 Update examples.md (#564)
title case
2024-12-11 23:53:11 +00:00
bpaulien
2894d2f982 Update functions.md (#563)
title case, added words to make it flow better.
2024-12-11 23:53:04 +00:00
bpaulien
a66540d2b2 Update windows.md (#577)
punctuation, title case
2024-12-11 23:52:44 +00:00
bpaulien
5c3d9bea85 Update index.md (#562)
title case, spelling
2024-12-11 23:52:34 +00:00
youngcw
df2d60abe1 fix merge bug (#558) 2024-12-06 19:34:47 -07:00
youngcw
0178e3aed0 Update the tracking budget page so the feature can be released. (#483)
Moved the page out of experimental and added a few minor things.

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-12-06 13:50:49 -07:00
Matt Fiddaman
0b9f01b936 [WIP] fix titles in release notes (#553) 2024-12-06 20:04:38 +00:00
bpaulien
f0d775b3ae Update manage-files.md (#548)
title case, consistency in headers.
2024-12-06 19:48:26 +01:00
bpaulien
c5ad46cede Update monthly-cleanup.md (#549)
title case, edited for clarity
2024-12-06 19:47:57 +01:00
bpaulien
9b3de061a7 Update tracking-budget.md (#550)
title case
2024-12-06 19:47:13 +01:00
bpaulien
624de5645b Update goal-templates.md (#551)
remove currency symbols, add note explaining how they're used, tried to
standardize how template vs #template / goal vs #goal are used, some
edits for clarity,
2024-12-06 19:46:29 +01:00
Matt Fiddaman
969630cad3 fix version number for v24.12.0 (#552) 2024-12-06 18:39:46 +00:00
Matt Fiddaman
9ae6481fd4 🔖 (24.12.0) (#545)
- web: https://github.com/actualbudget/actual/pull/3931
- server: https://github.com/actualbudget/actual-server/pull/515
- docs: https://github.com/actualbudget/docs/pull/545
2024-12-06 18:31:43 +00:00
bpaulien
9d90eb5207 Update index.md (#533)
fixed title case on headers, spelling / grammar errors

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-12-06 13:19:06 +01:00
bpaulien
f2ad60f12e Update sync.md (#546)
title case, and edited for clarity
2024-12-06 13:18:13 +01:00
bpaulien
dd987fd625 Update index.md (#547)
wording change, and added clarification on how to get into the advanced
settings page.
2024-12-06 13:15:07 +01:00
bpaulien
d4bb3d043c Update custom-reports.md (#541) 2024-12-05 21:28:30 +01:00
bpaulien
b65fc30ede Update importing.md (#534) 2024-12-05 21:24:56 +01:00
ewatch
f16e539235 adds hint for missing date formats (#497)
If the date column is not configured correctly the date format will not
show up if it's not one of the preconfigured ones.
I think that can help in the documentation.
2024-12-05 08:37:09 +01:00
spoon1331
4501211125 Update reverse-proxies.md (#523)
After fighting with this for some time, it seems that the trailing slash
in apache config causes budget to think that the server is offline.
Removed.
2024-12-05 08:36:15 +01:00
bpaulien
2e9e5017fe Update categories.md (#524)
spelling, and word flow edits.
2024-12-05 08:35:08 +01:00
bpaulien
0aa163f329 Update reconciliation.md (#535)
title case, supply missing words.
2024-12-05 08:31:22 +01:00
bpaulien
eb60cc8c5b Update payees.md (#536)
title case, clarity
2024-12-05 08:30:35 +01:00
bpaulien
d288d461dc Update bulk-editing.md (#537)
title case, edited for clarity.
2024-12-05 08:29:49 +01:00
bpaulien
5a43fb572f Update simplefin.md (#538)
title case
2024-12-05 08:29:00 +01:00
bpaulien
31d2d2cdfc Update modify-transfers.md (#539)
title case, spelling error
2024-12-05 08:28:36 +01:00
bpaulien
2e9a9db1b7 Update index.md (#540)
title case, spelling error
2024-12-05 08:27:59 +01:00
bpaulien
8cd3099ee4 Update backup.md (#542)
title case
2024-12-05 08:21:04 +01:00
bpaulien
10203bc98a Update restore.md (#543)
title case, punctuation
2024-12-05 08:20:37 +01:00
bpaulien
3a1671e479 Update returns-and-reimbursements.md (#525)
easier understanding, grammar fix
2024-12-03 08:42:40 +01:00
bpaulien
ce9f527f63 Update carrying-debt.md (#526)
broke up a run on sentence.
2024-12-03 08:41:18 +01:00
bpaulien
8b538c82d7 Update joint-accounts.md (#527)
further explain how to get the percentage of the 2nd person.
2024-12-03 08:40:26 +01:00
bpaulien
5256e12a32 Update restart.md (#528)
extra words to help explain which month
2024-12-03 08:40:01 +01:00
bpaulien
44790d927e Update index.md (#530)
grammar change
2024-12-03 08:39:37 +01:00
bpaulien
a622925fed Update schedules.md (#529)
several edits to improve readability
2024-12-03 08:39:08 +01:00
bpaulien
46e2c46476 Update filters.md (#531)
added words to improve understanding
2024-12-03 08:37:54 +01:00
bpaulien
5decb2ab3f Update transfers.md (#532)
make it a little more understandable
2024-12-03 08:37:03 +01:00
Matt Fiddaman
842bc40d0c fix some spelling issues, standardis(z)e to US English (#521)
Quick whip through to try and standardis(z)e some language, looks like
the most common English in the docs is US English so I chose that one,
but if we'd prefer the Queen's then that's okay too.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-11-29 06:45:45 +01:00
Matt Fiddaman
1faead2732 whitespace fixes (#522)
Removes double spacing and trailing whitespace.
2024-11-28 21:40:12 +01:00
bpaulien
bd2d1cce30 Update https.md (#514)
fixed wording
2024-11-27 19:01:17 +00:00
bpaulien
3eb57ba407 Update http-header-auth.md (#515)
easier to understand
2024-11-27 19:00:45 +00:00
Matt Fiddaman
80d1071019 Small fix to wording in Pikapods page (#520) 2024-11-27 20:00:04 +01:00
bpaulien
c9a8c9c0c0 Update nynab.md (#516)
changed wording,
2024-11-27 19:59:22 +01:00
bpaulien
207a0ab496 Update starting-fresh.md (#517)
reworded for comprehension
2024-11-27 19:58:44 +01:00
bpaulien
e755c6a260 Update index.md (#518)
reworded for clarity

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-11-27 19:57:01 +01:00
bpaulien
d65ccf4f49 Update index.md (#519)
edited for clarity, and to understand better.
2024-11-27 19:55:06 +01:00
bpaulien
628fca09f2 Update pikapods.md (#511)
added a couple missing words to help with readability

---------

Co-authored-by: Julian Dominguez-Schatz <julian.dominguezschatz@gmail.com>
2024-11-27 12:05:37 -05:00
bpaulien
fc27456e95 Update fly.md (#512)
improved readability
2024-11-26 22:17:27 -05:00
bpaulien
1eaf19e572 [WIP] Update index.md (#513)
fixed spelling and wording of statement
2024-11-26 22:16:18 -05:00
bpaulien
2f5246d535 Update payees.md (#510) 2024-11-26 22:12:29 +00:00
bpaulien
1ed0be4e7a Update roadmap-for-new-users.md (#509) 2024-11-26 22:12:12 +00:00
bpaulien
fe841ea6ff Update envelope-budgeting.md (#508) 2024-11-26 22:11:58 +00:00
bpaulien
cb024bbca7 Update schedules.md (#507) 2024-11-26 22:11:16 +00:00
bpaulien
3ed55fd08a Update accounts.md (#501)
edited for clarity, some grammatical errors

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-11-26 16:46:41 +00:00
bpaulien
ab71e1e33f Update reports.md (#503) 2024-11-26 16:39:23 +00:00
bpaulien
c94398b865 Update accounts.md (#502)
another grammatical error
2024-11-26 16:39:18 +00:00
bpaulien
4cde4dc5f5 Update budget.md (#500)
verbiage changes to enhance understanding.
2024-11-26 16:39:11 +00:00
bpaulien
903612c905 [WIP] Update writing-docs.md (#498)
Removed redundant word.
2024-11-26 14:51:32 +00:00
bpaulien
04988a1748 [WIP] Update index.md (#499)
made a sentence make sense.
2024-11-26 14:51:18 +00:00
Kayce Serafin
1d964978d6 [WIP] Update/docs (#494)
- Update image for months selector
- Remove extra semicolon
2024-11-25 16:25:43 -07:00
Michael Clark
b6647427f7 Update local.md (#492)
Based on
https://discord.com/channels/937901803608096828/1308579814625640508


![image](https://github.com/user-attachments/assets/ed7a7944-82d8-4709-88f5-7f9aac760ce9)
2024-11-21 09:15:59 +00:00
paul-louyot
7e645fcdbf [WIP] docs: fix typo (#488) 2024-11-19 09:25:52 -07:00
ankitson
5ddfb30817 docs: Explain running balance is shown only with descending date (#482)
I was a little confused that I couldn't see a running balance in my
accounts until I realized that it's only shown in a specific sort order.

I think it would actually be useful to be able to see the running
balance no matter the sorted order, but until then maybe we should
clarify in the documentation.
2024-11-18 13:59:50 -07:00
Julian Dominguez-Schatz
7afa8d9c23 Fix date on latest release post (#484)
As it says on the tin; noticed this was wrong while browsing the docs.
2024-11-04 20:11:08 -05:00
Reverse256
3e46012350 incorrect box specified from the photo (#478)
the arrows are the yellow box not blue.
2024-11-04 14:46:42 -07:00
youngcw
6ccee5bc33 update template docs to match changes (#477)
Matches limit additions in actualbudget/actual#3754.
Original PR with descriptions is actualbudget/actual#3714

Tweaks a few other things to retain accuracy.
2024-11-04 14:43:28 -07:00
Julian Dominguez-Schatz
f5bfa4db8a 🔖 (24.11.0) (#481)
- web: https://github.com/actualbudget/actual/pull/3766
- server: https://github.com/actualbudget/actual-server/pull/492
- docs: https://github.com/actualbudget/docs/pull/481
2024-11-03 09:43:52 -05:00
Ruben Olsen Lærk
634527b640 [WIP] Link to actual Budget hosted on Google Cloud's always free tier in the installation instructions. (#475) 2024-10-20 09:14:15 +02:00
Jonathan Fang
4044a14da2 Add info on how to access edge build via edge.actualbudget (#471)
add mention of how to access the edge build of actual, i couldn't find
it anywhere else in the documentation.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-10-17 23:55:43 +02:00
youngcw
0dd2c61fe5 add copy template (#467)
add blurb for the new copy template from actualbudget/actual#3617
2024-10-17 09:28:19 -07:00
Ruben Olsen Lærk
2b66cabfe0 Fixed broken (relative) link in /docs/config/https to correctly point to /docs/config/reverse-proxies 2024-10-14 19:23:51 +02:00
Adam Monsen
178d00ca06 [WIP] fix links to starting fresh guide (#472) 2024-10-13 17:43:54 +02:00
Matiss Janis Aboltins
22b607659e 🔖 (24.10.1) (#465)
- web: https://github.com/actualbudget/actual/pull/3596
- server: https://github.com/actualbudget/actual-server/pull/475
- docs: https://github.com/actualbudget/docs/pull/465
2024-10-08 18:02:21 +01:00
Christopher Kodama
a5324a2bd8 Update advanced settings in index.md (#464)
As of 24.10.0, simplefin is not in experimental features anymore, and
now there is a customizable reports option.
2024-10-06 19:12:01 -07:00
mullermn
3dba323bc0 [WIP] Update ynab4.md (#462)
Added in a Known issues section for YNAB4 imports to cover an issue with
split transactions not receiving correct payee details.

Once this issue is resolved the documentation note can be removed:
https://github.com/actualbudget/actual/issues/3561

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-10-06 20:42:22 +02:00
Robert Dyer
cfedb8f822 Update rules page (#463)
Some minor updates to the rules page to keep it in sync with the current
UI:

- Updates the list of actions and fields so the order matches the UI.
- Adds missing `category` field to the list
- Mentions you can also append/prepend to `notes`

See:
https://deploy-preview-463.www.actualbudget.org/docs/budgeting/rules/
2024-10-05 20:19:54 -07:00
Matiss Janis Aboltins
d27a135613 📝 update "how to cut a release" doc (#461) 2024-10-04 08:12:37 +01:00
Jonathan Fang
af19c9d239 Reorganizing documentation since SimpleFIN will be officially released #2 (#459)
- removed simplefin from experimental tab
- added mention of simplefin in bank-sync
- split bank-sync into gocardless and simplefin
- created dropdown for bank-sync
- proofreaded punctuation & image alignment in gocardless and simplefin
guides

Fixes https://github.com/actualbudget/docs/issues/452,
https://github.com/actualbudget/docs/pull/453 and fixes
https://github.com/actualbudget/docs/issues/454

I'm not sure why https://github.com/actualbudget/docs/issues/458 got
closed, so I'm making a new one here.

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-10-03 18:12:23 +01:00
Matiss Janis Aboltins
cfca359f68 🔖 (24.10.0) (#460)
- web: https://github.com/actualbudget/actual/pull/3545
- server: https://github.com/actualbudget/actual-server/pull/472
- docs: https://github.com/actualbudget/docs/pull/460

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
Co-authored-by: Julian Dominguez-Schatz <julian.dominguezschatz@gmail.com>
2024-10-03 18:06:57 +01:00
Muhammad Talal Anwar
9933d02139 docs: fix more typos (#456) 2024-09-26 09:14:22 +01:00
Jonathan Fang
4a8425c40b Update community-repos.md to remove simplefin community in favor of official simplefin integration (#457)
remove simplefin community tool because simplefin has been integrated
officially
2024-09-25 22:03:09 +01:00
Muhammad Talal Anwar
826c1095e6 [WIP] docs: fix typos (#455) 2024-09-22 20:19:30 +02:00
Ruben Olsen Lærk
b7f7f49ca9 Added Link to UnRAID SSL setup in /docs/install/index.md (#451) 2024-09-21 13:58:08 +02:00
Ruben Olsen Lærk
0b8f267f9b Reorganising the menu items (#429)
1. Moved _Filtering_ from _Reports & Filters_ to _Accounts &
Transactions_ as it's are more natural place to have the filter
documentation.
2. Renamed _Reports & Filters_ to just _Reports_
3. Moved _Schedules_ out of _Budgeting_ to better reflect the sidebar
items in the program.
4. Based on feedback from Michael Burnside on Discord, moved the
envelope budgeting docs higher up in the menu. What he wrote on Discord:
_I think the Envelope Budgeting doc should be moved up in the list. It's
important to understand the method and the "Why" first, so that users
can make sense of the tool and the "how". I know there's a link at the
top of the Starting Fresh article, but people tend to go top to bottom
in the contents (if they're reading at all)._
5. Moved _A Tour of Actual_ out of _Getting started_ as it's marketing
and not getting started with the program.
6. Moved _Starting Fresh_ higher up to differentiate between the tech
stuff and the why stuff.

**There is no change in content - just trying to make the menu a better
place to navigate**

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-09-15 13:50:28 +02:00
Ruben Olsen Lærk
1c1531ec12 Joint account streategy changes (#442) 2024-09-14 22:38:11 +02:00
Michael Clark
9c30602230 Update notes on self signed certificates for desktop app (#450)
Notes on mkcert when used with desktop app. 

Should resolve future questions like this one:
https://discord.com/channels/937901803608096828/1281484103580909621/1284432537682317365

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-09-14 15:08:28 +02:00
Dev Prakash Sharma
84ecc7751e [WIP] Updated the local installation file (#388)
This PR brings the following changes in the
https://actualbudget.org/docs/install/local page.

<img width="1135" alt="image"
src="https://github.com/actualbudget/docs/assets/44609609/0ec1833f-360f-474e-9f0a-337c7d003894">

- Updated the content structure of the entire page.
- Removed unnecessary information and content
- Removed superficial information.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
Co-authored-by: Robert Dyer <rdyer@unl.edu>
2024-09-14 07:40:02 +02:00
Neil
7e8dfcb691 Add web app install docs (#405)
Adding a section to install documentation that explains how one could
use the web app for a quick start without sync.
2024-09-14 06:56:55 +02:00
wdpk
f13cc304ed basics of text style guide for consistent tone when writing. (#398)
add some basic guidelines about how to write the docs so a shared voice is heard when using the documentation.

---------

Co-authored-by: Zeus\Herb <herb@win.dows>
Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-09-13 08:36:16 +01:00
Odd Stråbø
bf0a6bad5c Remove compose down from update instructions (#443)
docker compose down is not needed, and running it before pulling updated
images causes longer service downtime than required.

Simply running `docker compose up -d` after `docker compose pull` will
recreate all containers that changed (by either image version or other
settings in the compose file).
2024-09-13 06:14:52 +02:00
Jonathan Fang
99d0b57e0e Added info on how Pikapods updates (#446)
Added information on how Pikapods updates for each monthly release,
including how this works with desktop clients.
2024-09-07 20:00:33 +01:00
Mike Bishop
36ecb67bd3 [WIP] Spelling of "Synology" (#448) 2024-09-04 07:23:19 -07:00
Michael Clark
a99f9c2e7a Point windows app download to Windows Store (#445)
Updates the Windows app download link to point to the Store
2024-09-03 19:16:32 +01:00
Matiss Janis Aboltins
107f3fa105 🔖 (24.9.0) (#444)
- web: https://github.com/actualbudget/actual/pull/3348
- server: https://github.com/actualbudget/actual-server/pull/444
- docs: https://github.com/actualbudget/docs/pull/444

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-09-03 18:04:11 +01:00
wdpk
bfe5414ec0 Update docs to be time-neutral by removing outdated references, update related screenshots to where these issues occured (#396) 2024-08-26 23:36:16 +01:00
Robert Dyer
554882d0a8 Add note about new #community-projects Discord channel. (#441)
And fixes a typo.
2024-08-25 14:40:41 +01:00
João Melo
f2ca574d7e Add actualbudget home assistant integration link (#439) 2024-08-24 13:25:01 +01:00
Robert Dyer
81b7305f5f Add FAQ entry on how to add GoCardless bank to limited history list. (#435)
Provides steps to contribute to the GoCardless list of banks with
limited (90 day) historical data.
2024-08-20 12:36:53 -07:00
Tobias Diez
7e2439f781 [WIP] Clarify post-processing in add/importTransactions (#438)
Clarify that `importTransactions` runs rules
2024-08-18 16:14:02 -04:00
Michael Clark
96f480ef3c Adding instructions for the windows store release (#436)
![image](https://github.com/user-attachments/assets/c3c561d7-b0ee-4ea6-81ee-d19d664099ca)
2024-08-17 13:27:09 +01:00
Julian Wachholz
583dd24423 Remove namespace from i18n example (#434)
Actual Budget does not use namespaces in the translations.
Also adds additional section about handling interpolation using the
<Trans> component.
2024-08-16 16:44:04 +01:00
Julian Wachholz
6772a1c7d1 Add i18n documentation (#431)
Initial draft for contribution guidelines on how to prepare Actual for
i18n and l10n.

Please do add your feedback!
2024-08-15 09:54:33 -07:00
wdpk
49e25effc0 update rules page w/ link to regex tutorial (#422)
many people may not know what 'regex' is. now matches filters page. not
sure why i didn't update both places when i got the review last time,
sorry!

---------

Co-authored-by: Robert Dyer <rdyer@unl.edu>
2024-08-14 19:51:20 +01:00
Robert Dyer
7f8f6ee11b Make note/link about SimpleFIN in the bank docs page. (#432)
This adds a note on the Advanced/Bank Sync page linking to the SimpleFIN
page:

<img width="642" alt="image"
src="https://github.com/user-attachments/assets/82acba25-acdb-42f9-b503-1d8ee61b123c">
2024-08-14 07:12:45 -07:00
Michael Clark
22d9054d8a Update Mac links on Downloads page (#430)
![image](https://github.com/user-attachments/assets/85059ade-8d5f-433c-9fb0-d2455743da4b)

**Possible improvement for later:** we could detect the OS the user is
using and filter the list down so there aren't so many options.
2024-08-13 14:43:23 +01:00
Matiss Janis Aboltins
64a254b12d 📝 highlight that Actual does not have a HTTP API (#428) 2024-08-11 20:54:28 +01:00
Oleg Andreych
d8ebce866f [WIP] Fix typo in the budget.md (#427)
Changed text accordingly to menu item's title.
2024-08-11 12:51:19 -07:00
Ruben Olsen Lærk
7d0cc155b1 [WIP] GoCardless clarification on number of requests on the free tier + alt-text of images + fix a step number (#426)
1. Added information about the number of syncs on the free tier (which
is 50).
2. Added link to documentation on how GoCardless counts connections.
3. Added alt-text to all images.
4. Fixed a typo in one of the numeration of the steps in how to link a
GoCardless account to AB - step 8 was repeated twice.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-08-10 07:50:30 -07:00
Robert Dyer
baba070baf Update report budget docs (#425)
First, the way to enable it has changed so that is updated.

Second, the UI now calls it "tracking" and "envelope" budgeting, so the
text and filenames were updated to reflect the new "tracking" name.
2024-08-08 20:27:23 +01:00
Hunter Haufler
dc492dba35 Add Credit Card Documentation (#419)
Add documentation on how to fix carrying over debt from credit cards
when importing from nYNAB.
2024-08-08 09:13:40 -07:00
Ruben Olsen Lærk
ccf3dd7781 Converts Norwegian Trumf Visa PDF invoice to an AB friendly CSV file (#423)
Added link to converter from Trumf Visa PDF invoice to Actual Budget
friendly CSV import file.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2024-08-06 18:53:33 +01:00
rodriguestiago0
2f272b9733 Add documentation for holdBudgetForNextMonth and resetBudgetHold (#420)
Docs for [PR](https://github.com/actualbudget/actual/pull/3140)
2024-08-06 18:53:06 +01:00
Jonathan Fang
c1fedf07b6 Update fly.io pricing information (#424)
Fly.io no longer offers free cloud hosting; it is pay as you go with
actual usage billed monthly. I calculated between Pikapods $1.4 per
month and Fly.io's $1.5 per month and chose Pikapods since it's one
click and it's cheaper. If there's anything wrong in my calculations,
please let me know.
2024-08-06 18:49:50 +01:00
Avi-Lance
af2197cfe1 Added Cost Optimization Section for Fly Install Instructions (#418)
Added Cost Optimization Section talking about enabling the auto start
and auto stop instance options in fly.toml
2024-08-06 18:49:24 +01:00
Matiss Janis Aboltins
c4d5c4e090 🔖 (24.8.0) (#421)
- web: https://github.com/actualbudget/actual/pull/3179
- server: https://github.com/actualbudget/actual-server/pull/408
- docs: https://github.com/actualbudget/docs/pull/421
2024-08-03 14:30:47 +01:00
bobokun
4ef9dc11e3 Move ActualTap to ActualTap-py (#413)
The current Actual Tap repo is now archived and developement has been
moved to a new repo
2024-07-29 22:03:34 +01:00
Jonathan Fang
70854329c2 Update reports.md to fix typo (#411)
typo from "two built in report" to "two built in reports"
2024-07-29 22:01:34 +01:00
Jonathan Fang
a214ad84f5 Update custom-reports.md for typo (#412)
correcting typo from "reports available" to "reports are available"
2024-07-29 22:01:10 +01:00
Matiss Janis Aboltins
48c9efb354 📝 update the API docs information (#414)
Removing some outdated information. The API package has been available
for a while already.
2024-07-26 21:08:49 +01:00
youngcw
3e481d2850 add section for goal template directive (#401)
This adds the description about how a `goal` template line works with
some examples.
Also some minor tweaks to the page

matches actualbudget/actual#3012
2024-07-26 10:21:20 -06:00
Matiss Janis Aboltins
30a47b48df 📝 update core contributor list (#410) 2024-07-21 18:38:31 +01:00
Ruben Olsen Lærk
4356a23f9c Revamp of A tour of actual (#402)
The current Tour was lacking for people curious about what Actual looks
like, without going into "full teaching manual mode".

What I have done:

- Consistent screenshots
- Added some explanatory text and links to the actual manual pages

I am fully aware that there is a fine line between some of these pages
and manual pages.

Anyway - we should now have something to show the YNABers and MINTers of
the world :-)

Ideally, we should have a video introduction as the "tour" - but given
how much change we have in the program, this would kill the poor guy/gal
who wants to maintain such a video.

PS: I go on vacation on Saturday July 13th - so any changes I am not
able to do after that time.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-12 13:42:02 -07:00
rodriguestiago0
0646689266 [WIP] Add actual budget backup to community projects (#407) 2024-07-12 08:13:34 -07:00
Robert Dyer
ba2f767f83 Add getAccountBalance() API documentation (#403)
Docs for https://github.com/actualbudget/actual/pull/2930.
2024-07-12 08:12:37 -07:00
Matt Fiddaman
c5c5d55782 Add mergePayees to the API reference (#404) 2024-07-12 08:04:09 -07:00
Robert Dyer
aef82dee24 Add API docs for getLocalbudgets() and getRemoteBudgets(). (#377)
API docs for https://github.com/actualbudget/actual/pull/2928.
2024-07-11 13:18:51 -07:00
Ruben Olsen Lærk
3c2a7e8bf6 Added various links to the Community Projects page (#406)
- Added links to the My Edenred Portal bank sync and Actual Task repos.
- Moved some links from Others into Various utilities to enhance
Actual's functionality, as I expect we will get more and more of these
utilities available. Let's keep Other for pure non-functional technical
stuff

Original posting:
https://discord.com/channels/937901803608096828/1027831756545609789/1260289369139580988

I did source GitHub for other interesting projects and have added those
also.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-11 13:16:03 -07:00
youngcw
1211b086d7 Add a download page to the website (#359)
This is a super rough start for a download page for the website. Please
make contributions since this is pretty bad so far. Can you tell Im not
a front end dev? 😆

In order for the links to always work we either need to:
* Modify our electron build to not add versions to the filename
* Add some way for the page to know the current version and use that in
the requested filename

For now they are hard coded with the version so they wont work next
month unless something changes.

For now the OS logos are colored so that they can be seen in both light
and dark modes. Im sure there is a better way than making them purple.
2024-07-09 11:47:51 -07:00
Ruben Olsen Lærk
0fca01f59e Activating HTTPs - header levels was wrong - no content has been changed. (#400) 2024-07-09 19:45:51 +01:00
Ruben Olsen Lærk
2ba87486a6 Roadmaps for new users (#395)
I have added a _Roadmaps for new users_ to help people decide on their
next step. The roadmaps are primarily aimed at non-technical people.

I saw the reason for doing this after getting a few questions for
non-techies people I know about "ehhh... where do I start?" ... "I did
install the desktop software, how to get this into my cell phone", etc.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-09 11:36:13 -07:00
Ruben Olsen Lærk
0026a02f76 Extended the PikaPods documentation for non-technical users (#393)
I have extended the PikaPods documentation to cater to non-technical
users. This should be quite straight forward.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-08 08:33:08 -07:00
wdpk
67b4001e9c Readme cleanup, update to release notes, ʻlight modeʻ screenshots (#397)
update the readme to have more of a present date, clean up various small
grammar and formatting throughout the page.

clarify that the docs donʻt have release notes written in the same way
as the rest of the project. include information about what makes it to
the git commit messages to encourage people to write good PRs.

add note that screenshots should be taken in light mode

Notes and edits welcome.

---------

Co-authored-by: Zeus\Herb <herb@win.dows>
2024-07-08 07:39:40 -07:00
wdpk
9d59672a60 Explain condition types on Rules and Filtering pages (#390)
Add information about "matches" being regex.

~~PR 9/10ths of the way there, still need to update screenshots. Is
there a style policy regarding dark/light mode screenshots? It seems
like currently it swaps between the two.~~

---------

Co-authored-by: Zeus\Herb <herb@win.dows>
2024-07-08 07:09:41 -07:00
Brunno Vanelli
4c76cb2bbf Add reference to the Python library (#392) 2024-07-07 20:34:04 +01:00
youngcw
9ced05fca9 fix links in the ynab blog (#391)
since the link paths are treated differently depending on if the blog is
directly linked to vs navigated to. I believe these links will always
work
2024-07-06 17:30:24 -07:00
Ruben Olsen Lærk
d54bdffc6b A go at Starting fresh (#389)
We now have quite a few changes - not only moving the *generic envelope
budget* stuff out.

In short:
* Added section on handling cash. The idea behind this is to give people
that are new to this kind of budgeting, an easy idea on what to do with
cash. Even seasoned Zero-Summers can forget about this simple trick :-)
* Amended Setting up your Budget Categories with a small tip.
* Added sub section Group Your Expense Categories. I have guided a lot
of people on using Zero-Sum software (Ynab, Financier - and now Actual)
- and the grouping I propose have shown to help people to not touch
category money they should not touch.
* Assigning Available Funds is a complete rewrite - this is "Tips" we
removed from the envelope-budget.md file - I will add a link back into
the getting-started document when both PRs has been done.
* Added a section on finding your budget number if you do not want, or
can use historical data
* Keep Budgeting was amended 
* Added a header before text on next step.

OBSERVATIONS: I think this document is too big - and it should be split
into it's 5 parts (+ introduction).

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-05 13:39:39 -07:00
Ruben Olsen Lærk
a6f3bcafe4 Created page on the topic - How envelope budgeting works (#386)
I have added this page because I think the software used for envelope
budgeting should definitively have some documentation on how to actually
do envelope budgeting.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-05 11:10:29 -07:00
wdpk
5424d6b402 Create section on restarting your budget without removing transactions (#383)
Fixes #362 

Taken from Teprifer#muddledjellyfish's answer on Discord server.

---------

Co-authored-by: Zeus\Herb <herb@win.dows>
2024-07-05 10:55:08 -07:00
wdpk
69fe8f61d5 Add Command to update Fly instance via hippalectryon-0 (#385)
add command about exactly how to redeploy the latest image under update.
thanks @hippalectryon-0

fixes #384
2024-07-04 09:05:35 -07:00
wdpk
f677ee64d4 update bank sync faq question - add best practices (#382)
from the docs on bank sync specifically, include best practices notes in
the FAQ to recommend limiting past transactions
Fixes #363

---------

Co-authored-by: Zeus\Herb <herb@win.dows>
2024-07-04 09:03:47 -07:00
Matiss Janis Aboltins
17148c7c70 🔖 (24.7.0) custom reports, splits in rules, tags and more (#379)
- web: https://github.com/actualbudget/actual/pull/2955
- server: https://github.com/actualbudget/actual-server/pull/383
- docs: https://github.com/actualbudget/docs/pull/379
2024-07-02 21:28:41 +01:00
Robert Dyer
98ea289509 Update SimpleFIN reset instructions. (#381)
Since https://github.com/actualbudget/actual/pull/2870 is being
released, the docs should update to the new way to reset the token.
2024-07-02 12:25:31 -07:00
youngcw
5748e279f1 Actual vs YNAB blog post (#378)
Feel free to comment. I imagine we will be getting increased interest
over the next few days.
2024-07-01 17:37:55 -07:00
youngcw
552126589f custom reports no longer experimental (#375)
Update the custom reports page and move it out of experimental. Misc
other tweaks to be consistent about reports.
2024-07-01 13:02:49 -07:00
youngcw
c5b39ab0a3 Clean up the homepage feature list (#376)
some of the features on the homepage seemed there just to pad out the
list. The list if decently long and interesting so I removed Payees and
Split transactions. Those seem pretty expected and not that interesting
as a called out feature.

I modified the budgeting feature to be more specific. Just saying we
have budgeting is a bit redundant for a budgeting app.
2024-07-01 12:52:51 -07:00
Robert Dyer
600d130d14 Add missing API documentation. (#373)
This adds missing documentation for existing API calls and removes one
that does not exist.

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2024-07-01 19:50:36 +01:00
wdpk
0b719e0ca1 fly.io new pricing details update (#374)
fly.io pricing details have changed for new users. new users can only
sign up for a pay-as-you-go plan where usage is billed monthly. as this
is about deploying actual, it should be aimed at new users, not
returning users with maybe-existing legacy plans(like the hobby plan)
details about the legacy plans can still be found at the linked page.
2024-07-01 19:50:08 +01:00
Justin
b47fe50bef Update settings.md (#370)
Updated experimental features to match what's listed in app.

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: Robert Dyer <rdyer@unl.edu>
2024-06-28 12:04:02 -07:00
Matiss Janis Aboltins
56abc1c3f3 📝 update core contributor list (#372) 2024-06-23 07:06:19 +01:00
Matthew Lehner
4915990761 Remove web terminal section from Fly.io docs (#364)
The web terminal is no longer available on Fly.io and has caused a bit
of confusion for folks who are trying to get Actual deployed.
2024-06-21 11:41:49 -07:00
Robert Dyer
700cf4798c Add link for helpers (#371)
Adds a link to my helper script repository
2024-06-19 18:09:17 -07:00
Szymon Sakowicz
761f50ed00 Add Actual AI to Community Projects (#369) 2024-06-11 16:27:26 -07:00
Matiss Janis Aboltins
dfbcfc25db 📝 update release instructions (#368) 2024-06-07 21:43:41 +01:00
Matt Farrell
2dbb27fc1b Update community-repos.md (#365)
Project was refactored and moved to a new repo.
2024-06-06 14:33:38 -07:00
Matiss Janis Aboltins
fbdd357de4 📝 update core contributor list (#361) 2024-06-03 19:28:47 +01:00
youngcw
b0cf66a121 add install info on desktop apps (#354)
Co-authored-by: Robert Dyer <rdyer@unl.edu>
2024-06-03 09:45:02 -07:00
Joseph Livecchi
3311ea58fd Added documention about the header authentication (#341)
Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: Robert Dyer <rdyer@unl.edu>
2024-06-03 07:06:37 -07:00
Matiss Janis Aboltins
194d19ef58 🔖 (24.6.0) (#360)
- web: https://github.com/actualbudget/actual/pull/2819
- server: https://github.com/actualbudget/actual-server/pull/368
- docs: https://github.com/actualbudget/docs/pull/360

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
2024-06-03 10:50:00 +01:00
Robert Dyer
d90aeffb91 Add reset password doc to the sidebar (#358)
<img width="286" alt="image"
src="https://github.com/actualbudget/docs/assets/1115390/5b558700-4589-4ebd-a809-17bf0355cb0c">
2024-05-25 10:50:19 -07:00
Robert Dyer
7eb0544957 docs: Add instructions to reset SimpleFIN token. (#357)
This adds simple instructions to manually reset the SimpleFIN setup
token.
2024-05-22 11:38:57 -07:00
Robert Dyer
cece84e9bc API: add docs for the rules API (#356)
This adds documentation for the new rules API
(https://github.com/actualbudget/actual/pull/2568).
2024-05-20 14:13:50 -07:00
Dev Prakash Sharma
4c94d063da Home page documentation enhancement (#355)
This updates the home page documentation with some content enhancement
as per the style guide (mainly MSTP, Google Developer Style Guide).

Based on the feedback, i will further add more section to enhance the
home page to make it like a home for all the documentation for easier
navigation.

For now, this PR kepts the section that are necessary to address user's
query regarding getting started with Actual and understanding the
Actual's starter kit.

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
2024-05-20 13:11:43 -07:00
Matiss Janis Aboltins
7360e35ace (api) ability to run bank sync via the API (#350) 2024-05-16 08:38:47 +01:00
youngcw
5fe40200f1 add info about PRs to Contributing page (#353) 2024-05-07 10:18:34 -07:00
Matiss Janis Aboltins
a562dcd916 🔖 (24.5.0) mobile improvements and much more (#352)
- web: https://github.com/actualbudget/actual/pull/2693
- server: https://github.com/actualbudget/actual-server/pull/351
- docs: https://github.com/actualbudget/docs/pull/352
2024-05-03 17:32:44 +01:00
youngcw
3c3c3ab463 add line for average template (#351)
matches actualbudget/actual#2688
2024-04-30 12:19:59 -07:00
Matiss Janis Aboltins
1f2f103fc6 📝 updating main contributor list (#349) 2024-04-29 21:31:01 +01:00
Huyen Nguyen
a698a2db83 fix: Open Collective link (#348)
Changes the Open Collective URL from `.org` to `.com` (the `.org` is not
accessible).
2024-04-14 17:19:31 +01:00
Matt Farrell
c746cf1cf1 Update community-repos.md with Actual Tap (#346)
[Shared](https://discord.com/channels/937901803608096828/940290142579605514/1227116311935582260)
the app I developed in Discord and was
[advised](https://discord.com/channels/937901803608096828/940290142579605514/1227331697700376586)
to add to the Community Repos page.
2024-04-10 07:38:49 -05:00
shall0pass
2032503220 Cleanup documentation for local groups (#337)
I think there is a better example than the one I've proposed here. I'm
not convinced the example I've given would even provide an expected
result to the user. I'd appreciate any feedback of those interested and
the PR #2480 could be improved to deliver more expected results.
2024-04-09 17:22:20 -05:00
joklek
8674c5145c Remove double dot in tour (#344)
Fixing a double dot in the tour
2024-04-08 10:21:45 -07:00
David Baker
f80476cef6 Fix a typo on the new YNAB page (#343) 2024-04-04 14:10:14 -05:00
Matiss Janis Aboltins
d26ccb9fe5 🔖 (24.4.0) custom reports improvements, stability enhancements (#342) 2024-04-02 07:11:09 +01:00
Matiss Janis Aboltins
90c454450f 🔥 remove non-existing api methods from api docs (#340)
Removed api methods that do not exist. Since they don't exist - they
should not be in the docs.

It would be nice to implement them though.. but until they are
implemented - lets not mislead people.
2024-03-30 19:54:09 +00:00
samoorai
de78221ec3 Update the FAQ to reflect the new mobile layout feature (#339)
As the title says, update the response of the FAQ indicating the mobile
web layout
2024-03-26 18:25:39 +00:00
shall0pass
85f58ebcb4 Blog Post: Templates with a twist for weekly targets (#338) 2024-03-25 19:34:28 -05:00
DJ Mountney
b724708411 Add docs on ability to create transfer from two existing transactions (#321)
Docs for PR https://github.com/actualbudget/actual/pull/2398+

as part of the feature
https://github.com/actualbudget/actual/issues/1891+
2024-03-23 10:36:39 -07:00
qmph22
88e1c714d4 Update local.md (#336)
For closing out issue #334 
Updated required Node.js version

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2024-03-23 09:35:58 +00:00
David Shen
0bfb097bef Clarify that goal schedule template should not include braces (#333)
My schedule templates weren't working because I was including the curly
braces around the schedule name.
2024-03-22 07:48:18 -05:00
qmph22
dd788aceae Update https.md (#335)
Reformatted the page, reworded some paragraphs, and added more
information about Docker for clarity.

After having to go through these steps myself, I found it might be
helpful to merge some of my suggested changes for others to view.
2024-03-22 07:48:39 +00:00
Emmanuel Vuigner
fef1bee1c0 Update reverse-proxies.md (#332)
Remove double `restart` line on the caddy config
2024-03-14 13:35:42 -07:00
youngcw
d5a7d63808 add financier migration repo (#328)
Links to this custom importer in the community page
2024-03-11 14:11:34 -07:00
Conor Anderson
4e1e608a1e Update categories.md (#329)
Minor edits / proofing
2024-03-09 09:10:10 -07:00
qmph22
73ce8f511b Update index.md - "Using the API" (#331)
Added clarity about migrating from YNAB or Mint to Actual. 

Corrected grammatical error about what Actual officially supports for
importing from other budgeting apps.
2024-03-09 09:09:12 -07:00
tim
720bb85801 Capitalize "actual" on line 7 (#330)
Incredibly minor change. I'm assuming this aligns to the brand template
as I saw "Actual" (capitalized) elsewhere.
2024-03-06 20:26:13 -06:00
shall0pass
f82709cf4d Rollover notes: Update for PR 2409 (#326)
[#2409](https://github.com/actualbudget/actual/pull/2409)
2024-03-04 14:45:36 -06:00
Paul Gauntlett
30dca60c58 Update bank-sync.md (#324)
Explain advantages of setting an opening balance when starting from
scratch with Actual and Go Cardless

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
2024-03-04 12:58:47 -07:00
Matiss Janis Aboltins
2565f5d59d 🔖 (24.3.0) (#327)
- web: https://github.com/actualbudget/actual/pull/2413
- server: https://github.com/actualbudget/actual-server/pull/317
- docs: https://github.com/actualbudget/docs/pull/327
2024-03-03 17:10:23 +00:00
Paul Gauntlett
9e5f9c2930 Update goal-templates.md (#325)
This updates:
1) Dated examples to reference 2024 and 2025 (rather than 2021 and 2022)
2) Adds a warning to reproduce schedule names exactly in templates
2024-02-29 18:39:48 -06:00
Blake Bryant
49ed1ba895 Add final step to enabling https on home server (#322)
Sounds like I'm not the only one that has run into this issue 😄

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2024-02-28 08:20:28 +00:00
shall0pass
eb0c5418c8 Add text to reconciliation section about lock icon (#319) 2024-02-27 10:49:29 -07:00
shall0pass
90e3ffe539 Remove full sync migration documentation (#320)
This PR removes the migration page from Full Sync to Simple Sync.

This page was needed 16 months ago when a breaking change was merged to
resolve issues with the sync algorithm. Given that there have been over
16 releases since this change, most users will never encounter this
issue.
2024-02-27 10:49:11 -07:00
xentara1
6f42b9f6e3 Adding Create Schedule From Transaction (#303)
As discussed..
https://github.com/actualbudget/actual/pull/2222

---------

Co-authored-by: xentara1 <xentara1@xentara1.com>
Co-authored-by: alex Foreman <>
2024-02-27 10:45:43 -07:00
Redbox3070
e56103d456 Create page for custom reports (#316)
Custom reports documentation, pictures are still missing.

---------

Co-authored-by: Teprifer <34882928+Teprifer@users.noreply.github.com>
2024-02-21 12:31:49 -07:00
Matiss Janis Aboltins
6878ca5365 📝 feature flags policy (#317) 2024-02-21 18:17:03 +00:00
youngcw
f7d818529d add info on how to sync simplefin (#318)
The info on syncing with simplefin was really small in the docs, so I
fleshed it out more and added a picture.
2024-02-20 14:27:07 -07:00
youngcw
5d87628728 update starting fresh doc, and add simpleFIN call outs (#305)
mostly some more detailed advice in the starting fresh doc. Im trying to
make the budgeting advice be more centralized instead of being in random
places

A few minor tweaks

A few call outs that simplefin is not just a community thing anymore
2024-02-12 13:14:34 -07:00
Lars Stegman
5eab5cf9d1 Goal templates: Edit note that currency symbols other than $ are supported (#315)
The regex for the parser is implemented to match any currency symbol:


5a67b7e822/packages/loot-core/src/server/budget/goal-template.pegjs
2024-02-12 13:14:19 -07:00
Khalu
d73265cdc7 match nginx with other formatting, add httpd (#314)
Moves the summary of NGINX section to the top to match the others. 
Added config section for Apache HTTPD.

Co-authored-by: keith <keith@swagler.casa>
2024-02-12 10:22:42 -07:00
Eric Karr
67f76080a9 Added VM specification to fly.toml to keep within Fly.io free allowances (#306) 2024-02-08 08:26:35 +00:00
Tillman Jex
9bacf7f2d7 cautionary notice about new Fly pricing (#311) 2024-02-08 08:18:52 +00:00
Charlie Arnold
fb064f7ad3 Fix typo in reset_password.md (#313)
title
2024-02-08 08:17:54 +00:00
Dan D
7968c18bcb Add Experimental SimpleFIN Sync to Docs (#312)
Added a new page in the docs under "Experimental", for SimpleFIN Sync. 

I used the existing GoCardless page as a starting point.
2024-02-06 18:14:48 -07:00
shall0pass
f885174a74 Documentation updates for PR #2295 (#307) 2024-02-05 20:40:45 -07:00
John Hollowell
e997f1dc94 Update importing.md (#310)
fix small typo
2024-02-05 09:10:04 -07:00
Matiss Janis Aboltins
483da232d2 🐛 update wording: s/cleared/reconciled/ (#309) 2024-02-02 20:52:03 +00:00
Matiss Janis Aboltins
f3d2a6a90b 🔖 (24.2.0) cleared transaction improvements; experimental simplefin bank-sync (#308)
- client: https://github.com/actualbudget/actual/pull/2311
- server: https://github.com/actualbudget/actual-server/pull/306
- docs: https://github.com/actualbudget/docs/pull/308
2024-02-02 19:23:18 +00:00
youngcw
fd8d0cf4f3 add moneymoney importer (#304)
add link to this importer
2024-01-15 12:25:03 -07:00
Matiss Janis Aboltins
1a2d1c175e 📝 created privacy policy (#302)
Necessary for submitting to Mac App Store.
2024-01-14 16:07:22 +00:00
Jorim Tielemans
b210f45e21 Update bank-sync.md (#300)
Location in menu changed, also updated the screenshots.
2024-01-06 16:33:40 +00:00
Torben
8bd12d2456 📝 (reverse proxies) Remove duplicate line, add service port for Traefik (#297)
While deploying with Traefik I found two small errors in the
documentation.
First is the duplicate line, the second is the missing line so that
Traefik knows on which port it should send the traffic to.
2024-01-06 16:32:48 +00:00
Matiss Janis Aboltins
34c268c861 🔖 (24.1.0) Mobile split transactions (#299)
- web: https://github.com/actualbudget/actual/pull/2177
- server: https://github.com/actualbudget/actual-server/pull/295
- docs: https://github.com/actualbudget/docs/pull/299
2024-01-06 09:56:57 +00:00
Paul Gauntlett
3ef647b240 Update Contributor Section - Side Bar Order (#298) 2024-01-05 22:01:54 +00:00
Matiss Janis Aboltins
8c47ea940a 📝 update core contributors list (#295) 2023-12-30 14:55:30 +00:00
youngcw
b01586ac1d fix links on starting fresh page and blog post (#294)
I think this fixes an issue where the links on the page don't work if
you get to the page via discord link.

The root issue is the same as
https://github.com/facebook/docusaurus/issues/2298

We may need to go through and update the links in the website, or maybe
someone can take the time to migrate the website to docusaurus v3.
2023-12-17 14:52:46 -07:00
Shaan Khosla
0566e9c308 Add Caddy Reverse Proxy Instructions (#292) 2023-12-17 10:54:12 -05:00
youngcw
f4df1400cc add blog post about using goal templates (#291)
We have a blog, so I wrote a post for it.

Its about how I use the goal templates in the hopes that it will inspire
some people on how they can use goals and some budgeting strategy baked
in.

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
2023-12-15 13:02:40 -07:00
youngcw
fe8df6c57c Add example rule for using imported payee contains (#293)
The question of not having contains under payee in rules gets asked a
lot. I added an example for it.

I also changed the name of that page to "Rules Examples" to be more
clear on what it is.
2023-12-15 12:01:30 -07:00
youngcw
5c1e1b7fd1 dark mode inclusion and dynamic homepage images (#290)
Added a dark mode callout in the feature list.

Working on dynamically switching between dark and light screenshots when
the page switches themes.

I pulled images from the VRT tests to use for dark images. They are
pretty close to the existing images, but from a slightly larger screen.
2023-12-12 13:38:02 -07:00
DJ Mountney
1cb7459803 Add info on self-signed https connections from the API (#288)
Related to https://github.com/actualbudget/actual/issues/1695

It's pretty common for users to have self-signed certificates for
actual, but this presents some challenges for the API.

Give a little bit of guidance here, for new contributors. Really, all
the info here is just for Node.js and not for actual. (we would want to
create seperate http agents and our own certificate config system if we
wanted to have actual specific config for this).

For many of the existing api use-cases the
`NODE_TLS_REJECT_UNAUTHORIZED` option will be fine. But
`NODE_EXTRA_CA_CERTS` seems like the proper way to do things (and the
one I tested on nodejs 21, on ubuntu via asdf install). But I also made
sure to mention the option of using openssl's ca certificates, because
if you are in a situation where your node.js is configured to link to
the system openssl on Linux, it's going to be the easiest and most
familiar to Linux sysadmins. It's just not the cross-platform supported
option like `NODE_EXTRA_CA_CERTS`.
2023-12-12 12:04:44 -07:00
youngcw
d5c9624242 add blurb for transfer rules (#286)
This gets asked a lot in discord.  Now we can point people somewhere.
2023-12-07 12:28:57 -07:00
youngcw
97703077ef add stop command to docker-compose update steps (#285) 2023-12-07 12:28:13 -07:00
youngcw
287d88fc41 blurb about transfer categories (#283)
We get lots of questions about transfers involving off budget accounts.
This will hopefully alleviate some of that confusion.

It was mentioned in
[actualbudget/#1979](https://github.com/actualbudget/actual/issues/1979)
that the docs don't have a good description of this.
2023-12-07 12:25:56 -07:00
youngcw
70b653fc24 add info about aligning to_budget on nynab import (#282)
When importing from nYNAB `to budget` doesn't match the previous `ready
to assign` value. I added a description of why that is and how to make
the numbers match.
2023-12-07 12:23:56 -07:00
Matiss Janis Aboltins
fa226311a9 🔖 (23.12.1) fix '.migrate' file causing Synology NAS problems (#289)
- server: https://github.com/actualbudget/actual-server/pull/290
- docs: https://github.com/actualbudget/docs/pull/289

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
2023-12-07 19:18:08 +00:00
Peter
941838c045 add reverse proxy config documentation (#267)
Hey, since I've been using Actual via Traefik for a few days now, I took
the time to add a little bit to the documentation in that regard. I hope
it fits so far. Please feel free to comment/improve anything.
2023-12-03 13:31:18 -07:00
youngcw
36969de9e3 guide for starting fresh (#279)
Depends on #278.
Fixes #251

This adds a dedicated guide for those that are starting fresh with
Actual and aren't familiar with zero-sum budgeting. It is a step by step
that points to the existing pertinent docs pages with additional
direction.

---------

Co-authored-by: shall0pass <20625555+shall0pass@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2023-12-03 13:29:13 -07:00
Matiss Janis Aboltins
64c455a897 🔖 (23.12.0) darkmode, transaction locking, mobile updates and more (#284)
- web: https://github.com/actualbudget/actual/pull/2003
- server: https://github.com/actualbudget/actual-server/pull/286
- docs: https://github.com/actualbudget/docs/pull/284

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
2023-12-02 19:29:03 +00:00
youngcw
f7a4417243 add bank sync feature to home page (#281)
I added bank syncing as a feature on the home page, with a new svg to go
with it.

I also mentioned in the importers that more than ynab are available, but
not officially.
2023-11-28 11:00:10 -07:00
Jason Whitelock
f5addccb1e Create reset password doc (#271)
Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2023-11-28 17:21:55 +00:00
Shazib Hussain
8a90292f97 Adding some contribution guidelines (#277) 2023-11-27 19:42:23 +00:00
Matiss Janis Aboltins
39a8f94931 [WIP] Actual Budget Vision (#213) 2023-11-26 19:36:43 +00:00
DJ Mountney
f1dccec274 API update learnCategory,runTransfers for addTransactions (#280)
To match changes from https://github.com/actualbudget/actual/pull/1944
2023-11-26 18:17:22 +00:00
youngcw
a7e862acbb Community Projects page (#278)
This adds a page that calls out useful and interesting community
projects that integrate with Actual. There are only a few that I know of
right now, but we can add any later that come up.
2023-11-22 13:03:35 -07:00
youngcw
cfe53bf0cd add blurb for goal colors (#275)
matches [actual#1780](https://github.com/actualbudget/actual/pull/1780)
2023-11-10 14:36:13 -07:00
Matiss Janis Aboltins
5dcf7fd2b0 📝 updated main contributors list (#276) 2023-11-08 17:15:46 +00:00
Stefan Hall
b26bfc457b Update ynab4 + 5 importer links in api docs (#273)
So they point to existing implementations. The current links are broken
and Im hoping these links are correct - someone please let me know if
this is incorrect, thanks
2023-11-04 09:33:47 +00:00
Matiss Janis Aboltins
3b538b6fff 🔖 (23.11.0) (#274)
- web: https://github.com/actualbudget/actual/pull/1859
- server: https://github.com/actualbudget/actual-server/pull/273
- docs: https://github.com/actualbudget/docs/pull/274
2023-11-04 09:28:43 +00:00
Matiss Janis Aboltins
f634dc9850 Update releasing.md (#270)
Co-authored-by: shall0pass <20625555+shall0pass@users.noreply.github.com>
2023-10-19 17:32:00 +01:00
shall0pass
46092def6b Deemphasize 'Cloud' usage in the Sync page (#255)
I'm trying to deemphasize the term 'cloud' here because I think it
implies that it's going somewhere unknown. It should be clear that it's
going to a users installed server, and nowhere else. Pikapods and
fly.io, I think would be classic examples where where the term 'cloud'
makes sense but wouldn't make sense if someone had it installed on a
local PC, NAS or Raspberry Pi.

I left a lot of the document alone further down because it seems like
there may be error messages within the app that use the term 'cloud'.

Maybe add an additional explainer in the section that explains the cloud
file?

**Came up in a discord support issue.
2023-10-09 07:58:38 -05:00
Musa Ahmed
5ccd7a7a32 Small Grammer Improvement (#269) 2023-10-04 17:40:09 +01:00
Matiss Janis Aboltins
4b4914619c 🔖 (23.10.0) (#268)
- web: https://github.com/actualbudget/actual/pull/1757
- server: https://github.com/actualbudget/actual-server/pull/269
- docs: https://github.com/actualbudget/docs/pull/268

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
2023-10-04 17:33:32 +01:00
Clumsy
0ae15a2eed Simplify updating docker to 1 command (#261) 2023-09-27 18:25:32 +01:00
Daniel P
faa1ed0bff Fix step to skip if no savings account. (#265)
I believe this was incorrect, as skipping step 6 would mean there isn't
anything put into the savings category.
2023-09-04 21:16:02 +01:00
Matiss Janis Aboltins
7a90e1e2c7 🔖 (23.9.0) mobile transaction entry, privacy mode (#266)
**Feature highlight:**
- Mobile transaction entry - ability to enter transactions using the
mobile responsive version of Actual
- Privacy mode - ability to mask balance amounts in the app - allowing
to use the product in public environments

---

- web: https://github.com/actualbudget/actual/pull/1635
- server: https://github.com/actualbudget/actual-server/pull/259
- docs: https://github.com/actualbudget/docs/pull/266

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
2023-09-03 15:56:04 +01:00
kei
43d5ef0ac0 Update index.md (#264)
Edit typo.
2023-08-27 21:48:39 +01:00
Seth Gillett
80c8c665f5 Add instructions to retrieve nYNAB budget using an API key (#263) 2023-08-25 17:43:45 +01:00
Matiss Janis Aboltins
cd9721d675 Pikapods easy-install in homepage (#262)
Co-authored-by: Jed Fox <git@jedfox.com>
2023-08-24 20:35:10 +01:00
Matiss Janis Aboltins
03f4f00547 📝 removing some outdated information (#259) 2023-08-14 20:51:49 +01:00
Matiss Janis Aboltins
9c5e4bc7a1 📝 new core contributor guide (#256)
New Core Contributor Guide

Information that is useful to know when joining the team.
2023-08-10 17:22:31 +01:00
shall0pass
9ee18ad59a Updated text to GoCardless (#254)
I don't have a GoCardless account to update the images.  

Have the images fundamentally changed (besides saying GoCardless instead
of Nordigen)?

---------

Co-authored-by: Johannes Löthberg <johannes@kyriasis.com>
2023-08-10 10:47:46 -05:00
Matiss Janis Aboltins
ae2bedd681 🔖 (23.8.1) fix nYNAB import, mobile colors and other smaller fixes (#260)
- web: https://github.com/actualbudget/actual/pull/1475
- server: https://github.com/actualbudget/actual-server/pull/240
- docs: https://github.com/actualbudget/docs/pull/260
2023-08-07 18:54:27 +01:00
Matiss Janis Aboltins
638a631405 Fix docs link (#258)
Fixes the link used in `/blog/rss.xml`
2023-08-04 18:49:58 +01:00
Matiss Janis Aboltins
732f1e9391 🔖 (23.8.0) stability improvements and new experimental features (#257)
- web: https://github.com/actualbudget/actual/pull/1444
- server: https://github.com/actualbudget/actual-server/pull/238
- docs: https://github.com/actualbudget/docs/pull/257

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <MatissJanis@users.noreply.github.com>
2023-08-02 20:34:45 +01:00
youngcw
8cebea3a25 Goals: add blurb for previous flag, clean up confusing note (#253)
Matches [#1403](https://github.com/actualbudget/actual/pull/1403)

Tweaked some things that I noticed that were confusing.

---------

Co-authored-by: shall0pass <20625555+shall0pass@users.noreply.github.com>
2023-07-29 13:15:37 -05:00
Johannes Löthberg
5787ae51e5 Rewrite managing credit cards page (#252) 2023-07-27 09:13:28 -05:00
Johannes Löthberg
8a9803fc5f Fix documentation for keeping negative balances in a category (#241) 2023-07-21 08:37:49 -04:00
Michael Gillett
894b137432 Issue 236 - Settings page images missing highlighted callouts (#249) 2023-07-19 09:07:49 -04:00
Johannes Löthberg
c1e801c487 Fix markup of release note template for contributing docs (#248) 2023-07-17 07:03:36 -04:00
Paul Gauntlett
d32b0af92d Explanation of Filter Dropdowns (#247)
Added a note regarding the dropdown arrow by "Date" and "Amount"s in
view of a recent bug report that showed that these are not always easily
discovered..

PS Sorry to keep adding changes but I am trying to respond quickly to
@shall0pass comments on another issue
2023-07-15 19:05:06 +01:00
Paul Gauntlett
0137e6b2b3 Filters - Example of Date Dropdown (#246)
Add Screenshots re Date Dropdown to Docs

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-07-15 17:36:10 +01:00
shall0pass
f0e67d71d4 Spellchecker CI (#228) 2023-07-15 10:41:33 -04:00
Paul Gauntlett
181e30e168 Describe how to access "Settings" (#245)
A partial update to the text until the screenshots can be updated
2023-07-14 20:12:59 +01:00
Paul Gauntlett
9a24c1019d A tour of actual - small update (#244)
Part of these instructions referred to desktop app and are now amended
2023-07-14 20:12:39 +01:00
Paul Gauntlett
521aa787ac Update Docs re delete Rules (#243)
Update Docs re mechanics to delete Rules
2023-07-14 19:54:27 +01:00
Paul Gauntlett
5fedcde883 Update Docs re Global Keyboard Shortcuts (#242)
Update Documentation regarding Global Keyboard Shortcuts as these do not
work in the Web app
2023-07-14 19:52:32 +01:00
shall0pass
f1f3079b0c Add 'update' subheadings for docker (#240) 2023-07-12 19:01:52 -04:00
Michael Gillett
ce8ea5a534 created filters & reports category (#238) 2023-07-12 14:30:50 -04:00
Michael Gillett
48a4e02097 added section for saving filtered transactions for 23.7.1 update (#232) 2023-07-11 17:45:25 -04:00
Paul Gauntlett
073c78bce5 New Account - Add link to Bank Sync Notes (#235) 2023-07-10 14:22:31 -04:00
Paul Gauntlett
3cc42cd58c Category Functionality Notes Update (#233) 2023-07-10 11:24:40 -04:00
Paul Gauntlett
9bf146cd70 Change and Add Create Accounts Images (#231) 2023-07-09 15:10:33 -04:00
Matiss Janis Aboltins
067cd5122b 🔖 (23.7.2) more patches (not so critical, but still annoying) (#230)
- web: https://github.com/actualbudget/actual/pull/1322
- server: https://github.com/actualbudget/actual-server/pull/225
- docs: https://github.com/actualbudget/docs/pull/230
2023-07-09 17:02:45 +01:00
shall0pass
a446a5fce1 Spelling corrections (#229) 2023-07-09 11:29:04 -04:00
Michael Gillett
2277b12be8 instructions on manual db updates (#226) 2023-07-07 22:25:52 -04:00
shall0pass
c39b8d5018 Add more documentation for 'up to' keywords and spelling issues (#227) 2023-07-06 18:07:07 -04:00
Matiss Janis Aboltins
d6b1ba1250 🔖 (23.7.1) critical sync fixes (#225) 2023-07-05 17:15:38 -04:00
Jed Fox
b9ea77f7bc Add warning not to install 23.7.0 (#224) 2023-07-05 18:25:31 +01:00
Matiss Janis Aboltins
46f330213f [WIP] 🔖 (23.7.0) Nordigen release, stability improvements (#223)
- web: https://github.com/actualbudget/actual/pull/1280
 - server: https://github.com/actualbudget/actual-server/pull/222
 - docs: https://github.com/actualbudget/docs/pull/223

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-07-04 22:07:04 +01:00
youngcw
e9e213148d check template blurb (#181) 2023-07-04 12:37:02 -04:00
youngcw
9233649012 Entry for available funds percent goal (#221) 2023-07-04 09:36:04 -04:00
Jed Fox
dae2eb210b Add redirects for all pages on the old actualbudget.com (#219) 2023-07-02 07:04:27 -04:00
Jed Fox
4555d62fc7 Update the restore doc (#220) 2023-07-02 07:03:36 -04:00
Jed Fox
fb40f0b2c6 Add donate links to the navbar & footer (#216) 2023-06-29 14:30:11 -04:00
Jed Fox
413c9f7919 Add a funding policy document (#217) 2023-06-29 14:23:56 -04:00
Jed Fox
3538723e87 Update blog authors (#218) 2023-06-29 14:23:37 -04:00
Jed Fox
b84d3f0a75 Fix errors in import example (#215)
ref:
https://discord.com/channels/937901803608096828/1122664924582260786/1123052436219760691
2023-06-27 16:38:40 -04:00
Matiss Janis Aboltins
53d1588b14 📝 updating the website tagline, the hook (#212)
Updated the tagline (the hook) for the website.

For people coming in for the first time - they don't know (and care)
about the historical context of open source actual vs closed source. So
slightly changed the copy to focus on the truly important things - the
features.

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-06-23 20:13:44 +01:00
Zsolt Sz. Sztupák
22ad3e5ff7 Add Home Assistant as a community install option (#214) 2023-06-22 21:14:06 -04:00
Shazib Hussain
741460fd10 Adding architecture details (#211)
Maybe these notes should form part of an existing page, but I wanted to
put some notes in about the web worker/websockets nuance and clarify the
whole frontend/backend thing as it confused me a bit at first.

Perhaps this page could be a stub for adding more 'technical' details as
we go. (stick a 'more coming soon' on the bottom?)

Or maybe it should just be called 'Technical Details'

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-06-19 19:28:12 -04:00
Jed Fox
48fbda27fa Redirect /account/* to sunset domain (#210) 2023-06-19 20:54:23 +01:00
Matiss Janis Aboltins
dbb5db590d 📝 update core contributors (#209)
Co-authored-by: Jed Fox <git@jedfox.com>
2023-06-19 20:07:40 +01:00
Shazib Hussain
f92c760d8d Updating project information docs (#207) 2023-06-18 11:00:26 -04:00
Matiss Janis Aboltins
c559e6b68c 📝 (nordigen) move bank-sync docs away from experimental (#208) 2023-06-18 10:58:49 -04:00
Rich Howell
38cbf49ef7 [WIP] Contributing doc changes (#204)
For any changes now that the document is public.
2023-06-16 17:49:21 +01:00
Rich Howell
51b4090066 Documentation Structure (#205)
Amended document structure to fit amended strucutre

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-06-15 06:45:18 +01:00
Rich Howell
e722f58b52 Update README.md (#206) 2023-06-14 20:16:09 +01:00
Rich Howell
3817952ed6 Update README.md (#183)
Linked to contributing docs, replacing detail. This can't be merged
until after #176 gets merged though as the build will fail due to broken
links.

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-06-14 20:14:46 +01:00
Rich Howell
7fa3a13783 Contributing to actual budget (#203) 2023-06-14 18:07:12 +01:00
Rich Howell
216732581a Update faq.md (#198)
Bank Sync update
2023-06-14 17:46:19 +01:00
Jed Fox
bc1a039105 Swap from reference-style links to @mentions (#201)
I will also update the release notes generator to use the new style
(9ffec33742)
2023-06-14 17:45:38 +01:00
Jed Fox
268544b6d7 Rename budgeting/howitworks.md to index.md (#202)
This matches the other pages that have child pages.
2023-06-14 07:33:05 +01:00
Jed Fox
be0dc4ecd4 Improve homepage a bit, clean up old/unused code (#200) 2023-06-13 16:50:22 -04:00
Rich Howell
8caa78b1f7 Blog (#196)
https://docusaurus.io/docs/blog
https://deploy-preview-196--actualbudget-website.netlify.app/
2023-06-13 20:14:36 +01:00
Jed Fox
899801ab0c Move the docs back to /docs, add in a version of the homepage (#193)
https://deploy-preview-193--zingy-bonbon-b1b286.netlify.app

---------

Co-authored-by: Rich Howell <github@codenameowl.com>
2023-06-13 05:51:08 +01:00
Jed Fox
d61dbea744 A few minor updates (#194)
- fix broken issue link
- tweak the typography in the API docs
2023-06-13 05:19:50 +01:00
Jed Fox
30f2ef6da6 Fix cd instructions for Windows (#192)
I meant to come back and fill this in as part of #127 but forgot about
it — @rich-howell does this instruction sound correct?
2023-06-12 18:32:22 -04:00
Jed Fox
9260fc4c69 Delete deploy.yml (#191)
We don’t need this anymore since we deploy via Netlify
2023-06-12 20:28:33 +01:00
Jed Fox
5d433c617e Reorganize page URLs to match the sidebar (#185)
Principles:

- lowercase URLs only
- kebab-case
- generally match sidebar structure
2023-06-12 15:20:06 -04:00
Rich Howell
b5e8296318 Update docusaurus.config.js (#190)
Change URL
2023-06-12 15:19:12 -04:00
Jed Fox
7f880446cc New Fly install doc (#127) 2023-06-12 06:29:47 +01:00
Jed Fox
bf99b244e0 Update local install docs to recommend installing the latest LTS version of Node (#184) 2023-06-11 06:38:41 +01:00
Jed Fox
2b11c85c7e Add instructions for updating to the local install page (#187)
Co-authored-by: Rich Howell <22135084+rich-howell@users.noreply.github.com>
Co-authored-by: Trevor Farlow <trevdor@users.noreply.github.com>
2023-06-11 06:37:52 +01:00
Rich Howell
50f31a7cf0 Replace Logo (#188)
Logo update
2023-06-11 06:36:58 +01:00
Jed Fox
83bb5f982a Update Nordigen setup process (#182)
The environment variables and config.json methods are now deprecated
since the secrets are stored in the database.


https://deploy-preview-182--zingy-bonbon-b1b286.netlify.app/accounts/connecting-your-bank/
2023-06-08 18:41:53 +01:00
youngcw
c38e8f380a Remainder goal section (#180)
Matches
[actualbudget/actual#1101](https://github.com/actualbudget/actual/pull/1101)
2023-06-07 18:25:37 -04:00
00apm
9978365350 Update Fly-updating.md- Add info about updating fly.toml before deployment (#97)
I have a suggestion for the "Updating Actual" doc page. Since fly.toml
is in .gitignore pulling changes via git won't update it. Users should
also update their fly.toml before deploying on server.
I added short info in the Fly-updating.md. However I don't know if this
info should also be updated elsewhere.

---------

Co-authored-by: Rich Howell <github@codenameowl.com>
2023-06-03 07:57:30 +01:00
btehan
bee714a383 Update howitworks.md (#134)
Line 53, where it says That money will appear in next month's **To
Budget**. This isn't really happening. Should this part of the
documentation be changed?

---------

Co-authored-by: Rich Howell <github@codenameowl.com>
2023-06-03 07:44:53 +01:00
Matiss Janis Aboltins
ef67722bdb 🔖 (23.6.0) category hiding and filters for reports (#179)
Web: https://github.com/actualbudget/actual/pull/1087
Server: https://github.com/actualbudget/actual-server/pull/207
Docs: https://github.com/actualbudget/docs/pull/179
2023-06-01 21:40:24 +01:00
Rich Howell
d9e593c689 Remove loot-design (#178)
Remove loot-design from project structure, this resolves #177
2023-06-01 13:42:56 +01:00
youngcw
d481f15fb2 add example for schedule full flag (#174)
Matches up with
[actualbudget/actual#1052](https://github.com/actualbudget/actual/pull/1052)
2023-05-27 10:09:27 +01:00
shall0pass
497911bd99 End of month cleanup (#172)
This is a basic documentation page of the `End of month cleanup` feature
if it's chosen to be included.

PR: https://github.com/actualbudget/actual/pull/1016
2023-05-24 12:08:15 -04:00
aujkb
c337afa90c Update project-layout.md (#170) 2023-05-13 08:37:01 -04:00
youngcw
5895e51594 Add info on template hold flag (#169)
Info about using PR#1004 of base app.
2023-05-07 16:52:50 -04:00
Rich Howell
1133af7669 23.5.0 (#168)
Co-authored-by: Jed Fox <git@jedfox.com>
2023-05-04 19:02:41 +01:00
Nik
d1055d00e6 Small fixes for API docs (#167) 2023-05-04 10:02:36 -04:00
youngcw
934b2d0a1e added info about goal template priorities (#166) 2023-05-02 16:37:29 -04:00
Rich Howell
020079210d Demo Budget (#163) 2023-04-27 08:10:39 -04:00
shall0pass
0a57b4341a Add percentage based targets to table (#152)
This is an addition when https://github.com/actualbudget/actual/pull/858
is merged.

Co-authored-by: Jed Fox <git@jedfox.com>
2023-04-26 19:00:06 -04:00
Rich Howell
c6e290268f Update addaccount.md (#164)
This should resolve #54 the issue raised with a note has been added to
notify people of the Off Budget reset when the account type is changed.
2023-04-26 14:52:17 -04:00
Rich Howell
055f2c704b View on Hover (#165)
This should resolve #82 documentation around Category notes added.
2023-04-26 14:50:19 -04:00
aujkb
3ef6036933 Update nynab.md (#161) 2023-04-25 07:58:51 -04:00
aujkb
a210fba367 Update nynab.md (#162) 2023-04-25 06:55:31 -04:00
youngcw
61d963cf98 Additions to keyboard shortcuts (#147)
I added some non documented keyboard shortcuts for the transaction
ledger. I also standardized the capitalization of the existing
shortcuts.

I cant decide if its better to have the single letters upper or lower
case. I don't want to imply that a `Shift` press is needed. Also, in
`Ctrl + o` shortcut, the `o` was lower case maybe to try and not look
like the number. I don't think I have a preference and can change it to
upper case if that is preferred.
2023-04-22 11:33:40 -04:00
Patrik Stenmark
bdf2f839e3 Fix table in goal template docs (#160) 2023-04-22 11:28:15 -04:00
Matiss Janis Aboltins
0452acc108 🔖 (23.4.2) revert back to old autocomplete & keyboard shortcut fix (#159)
- web: https://github.com/actualbudget/actual/pull/930
- server: https://github.com/actualbudget/actual-server/pull/192
2023-04-22 15:34:29 +01:00
shall0pass
b4ea66f5d5 Goals: Added 'schedule' keyword to syntax chart (#158) 2023-04-19 10:28:05 -04:00
shall0pass
2fd7e15892 Changed wording on 'by' matches section (#151) 2023-04-19 10:27:29 -04:00
Tillman Jex
e2f79d3089 fly launch cd clarification - resolves #140 (#155) 2023-04-18 13:16:38 -04:00
Jed Fox
17b1f15eaf Add step to create a GitHub release when publishing a release (#154) 2023-04-17 15:54:12 -04:00
Matiss Janis Aboltins
67d314c8dd 🔖 (23.4.1) fix rule creation from transaction list (#153) 2023-04-16 18:09:22 +01:00
Matiss Janis Aboltins
374e2a839d 📝 update release instructions (#150) 2023-04-07 21:21:47 +01:00
Jed Fox
8fa23838c0 Use an IIAFE in the API example code 2023-04-06 19:45:27 -04:00
Matiss Janis Aboltins
f20bed8e9f 🔖 (23.4.0) release notes (#148)
**Actual has now been moved to a stand-alone Docker organization. If you
were previously using `jlongster/actual-server` docker image - please
update it to `actualbudget/actual-server`.**

The release has the following notable features:

- Rules can now optionally be applied when any of their conditions match
(in addition to the existing option to apply when all of their
conditions match)
- Rules: quick-create option from the transaction table (in the “X
selected” menu that shows up after selecting a transaction, choose
“Create rule”)
- Ability to hide decimal places for currencies with large numbers (in
Settings → Formatting)
- New autocomplete component (please report any bugs
[here](https://github.com/actualbudget/actual/issues/773))
- Lots of smaller improvements and bugfixes

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-04-06 22:19:55 +01:00
Jed Fox
b453e6771b Add doc to backup page about how to reduce backup size (#145) 2023-04-06 14:25:45 -04:00
Jed Fox
c923505ee2 Fly: add instruction for new upsell (#142) 2023-04-06 14:25:30 -04:00
Jed Fox
1cccf50def Add a page about configuring server debug logging (#146) 2023-04-06 13:48:14 -04:00
Trevor Farlow
01d2b1cb5e Update all Docker Hub references to new actualbudget organization (#144)
...away from `jlongster`'s personal account. We're officially an org
now!

Before merging,
1. merge https://github.com/actualbudget/actual-server/pull/175
2. build and push a new image to the org repo via `actual-server` CI
2023-03-31 22:45:25 -06:00
Trevor Farlow
875f90525c Update directory name for release notes 2023-03-31 13:08:41 -06:00
chris heazlewood
e7486b1299 Update Building-Windows.md (#143) 2023-03-30 19:43:18 -05:00
Jed Fox
11f28edbf3 Add docs for importing CSVs (#133) 2023-03-27 11:31:44 -05:00
Jed Fox
4a7c7022ee Update Docker docs (#122) 2023-03-27 11:25:45 -05:00
Jed Fox
0cd8aa0d3d Add a link to a guide for hosting on Synology (#125) 2023-03-27 11:25:10 -05:00
Aidan Harbison
3dfa3d196a edge tag contains latest server and client (#141)
Based on testing and discussion in Discord, the `edge` tag does contain
the latest `desktop-client` as well. Removes an outdated statement in
the Docker install documentation that stated otherwise.
2023-03-26 11:23:39 -05:00
aujkb
affb20b763 Update overview.md (#139) 2023-03-23 08:51:47 -04:00
Eike Siewertsen
0e9154323a fix api example config typo. serverUrl -> serverURL (#138) 2023-03-22 08:32:37 -04:00
Soulplayer
58946590d7 Update Configuration.md with a warning about exposing data and config.json (#137) 2023-03-22 08:26:26 -04:00
Soulplayer
f18a30fde0 Improved documentation arround connecting your bank (#136) 2023-03-20 07:43:09 -04:00
Jakub Kuczys
5969844407 Remove backticks in config.json example (#135) 2023-03-18 11:32:30 -04:00
Jed Fox
13ecf64ddb Add docs for auto-generated release notes (#129)
People contributing will now be asked to create a file containing their
PR’s entry into the release notes when opening a PR.

This approach was inspired by Prettier’s release notes approach
(https://github.com/prettier/prettier/tree/main/changelog_unreleased).
Separate files are used to avoid merge conflicts (each file is
completely separate, whereas adding lines to a file would result in
merge conflicts each time a PR is merged).

Checks will nudge people to create these files for their PRs, and PRs
created from a `release/*` branch on the main repos will have an action
run that outputs the Markdown-formatted release notes into a comment on
their PR. That action will also delete the no-longer-needed release
notes files to prep for the next release. Make sure you merge `master`
into release branch before finishing the PR to ensure the release notes
are fully generated and cleaned up. (You may encounter check failures if
you haven’t merged `master`)
2023-03-16 14:40:44 -04:00
TJ Finlinson
00cc8bf40b Adding Bank sync documentation (#126)
Co-authored-by: root <root@L15294>
Co-authored-by: Jed Fox <git@jedfox.com>
2023-03-13 21:52:51 -04:00
shall0pass
b5ae4c5938 [Experimental] Report budget docs (#121)
I'm not a user of this feature, but I thought I could get the ball
rolling on adding some documentation. I'm not 100% sure this is how this
budget type is used, so there are likely wrong assumptions. I'm hopeful
someone will either correct me or take the reigns. There have been
several users looking for the features of this budget type, so I think
it deserves a little time to explain how it's intended to be used.
2023-03-13 21:40:47 -04:00
Matiss Janis Aboltins
4985cbff96 📝 update release instructions (#131)
Updating release instructions. The current instructions were slightly
outdated.
2023-03-13 21:40:10 -04:00
Matiss Janis Aboltins
6453abad31 🔖 (23.3.2) release notes (#130)
* 🔖 (23.3.2) release notes

* Update Release-Notes.md
2023-03-13 20:24:22 +00:00
Tillman Jex
cf0c17a623 update readme and begin image restructuring (#123)
* update readme and begin img dir restructuring

* fix broken issue board link

* readme edit

* addressed RFCs : #123

* organising images

* more images organised

* more image restructuring

* img reorganisation done

* moved unused imgages to img/unusued and checked if anything broke

* typo

* move favicon and actial imgs back, deleted the rest of unused

* corrections
2023-03-12 22:51:19 -04:00
crorodriguezro
debbc5a5bc Typo: Changed band to bank (#128) 2023-03-12 20:41:50 -04:00
Rich Howell
d93439dbfe 23.3.0 (#119) 2023-03-10 18:47:18 +00:00
Jabari E Holder
533de26936 Update HTTPS.md when using config.json (#118)
Based on the code, the paths are no longer `keyPath` and `certPath`. This errors when using the config.json file.

https://github.com/actualbudget/actual-server/blob/master/src/app.js#L66-L67
2023-03-05 16:39:52 -05:00
Jed Fox
e7aef3a4a7 Switch to Yarn to match the other repos (#117) 2023-03-05 19:14:19 +00:00
Jed Fox
ed2adc8a15 Clean up .gitignore entries (#116) 2023-03-05 18:39:55 +00:00
Tillman Jex
3fc8d44614 using actual (images and instructions update) (#109)
* img : update accounts image : #85

* doc : fixed formatting and clearer wording : #85

* doc : updated instructions due to new sidebar layout : #85

* img : update images due to new sidebar layout : #85

* doc : updated accounts/addaccount page : #85

- moved all images into their own folder
	- grepped the whole repo for their img paths to make sure no other pages were referencing the same images.
- updated img paths in the addaccount page
- updated wording based on new layout / buttons
- simplified other wordings

* img : updated images due to new sidebar layout : #85

- created new folder for backup-restore section
- created new images for 'backup.md'
- deleted old images from 'backup.md'
- updated wording in 'backup.md'

* Fix image sizing

* img : try to half size with @2x, but no change : #85

* doc : implement @2x img resizing and update images : #85

- resized retina screenshots where appropriate
- updated images that showed old sidebar layout

* img : commit missing file : #85

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-03-05 18:39:39 +00:00
Rich Howell
c0937355dc Installation Methods (#114)
* Installation Methods

Adding the ability to have additional installation methods in the documentation linked to from external blogs etc.

* Update overview.md

Moved section to replace last paragraph
2023-03-05 13:42:01 +00:00
Rich Howell
eeb45dc5dc Update Docker.md (#113)
Docker installation documentation this should resolve #99
2023-03-05 13:17:57 +00:00
Jed Fox
89cf9a1e2f Add Prettier with config matching main repo (#111)
* Add Prettier with config matching main repo

* Run Prettier on all files
2023-03-04 17:56:58 +00:00
Jed Fox
d7274c291f Add an image handling component (#110)
* Update docusaurus

* Make sure images are in their own paragraph

* Add image handling logic

* oops!

* Fix issues with Image component

* Enable image plugin in dev

* Allow arbitrary scales, remove unused case
2023-03-04 16:54:46 +00:00
Rich Howell
e6b9680a39 Removed unsupported install methods (#108)
* Removed unsupported install methods

* Update Fly.io.md

Fixed broken link

* Update docs/Installing/fly/Fly.io.md

Co-authored-by: Jed Fox <git@jedfox.com>

* Update overview.md

Removing broken links

* Update overview.md

* Create DockerWithNginx.md

* Docker

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-03-01 21:59:12 +00:00
Matiss Janis Aboltins
bdfe900828 Versioning strategy (#105) 2023-02-25 08:48:11 +00:00
Hans Fast
575ec8eda2 Add note on migration from old version (#101)
* add a note about export from old version of actual

* link to migration info from getting-started

* Update docs/Installing/overview.md

Co-authored-by: Hans Fast <fasthans@gmail.com>

* Update docs/Getting-Started/migration/migration-intro.md

Co-authored-by: Hans Fast <fasthans@gmail.com>

---------

Co-authored-by: Rich Howell <22135084+rich-howell@users.noreply.github.com>
2023-02-15 23:23:29 +00:00
Jed Fox
ba06f4dfaa Move HTTPS docs to a separate file and add more information (#104)
* Move HTTPS docs to a separate file and add more information

* copilot
2023-02-15 23:21:20 +00:00
Rich Howell
4e27e7772c Removing some of the non Actual based installation methods (#103)
* Update sidebars.js

Removing some of the non Actual based installation methods

* Update sidebars.js

Removed commented out lines
2023-02-10 20:24:42 +00:00
Rich Howell
feb78b0cab 230209 Release Notes (#102)
* Update Release-Notes.md

* Update Release-Notes.md
2023-02-09 20:39:36 +00:00
Paul
efb0305ecf Update Unraid docs with steps to generate certificates (#98) 2023-02-09 07:50:29 +00:00
Jed Fox
dd3e1fbd47 Add Caddy as an alternative to Tailscale (#100) 2023-02-09 07:47:41 +00:00
Jed Fox
d37c1bfb25 Update config docs for recent improvements (#96)
* Update config docs for recent improvements

- Add ACTUAL_CONFIG_PATH
- add env variable equivalents to all settings
- add webRoot/ACTUAL_WEB_ROOT

* Reference /data fallback
2023-02-06 21:26:49 +00:00
albertchae
1b2102d8e0 Fix minor typos in documentation (#95)
Just some small typos I saw while getting actual set up for the first time.
2023-02-06 07:34:57 +00:00
Rich Howell
ccd0ac5e4d Update Release-Notes.md 2023-02-06 07:32:22 +00:00
Rich Howell
0566096d1d Update Release-Notes.md
Added missing fixes
2023-02-06 07:31:00 +00:00
Rich Howell
a4fad8c8ca Update Release-Notes.md
Added a warning
2023-02-06 07:23:14 +00:00
Jed Fox
352d1bf730 Fix PR refs in actual-server release notes (#94) 2023-02-05 18:21:42 +00:00
shall0pass
9df4cc18eb Experimental sections - Goal docs (#80)
* goal template docs

* added apply templates subsection

* warning note

* warning label on experimental parent link

* Merge branch 'actualbudget:master' into goal_docs

* file move

* fix sidebar

---------

Co-authored-by: Rich Howell <22135084+rich-howell@users.noreply.github.com>
2023-02-05 18:04:50 +00:00
Jed Fox
7ed206e178 Convert user mentions to reference-style links (#93) 2023-02-05 17:59:53 +00:00
Jed Fox
98ac4d7e6a Add docs for the config file and HTTPS (#91)
* Add docs for the config file and HTTPS

* copy edit

* Link from SharedArrayBuffer docs

* Add config page to sidebar

* .
2023-02-05 17:56:28 +00:00
Rich Howell
b56b00704d Update Release-Notes.md (#84)
* Update Release-Notes.md

Prep for next release

* 23.2.5

Pushing changes.

* Update Release-Notes.md

Added bullet points to actual server

* Update Release-Notes.md

Typo

* Update docs/Release-Notes.md

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>

* Update Release-Notes.md

Moved features to bug fix

* Update Release-Notes.md

Added two last minute changes.

* Update docs/Release-Notes.md

Co-authored-by: Jed Fox <git@jedfox.com>

* Update docs/Release-Notes.md

Co-authored-by: Jed Fox <git@jedfox.com>

* Update docs/Release-Notes.md

Co-authored-by: Jed Fox <git@jedfox.com>

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
Co-authored-by: Jed Fox <git@jedfox.com>
2023-02-05 17:55:42 +00:00
Jed Fox
0d333be6d0 Add docs for the SharedArrayBuffer issue (#88)
* Add docs for SharedArrayBuffer issue

* + “supported browser” section
2023-02-03 20:47:00 +00:00
Jed Fox
22529a911d Update package-lock.json (#90) 2023-02-03 20:46:13 +00:00
Jed Fox
7285753e2d Updates to the sidebar layout & content (#89)
* Run Prettier

* Add `@docusaurus/plugin-content-docs` as a direct dep

* Remove generated index pages, move Release Notes to the top level

* Move installing section inside “Getting Started”

* Rename “Using Actual” to “A Tour of Actual”

* Expand “Getting Started” by default

* Move “how it works” to the heading of the Budgeting section

* more changes

* polish styles of section headers

* Move old homepage to the start of the tour, add a new one

* A few updates to project-layout.md, remove mobile package

* Clarify that you can use a local server with preview builds

* A couple of tweaks to the Windows article

* Clarify the installation docs

* Fix some issues on the sync page

* Centralize the contact info into one page

* Fix homepage link

* Fix broken links on installation page
2023-02-03 05:05:52 +00:00
shall0pass
291ce8aa58 update discord links (#87) 2023-01-31 15:52:38 +00:00
George Sumpster
c666f3e448 add duplicate transactions, tweak bulk tx docs (#86) 2023-01-30 12:20:50 +00:00
Rich Howell
ac93d58035 Using Actual (#36)
* Using Actual

Using actual, this also resolves #11

* Content & Images

* Using Actual Content
2023-01-28 09:29:53 +00:00
TechwizEE
344fb9ac8a Docker compose with nginx reverse proxy (#77)
* added DockerWithNginx.md and updated sidebar

* re-ordered sidebar, added FAQ about merged budgets, updated Docker with NGINX to use 9443, added section to assist with debugging

* cleaned up troubleshooting section, re-worked notes on certificates and HTTPS

* tweaked FAQ entry

* tweaked sidebar

* removed section from FAQ

---------

Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2023-01-27 20:49:27 +00:00
shall0pass
a3fc674705 Cleared Rules example (#79)
* Cleared Rules example

* Update docs/Budgeting/rules/rules-custom.md

Thanks!

Co-authored-by: Jed Fox <git@jedfox.com>

* verbage updates

* one more

Co-authored-by: Jed Fox <git@jedfox.com>
2023-01-25 18:39:21 +00:00
Rich Howell
02fd340e64 Merge pull request #76 from j-f1/api
Update the API docs
2023-01-15 17:45:31 +00:00
Jed Fox
992bcd730f Use a real UUID in the example code 2023-01-14 17:05:01 -05:00
Jed Fox
26fa00e3be Updates per latest changes 2023-01-14 17:01:42 -05:00
Jed Fox
13b09bfa9f Remove advice to use server files directly 2023-01-14 17:01:15 -05:00
Jed Fox
22f3c5954b Add “Connecting to a remote server” docs 2023-01-14 15:11:47 -05:00
Jed Fox
3ddfcc4dbf Update to match v5 API 2023-01-14 14:46:45 -05:00
Jed Fox
4cf165475a Add remaining methods to “Using the API” 2023-01-14 14:30:06 -05:00
Jed Fox
11114e9309 Fix build errors 2023-01-14 14:25:12 -05:00
Jed Fox
49ca125aa2 Merge remote-tracking branch 'upstream/master' into api 2023-01-14 14:16:34 -05:00
Rich Howell
8dc49538e0 Merge pull request #78 from actualbudget/matiss/netlify
👷  netlify preview deployments
2023-01-14 18:52:50 +00:00
Matiss Janis Aboltins
5196d068ad 👷 netlify preview deployments 2023-01-14 18:28:58 +00:00
Jed Fox
5c344ae62d Improve API docs 2023-01-14 11:44:38 -05:00
Jed Fox
a419fc0822 Update using-the-API.md 2023-01-14 11:27:58 -05:00
Rich Howell
fce29510b0 Merge pull request #75 from actualbudget/2301xx-release-notes
Update Release-Notes.md
2023-01-12 22:02:09 +00:00
Rich Howell
dc249ab8b6 Update Release-Notes.md
Tagged versions properly.
2023-01-12 20:59:34 +00:00
Rich Howell
944b7a6b24 Update Release-Notes.md
Fixed headings and added in sub fix splits
2023-01-12 20:43:20 +00:00
Rich Howell
c16f82d1e8 Update Release-Notes.md
Added #442 as it was missing after being merged.
2023-01-12 18:36:52 +00:00
Rich Howell
ad07361ee1 Merge pull request #74 from j-f1/patch-1
Fix using HTTPS url for localhost
2023-01-12 17:47:42 +00:00
Rich Howell
2ccb7e7f67 Update Release-Notes.md
Formatting fix, version number changes and notable changes added
2023-01-12 17:46:14 +00:00
Rich Howell
7aa01a658a Update Release-Notes.md
Created release notes for the next release 23.01.xx
2023-01-12 17:39:14 +00:00
Jed Fox
b03ba7d36a Fix using HTTPS url for localhost 2023-01-12 06:23:07 -05:00
Rich Howell
e41e54b10a Merge pull request #72 from shall0pass/nYnab_updates
nYnab: Separate import options
2023-01-11 20:02:34 +00:00
shall0pass
9075cdde10 update nYnab page 2023-01-11 11:17:23 -06:00
Rich Howell
95659a9b76 Update nynab.md
Added link to json export tool for nYNAB
2023-01-10 14:40:41 +00:00
Rich Howell
a44b21859e Preview builds
Added preview builds overview
2023-01-10 14:40:26 +00:00
Rich Howell
a074c656a6 Merge pull request #71 from actualbudget/docker-sample-files
Update Docker.md
2023-01-08 17:28:37 +00:00
Rich Howell
05c15b6112 Update Docker.md
Added sample files
2023-01-08 17:28:20 +00:00
Rich Howell
3ed4be0ef4 Merge pull request #63 from shall0pass/nYnab_export_1
nYnab export instructions
2023-01-06 07:33:59 +00:00
Rich Howell
9d783e9e4e Merge pull request #69 from j-f1/patch-1
Add some documentation for the end-to-end encryption system
2023-01-06 07:33:48 +00:00
Jed Fox
658c0088ee Add some documentation for the end-to-end encryption system 2023-01-04 12:43:58 -05:00
shall0pass
88ef9a1ba3 Merge branch 'master' into nYnab_export_1 2023-01-03 11:29:23 -06:00
Rich Howell
166a5b0b79 Merge pull request #65 from tjex/patch-1
Update your-own-machine.md
2023-01-03 16:52:15 +00:00
Rich Howell
679fbaffaa Merge pull request #64 from soyatti/patch-1
Update Terraform.md: add link to 'Deploying Actual on fly.io with terraform' page
2023-01-03 16:51:57 +00:00
Rich Howell
314adc6815 Merge pull request #57 from winklevos/master
Add historical transfers applier documentation
2023-01-03 16:51:44 +00:00
Rich Howell
047a645b86 Merge pull request #59 from shall0pass/shall0pass/issue6
e2e encryption sections
2023-01-03 16:51:15 +00:00
Tillman Jex
25935c8972 Update your-own-machine.md
added a step about pointing the browser to local Actual install (localhost:5060)
2022-12-19 17:26:09 +01:00
soyatti
454588b75a Update Terraform.md
link to 'Deploying Actual on fly.io with terraform' page
2022-12-18 22:44:52 +01:00
shall0pass
2162002931 nYnab export instructions 2022-12-12 10:55:03 -06:00
James Long
8c4c38b663 Merge pull request #61 from shall0pass/updateReleaseNotes-Dec
Update release notes regarding 22.12.03
2022-12-09 23:45:05 -05:00
shall0pass
d67752a378 updates 2022-12-09 15:09:37 -06:00
shall0pass
7f8080badc update release notes for 22.12.03 2022-12-09 15:01:40 -06:00
James Long
bcc6fcccc0 Merge pull request #60 from shall0pass/ReleaseNotes_12xxxx
December Release Notes
2022-12-06 23:35:29 -05:00
shall0pass
851088389a Updated file name 2022-12-05 11:10:14 -06:00
shall0pass
af1b69caf5 merge comit from MatissJanis #58 2022-12-04 10:50:35 -06:00
shall0pass
941a6af00e Updates 2022-12-04 09:36:01 -06:00
shall0pass
d188dacfa1 Condensed releases grouped by year 2022-12-03 19:15:04 -06:00
shall0pass
8a4e8a5f99 December Release 2022-12-02 13:38:36 -06:00
shall0pass
f01091376a e2e encryption sections 2022-11-28 20:10:38 -06:00
winklevos
4996c9d3fa Add Advanced Section 2022-11-19 12:46:42 +11:00
Rich In SQL
fc50203896 Update docusaurus.config.js
Changed edit url from main to master
2022-11-14 22:15:08 +00:00
Rich In SQL
5d6b0d65c3 Merge branch 'master' of https://github.com/actualbudget/docs 2022-11-12 15:44:06 +00:00
Rich In SQL
c77c8be284 Removed Noman Restriction 2022-11-12 15:44:03 +00:00
Rich Howell
f312a172b5 Merge pull request #56 from shall0pass/shall0pass/issue55
scheduling window of 2 days
2022-11-12 15:42:25 +00:00
winklevos
175cf80927 add historical transfers applier 2022-11-12 16:01:31 +11:00
shall0pass
0ac91c006d fixup 2022-11-10 12:17:33 -06:00
shall0pass
78ab43098d scheduling window of 2 days 2022-11-10 09:45:34 -06:00
Rich In SQL
9bdd0094e3 Issue board link 2022-11-07 18:44:50 +00:00
Rich Howell
2843042bb8 Merge pull request #53 from shall0pass/docker_updates
Update Docker section
2022-11-07 11:32:15 +00:00
Rich In SQL
4f01f3ecdf Update Fly-prerequisites.md
Added mac warning
2022-11-03 09:00:33 +00:00
Rich In SQL
e2bb86f789 Node update 2022-10-29 14:32:02 +01:00
shall0pass
25429304cc fixup - added container name 2022-10-29 08:14:53 -05:00
shall0pass
03b820f692 Delete yarn.lock 2022-10-28 14:13:17 -05:00
shall0pass
791f354009 update docker text, include comments on data 2022-10-28 14:00:18 -05:00
Rich In SQL
bd82f73a7e Base URL 2022-10-27 18:13:15 +01:00
Rich In SQL
e906e63599 Base URL 2022-10-27 18:03:19 +01:00
Rich In SQL
d068dde24d Search 2022-10-27 17:51:38 +01:00
Rich Howell
29f0aa83e4 Merge pull request #47 from actualbudget/search
Update docusaurus.config.js
2022-10-27 16:58:35 +01:00
Rich In SQL
82e84650a1 Search
Trying to get search working
2022-10-27 16:57:34 +01:00
Rich In SQL
902a7444ed Update 22.10.25.md 2022-10-26 13:07:44 +01:00
Rich Howell
7343a695b7 Merge pull request #48 from jatls/migration-to-simple-sync
Add simple sync migration steps
2022-10-26 06:28:57 +01:00
Rich In SQL
481658ebd5 Sidebar updates
Added items into the sidebar.
2022-10-26 06:25:31 +01:00
Rich Howell
77724bbe48 Merge pull request #51 from actualbudget/re-arrange
Broken Links
2022-10-25 19:06:56 +01:00
Rich In SQL
3b65fac2dc Broken Links 2022-10-25 19:06:36 +01:00
Rich Howell
c3b895bb13 Merge pull request #50 from actualbudget/re-arrange
Broken Links
2022-10-25 19:03:57 +01:00
Rich In SQL
ab5731f781 Broken Links 2022-10-25 18:58:25 +01:00
Rich Howell
783082fbaf Merge pull request #49 from actualbudget/re-arrange
Moving docs for better visability
2022-10-25 18:53:43 +01:00
Rich In SQL
00eda0a34e Moving docs for better visability 2022-10-25 18:53:12 +01:00
Jared Smith
77fcaafffe Add simple sync migration steps 2022-10-26 04:49:39 +11:00
Rich In SQL
4628d98051 Update docusaurus.config.js 2022-10-25 18:28:11 +01:00
Rich Howell
949920cbc9 Merge pull request #44 from actualbudget/Category-Document-Flow
Category Document Flow
2022-10-25 17:58:28 +01:00
Rich In SQL
dda475b879 Category Document Flow 2022-10-25 17:57:55 +01:00
Rich In SQL
90d984b034 From Budgeting to Accounts 2022-10-25 17:54:33 +01:00
Rich Howell
9410aa12d3 Merge pull request #43 from actualbudget/bulk-edit-transactions
Bulk edit transactions
2022-10-25 17:46:18 +01:00
Rich In SQL
ccf105aae3 content and images 2022-10-25 17:44:42 +01:00
Rich Howell
25d0b5e793 Merge pull request #42 from actualbudget/filtering-in-actual
Filtering In Actual
2022-10-25 17:37:25 +01:00
Rich In SQL
48969f05a1 Filtering In Actual 2022-10-25 17:35:15 +01:00
Rich In SQL
cb3cd41c53 Bulk editing transactions 2022-10-25 17:18:41 +01:00
Rich Howell
17824a222a Merge pull request #33 from actualbudget/2210DD-release-notes
221025 Release Notes
2022-10-25 16:34:32 +01:00
Rich In SQL
9fcc4a759d Update release notes version 2022-10-25 07:24:27 +01:00
Rich In SQL
c3fb555bda File rename 2022-10-25 07:24:00 +01:00
Rich In SQL
29d6255749 Version change 2022-10-25 07:23:41 +01:00
Rich In SQL
61c5861c31 Update 22.10.21.md
Fixed typo
2022-10-24 20:13:39 +01:00
Rich In SQL
8073c777e8 Update 22.10.21.md
Updated release date and added warning and releases
2022-10-24 18:39:08 +01:00
Rich In SQL
68c0aef4ac Update API.md
Broken link fix
2022-10-22 18:16:41 +01:00
Rich In SQL
4febb33833 Update API.md
Broken link fix
2022-10-22 18:14:27 +01:00
Rich Howell
379ef5270c Merge pull request #35 from actualbudget/ActualQL-Examples-Org
ActualQL Examples
2022-10-21 21:23:46 +01:00
Rich In SQL
a0bc2cfeab ActualQL Examples
Examples on how to use ActualQL and a re-arrangement of the sidebar, this resolves #16
2022-10-21 14:10:33 +01:00
Rich Howell
d143231040 Merge pull request #34 from actualbudget/Installing-Own-Machine-Install
Update your-own-machine.md
2022-10-21 09:00:29 +01:00
Rich In SQL
032c8d36c0 Update your-own-machine.md
Typo
2022-10-21 08:59:24 +01:00
Rich Howell
8cc96dfcb1 Merge pull request #32 from actualbudget/Installing-Own-Machine-Install
Local Install Docs
2022-10-21 08:51:19 +01:00
Rich In SQL
1fa70892aa Local Install Docs
Local Install Docs.
2022-10-21 08:47:02 +01:00
Rich In SQL
fb78dea5b7 2210DD Release Notes
2210DD Release Notes this resolves #28
2022-10-21 08:41:28 +01:00
Rich Howell
a5464d5c38 Merge pull request #31 from shall0pass/overview_installation_prereqs
Update overview page
2022-10-21 07:32:14 +01:00
Rich Howell
733f285277 Merge pull request #30 from shall0pass/joint_accounts
Joint accounts
2022-10-21 07:30:32 +01:00
shall0pass
8b9a4c0101 Update overview page 2022-10-20 18:53:29 -05:00
shall0pass
041c1c3a09 fixup 2022-10-20 18:27:27 -05:00
shall0pass
4e645ada72 Intial commit 2022-10-20 16:25:54 -05:00
Rich In SQL
b4952e25ff Update overview.md
Updated overview
2022-10-20 18:51:59 +01:00
Rich In SQL
c63a587751 Update Docker.md
Formatting fixes
2022-10-20 18:43:20 +01:00
Rich In SQL
3ad0249ef0 Update Docker.md
Broken link fix
2022-10-20 18:39:51 +01:00
Rich In SQL
c50bcd87e6 Update Docker.md
Docker Tags, this resolves #27
2022-10-20 18:36:36 +01:00
Rich Howell
b2f888985f Update stale.yml 2022-10-19 19:13:04 +01:00
Rich Howell
aeda7972fd Create stale.yml 2022-10-19 19:12:51 +01:00
Rich Howell
1649a6106d Merge pull request #23 from actualbudget/releasing-docs
Releasing docs
2022-10-18 18:20:43 +01:00
Rich Howell
a6abfceb16 Merge pull request #21 from actualbudget/installation-overview
Installation Overview
2022-10-18 18:20:28 +01:00
Rich In SQL
14d9afc768 Releasing Documentation
Migrating releasing
2022-10-18 18:19:25 +01:00
Rich In SQL
38f50ced4d Installation Overview
Pre Requisites & Unsupported services
2022-10-18 18:13:37 +01:00
Rich Howell
095f10695e Merge pull request #18 from shall0pass/Schedules_cleanup
Added line breaks, typo correction
2022-10-18 17:15:00 +01:00
shall0pass
ae016a3e68 Added line breaks, typo correction 2022-10-18 11:02:29 -05:00
Rich In SQL
1903030b16 Update FAQ.md
Broken links
2022-10-17 19:37:05 +01:00
Rich Howell
1f78a5580b Merge pull request #9 from j-f1/separate-install
Separate cloud/local install docs
2022-10-17 18:38:46 +01:00
Rich Howell
2973ae8774 Merge pull request #10 from shall0pass/master
Update .gitignore
2022-10-17 17:36:32 +01:00
shall0pass
0d0629b062 Update .gitignore 2022-10-17 11:28:50 -05:00
Rich In SQL
69771af24d Update .gitignore 2022-10-17 16:52:29 +01:00
Rich Howell
8d6c2bb1bc Delete node_modules directory 2022-10-17 16:49:33 +01:00
Jed Fox
6855d2c73d s/Hardware/Server/ 2022-10-16 17:27:13 -04:00
Jed Fox
3af29d86d5 Remove ignored files 2022-10-16 17:26:55 -04:00
Jed Fox
56672de436 Separate cloud/local install docs 2022-10-16 17:23:06 -04:00
Rich In SQL
8af9df42a0 Init
Init
2022-10-16 21:00:07 +01:00
Rich In SQL
869f751968 Update docusaurus.config.js 2022-10-16 20:51:40 +01:00
Rich In SQL
423c3132ab Update docusaurus.config.js
Config update
2022-10-16 20:49:03 +01:00
Rich In SQL
3e3417a67b Update deploy.yml
Changed main to master
2022-10-16 20:45:15 +01:00
Rich In SQL
09e04d6784 Update addaccount.md 2022-10-16 20:44:26 +01:00
Rich Howell
0c90ecf4e2 Merge pull request #2 from rich-howell/master
Initial Commit
2022-10-16 20:39:53 +01:00
Rich In SQL
3f3b70920d Init Commit 2022-10-16 20:32:57 +01:00
Rich In SQL
28d4ee94dd Init 2022-10-16 20:28:33 +01:00
James Long
66c7ea2155 Fix code 2019-08-02 15:39:39 -04:00
James Long
57da2a3c82 Fix code 2019-08-02 15:39:03 -04:00
James Long
6f9ceea363 Add some test data 2019-08-01 13:53:08 -04:00
James Long
8d4317fa85 initial 2019-08-01 11:13:52 -04:00
1142 changed files with 44058 additions and 6270 deletions

View File

@@ -0,0 +1,69 @@
name: 'Documentation'
description: Report documentation issues, request new documentation, or suggest improvements to existing docs.
title: '[Docs] - <title>'
labels: ['documentation']
body:
- type: dropdown
id: issue-type
attributes:
label: 'Issue Type'
description: What type of documentation issue is this?
options:
- New Documentation Request
- Documentation Improvement
- Documentation Bug/Error
- Documentation Change Request
validations:
required: true
- type: textarea
id: description
attributes:
label: 'Description'
description: Please describe the documentation issue, request, or improvement
placeholder: Provide a clear and detailed description...
validations:
required: true
- type: input
id: doc-url
attributes:
label: 'Documentation URL'
description: If this relates to existing documentation, please provide the URL
placeholder: ex. https://actualbudget.org/docs/budgeting/categories or https://github.com/actualbudget/actual/blob/master/packages/docs/...
validations:
required: false
- type: dropdown
id: category
attributes:
label: 'Documentation Category'
description: What category does this relate to?
multiple: true
options:
- Accounts
- Backup & Restore
- Budgeting
- Development
- Installation & Configuration
- Overview
- Reports
- Troubleshooting
- Other
validations:
required: false
- type: textarea
id: expected-behavior
attributes:
label: 'Expected/Desired Content'
description: If applicable, describe what you expect to see or what should be documented
placeholder: What should the documentation say or include?
validations:
required: false
- type: textarea
id: screenshot
attributes:
label: 'Screenshots or Examples'
description: If applicable, add screenshots or examples to help explain your request
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false

17
.github/actions/docs-spelling/README.md vendored Normal file
View File

@@ -0,0 +1,17 @@
# check-spelling/check-spelling configuration
| File | Purpose | Format | Info |
| -------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| [dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary) |
| [allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow) |
| [reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject) |
| [excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) |
| [only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only) |
| [patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
| [candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns) |
| [line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
| [expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) |
| [advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice) |
Note: you can replace any of these files with a directory by the same name (minus the suffix)
and then include multiple files inside that directory (with that suffix) to merge multiple files together.

24
.github/actions/docs-spelling/advice.md vendored Normal file
View File

@@ -0,0 +1,24 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details>
<summary>If the flagged items are :exploding_head: false positives</summary>
If items relate to a ...
- binary file (or some other file you wouldn't want to check at all).
Please add a file path to the `excludes.txt` file matching the containing file.
File paths are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](../tree/HEAD/README.md) (on whichever branch you're using).
- well-formed pattern.
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.
Patterns are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
</details>

View File

@@ -0,0 +1,8 @@
trevdor
Farlow
Matiss
Aboltins
jlongster
howell
evequefou
Fiddaman

View File

@@ -0,0 +1,144 @@
ABANCA
actualbudget
addtransactions
Akahu
AMZN
Andelskassen
AQL
Authelia
autocompletes
Blix
bnp
BSCHESMM
BTC
CAGLESMM
Caju
caniuse
Cardless
CAROOT
categorygroup
Cembra
Certbot
CLI
clickable
clsx
codemirror
Coinbase
commandlet
Coverflex
Crd
crdt
creditcards
crowdsourced
debian
dedupes
deleteaccount
DKB
dmg
easybank
Edenred
Coverfelx
emojis
emoji
escodegen
EUR
expando
Firefox
flyctl
Formik
Fortuneo
gebabebb
GEBABEBB
Greenshot
HSA
htpasswd
IBANs
iex
importtransactions
ING
invokable
iwr
jointaccounts
jwl
KBC
kcab
keyout
KREDBEBB
Kroger
kubectl
kubernetes
ldaplogin
letsencrypt
libofx
linting
Linuxes
linuxsvg
lleskassen
lte
mac
macsvg
Mariushosting
minimalistic
monkeypatch
Monobank
Morrisons
NAIAGB
NDEADKKK
Netflix
netlify
Nordea
NORDEA
nordigen
notlike
NRNBGB
nynab
offbudget
ofx
OFX
oneof
payeerule
pikaday
pikapods
playsinline
portalization
Postgresql
protobuf
publix
QFX
QIF
Quicken
returnsandreimbursements
Rezip
roadmap
RUpdate
sankey
SANTANDER
screenshots
SEB
subfolders
subreaper
subtransaction
subtransactions
Suisse
Sztup
tini
traefik
Trafico
Trumf
Upstash
useb
usernames
valign
Venmo
Weblate
winsvg
WSL
Xxxxx
ynab
Ynab
YNAB
ZKB
Zsolt
IDBy
isapprox
isbetween

View File

@@ -0,0 +1,76 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)3rdparty/
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)pyproject.toml
(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$
(?:^|/)vendor/
ignore$
\.a$
\.ai$
\.avi$
\.bmp$
\.bz2$
\.class$
\.coveragerc$
\.crt$
\.css$
\.dll$
\.docx?$
\.drawio$
\.DS_Store$
\.eot$
\.exe$
\.gif$
\.git-blame-ignore-revs$
\.gitattributes$
\.graffle$
\.gz$
\.icns$
\.ico$
\.jar$
\.jks$
\.jpe?g$
\.key$
\.lib$
\.lock$
\.map$
\.min\..
\.mod$
\.mp[34]$
\.o$
\.ocf$
\.otf$
\.pdf$
\.pem$
\.png$
\.psd$
\.pyc$
\.pylintrc$
\.s$
\.svgz?$
\.tar$
\.tiff?$
\.ttf$
\.wav$
\.webm$
\.webp$
\.woff2?$
\.xlsx?$
\.zip$
^\.github/actions/spelling/
^\.github/ISSUE_TEMPLATE/
^\Q.github/workflows/spelling.yml\E$
^\.yarn/
^\Qnode_modules/\E$
^\Qsrc/\E$
^\Qstatic/\E$
^\Q.github/\E$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)yarn\.lock$
(?:^|/)(?i)docusaurus.config.js
(?:^|/)(?i)README.md
^\static/
\.tsx$

152
.github/actions/docs-spelling/expect.txt vendored Normal file
View File

@@ -0,0 +1,152 @@
Abanca
ABNAMRO
ABNANL
Activo
AESUDEF
ALZEY
Anglais
aql
AUR
Authentik
BANKA
BANKINTER
BAWAATWW
Belfius
Biedenkopf
BIGBPLPW
Bizum
BKBKESMM
BOFIIE
Bourso
Boursobank
Boursorama
BPER
BPMOIT
brexplpw
BYLADEM
Caddyfile
CAGLPTPL
Caixa
CAMT
cashflow
Cetelem
cimode
Citi
Citibank
Cloudflare
CMCIFRPAXXX
COBADEFF
CODEOWNERS
commerzbank
Copiar
CREGBEBB
crt
Danske
datadir
Depositos
DIREKT
Dockerfiles
Dominguez
DUSSDEDDXXX
DUSSELDORF
ENTERCARD
Entra
EUA
Eurocard
fidd
Fineco
Finicity
Fintro
Finverse
Flathub
FORTUNEO
FTNOFRP
Gemeinschaftsbank
Geral
gernes
Globecard
GLS
gocardless
Grafana
HABAL
Hampel
HELADEF
INDUSTRIEL
INGBPLPW
Ingo
INR
Intesa
INVSTMTMSGSRS
ISYBANK
ITBBITMM
jfdoming
JMD
KBCBE
Keycloak
Khurozov
KORT
Kreditbank
lage
LHV
LHVBEE
LKR
mbank
mdc
modals
Moldovan
murmurhash
nginx
OIDC
overbudgeted
overbudgeting
Paribas
passwordless
pluggyai
Poste
PPABPLPK
prefs
Primoco
Priotecs
proactively
pwa
Qatari
QNTOFRP
QONTO
Raiffeisen
revolut
RIED
RSchedule
RSD
SEK
simplefin
SKHSFI
Sparkasse
SPK
sseldorf
SSK
Stadtsparkasse
statestore
SUBASKBX
SVGR
swc
SWEDBANK
SWEDNOKK
Synology
systemctl
tada
taskbar
templating
THB
touchscreen
triaging
UAH
ubuntu
userinfo
Userscripts
UZS
vrt
VUB
websecure
Widiba
WOR
youngcw

View File

@@ -0,0 +1,62 @@
# reject `m_data` as there's a certain OS which has evil defines that break things if it's used elsewhere
# \bm_data\b
# If you have a framework that uses `it()` for testing and `fit()` for debugging a specific test,
# you might not want to check in code where you were debugging w/ `fit()`, in which case, you might want
# to use this:
#\bfit\(
# s.b. GitHub
#\bGithub\b
# s.b. GitLab
\bGitlab\b
# s.b. JavaScript
\bJavascript\b
# s.b. Microsoft
\bMicroSoft\b
# s.b. another
\ban[- ]other\b
# s.b. greater than
\bgreater then\b
# s.b. into
#\sin to\s
# s.b. opt-in
\sopt in\s
# s.b. less than
\bless then\b
# s.b. otherwise
\bother[- ]wise\b
# s.b. nonexistent
\bnon existing\b
\b[Nn]o[nt][- ]existent\b
# s.b. preexisting
[Pp]re[- ]existing
# s.b. preempt
[Pp]re[- ]empt\b
# s.b. preemptively
[Pp]re[- ]emptively
# s.b. reentrancy
[Rr]e[- ]entrancy
# s.b. reentrant
[Rr]e[- ]entrant
# s.b. workaround(s)
\bwork[- ]arounds?\b
# Reject duplicate words
\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s

View File

@@ -0,0 +1,3 @@
# Only check files in the packages/docs directory
^packages/docs/

View File

@@ -0,0 +1,81 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
# Questionably acceptable forms of `in to`
# Personally, I prefer `log into`, but people object
# https://www.tprteaching.com/log-into-log-in-to-login/
\b[Ll]og in to\b
# acceptable duplicates
# ls directory listings
[-bcdlpsw](?:[-r][-w][-Ssx]){3}\s+\d+\s+\S+\s+\S+\s+\d+\s+
# C types and repeated CSS values
\s(center|div|inherit|long|LONG|none|normal|solid|thin|transparent|very)(?: \g{-1})+\s
# go templates
\s(\w+)\s+\g{-1}\s+\`(?:graphql|json|yaml):
# javadoc / .net
(?:[\\@](?:groupname|param)|(?:public|private)(?:\s+static|\s+readonly)*)\s+(\w+)\s+\g{-1}\s
# Commit message -- Signed-off-by and friends
^\s*(?:(?:Based-on-patch|Co-authored|Helped|Mentored|Reported|Reviewed|Signed-off)-by|Thanks-to): (?:[^<]*<[^>]*>|[^<]*)\s*$
# Autogenerated revert commit message
^This reverts commit [0-9a-f]{40}\.$
# ignore long runs of a single character:
\b([A-Za-z])\g{-1}{3,}\b
# Automatically suggested patterns
# hit-count: 1255 file-count: 51
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]
# hit-count: 1174 file-count: 33
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
# hit-count: 6 file-count: 4
# version suffix <word>v#
(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))
# hit-count: 6 file-count: 2
# URL escaped characters
\%[0-9A-F][A-F]
# hit-count: 5 file-count: 4
# hex runs
\b[0-9a-fA-F]{16,}\b
# hit-count: 4 file-count: 2
# uuid:
\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b
# hit-count: 3 file-count: 2
# discord
/discord(?:app\.com|\.gg)/(?:invite/)?[a-zA-Z0-9]{7,}
# hit-count: 2 file-count: 2
# Contributor
\[[^\]]+\]\(https://github\.com/[^/\s"]+\)
@[^$\W]*-?\w+
# hit-count: 1 file-count: 1
# While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there
# YouTube url
\b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]*
# hit-count: 1 file-count: 1
# Google Fonts
\bfonts\.(?:googleapis|gstatic)\.com/[-/?=:;+&0-9a-zA-Z]*
# hit-count: 1 file-count: 1
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b
# docusaurus image paths, URLs
[-a-zA-Z0-9@:%_\+.~#?&//=]{2,256}\.[a-z]{2,4}\b(\/[-a-zA-Z0-9@:%_\+.~#?&//=]*)?
# eliminate words like [`nvm`] or [`asdf`] or [heidiSQL] without backquotes
\[.+?]
# allowlist specific non-English words with non-ASCII characters
\b(Länsförsäkringar|München|Złoty)\b

View File

@@ -0,0 +1,10 @@
^attache$
benefitting
occurences?
^dependan.*
^oer$
Sorce
^[Ss]pae.*
^untill$
^untilling$
^wether.*

View File

@@ -15,7 +15,7 @@ runs:
using: composite
steps:
- name: Install node
uses: actions/setup-node@v4
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
with:
node-version: 22
- name: Install yarn
@@ -27,7 +27,7 @@ runs:
run: echo "version=$(node -v)" >> "$GITHUB_OUTPUT"
shell: bash
- name: Cache
uses: actions/cache@v4
uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
id: cache
with:
path: ${{ format('{0}/**/node_modules', inputs.working-directory) }}
@@ -36,7 +36,7 @@ runs:
run: mkdir -p ${{ format('{0}/.lage', inputs.working-directory) }}
shell: bash
- name: Cache Lage
uses: actions/cache@v4
uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
with:
path: ${{ format('{0}/.lage', inputs.working-directory) }}
key: lage-${{ runner.os }}-${{ github.sha }}
@@ -48,7 +48,7 @@ runs:
shell: bash
if: steps.cache.outputs.cache-hit != 'true'
- name: Download translations
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
repository: actualbudget/translations
path: ${{ inputs.working-directory }}/packages/desktop-client/locale

View File

@@ -4,43 +4,32 @@ import pLimit from 'p-limit';
const limit = pLimit(50);
/** Repository-specific configuration for points calculation */
const REPOSITORY_CONFIG = new Map([
[
'actual',
{
POINTS_PER_ISSUE_TRIAGE_ACTION: 1,
POINTS_PER_ISSUE_CLOSING_ACTION: 1,
POINTS_PER_RELEASE_PR: 0,
PR_REVIEW_POINT_TIERS: [
{ minChanges: 500, points: 8 },
{ minChanges: 100, points: 6 },
{ minChanges: 10, points: 2 },
{ minChanges: 0, points: 1 },
],
EXCLUDED_FILES: [
'yarn.lock',
'.yarn/**/*',
'packages/component-library/src/icons/**/*',
'release-notes/**/*',
],
},
const CONFIG = {
POINTS_PER_ISSUE_TRIAGE_ACTION: 1,
POINTS_PER_ISSUE_CLOSING_ACTION: 1,
POINTS_PER_RELEASE_PR: 4, // Awarded to whoever merges the release PR
// Point tiers for code changes (non-docs)
CODE_PR_REVIEW_POINT_TIERS: [
{ minChanges: 500, points: 8 },
{ minChanges: 100, points: 6 },
{ minChanges: 10, points: 2 },
{ minChanges: 0, points: 1 },
],
[
'docs',
{
POINTS_PER_ISSUE_TRIAGE_ACTION: 1,
POINTS_PER_ISSUE_CLOSING_ACTION: 1,
POINTS_PER_RELEASE_PR: 4,
PR_REVIEW_POINT_TIERS: [
{ minChanges: 2000, points: 6 },
{ minChanges: 200, points: 4 },
{ minChanges: 0, points: 2 },
],
EXCLUDED_FILES: ['yarn.lock', '.yarn/**/*'],
},
// Point tiers for docs changes (packages/docs/**)
DOCS_PR_REVIEW_POINT_TIERS: [
{ minChanges: 2000, points: 6 },
{ minChanges: 200, points: 4 },
{ minChanges: 0, points: 2 },
],
]);
EXCLUDED_FILES: [
'yarn.lock',
'.yarn/**/*',
'packages/component-library/src/icons/**/*',
'release-notes/**/*',
'upcoming-release-notes/**/*',
],
DOCS_FILES_PATTERN: 'packages/docs/**/*',
};
/**
* Get the start and end dates for the last month.
@@ -76,15 +65,14 @@ function getLastMonthDates() {
/**
* Used for calculating the monthly points each core contributor has earned.
* These are used for payouts depending.
* @param {string} repo - The repository to analyze ('actual' or 'docs')
* @returns {number} The total points earned for the repository
* @returns {Map} A map of contributor logins to their total points earned
*/
async function countContributorPoints(repo) {
async function countContributorPoints() {
const octokit = new Octokit({
auth: process.env.GITHUB_TOKEN,
});
const owner = 'actualbudget';
const config = REPOSITORY_CONFIG.get(repo);
const repo = 'actual';
const { since, until } = getLastMonthDates();
@@ -99,7 +87,8 @@ async function countContributorPoints(repo) {
Array.from(orgMemberLogins).map(login => [
login,
{
reviews: [], // Will store objects with PR number and points
codeReviews: [], // Will store objects with PR number and points for main repo changes
docsReviews: [], // Will store objects with PR number and points for docs changes
labelRemovals: [],
issueClosings: [],
points: 0,
@@ -156,48 +145,91 @@ async function countContributorPoints(repo) {
),
]);
const totalChanges = modifiedFiles
.filter(
file =>
!config.EXCLUDED_FILES.some(pattern =>
minimatch(file.filename, pattern),
),
)
.reduce((sum, file) => sum + file.additions + file.deletions, 0);
const filteredFiles = modifiedFiles.filter(
file =>
!CONFIG.EXCLUDED_FILES.some(pattern =>
minimatch(file.filename, pattern, { dot: true }),
),
);
const docsFiles = filteredFiles.filter(file =>
minimatch(file.filename, CONFIG.DOCS_FILES_PATTERN, { dot: true }),
);
const codeFiles = filteredFiles.filter(
file =>
!minimatch(file.filename, CONFIG.DOCS_FILES_PATTERN, { dot: true }),
);
const docsChanges = docsFiles.reduce(
(sum, file) => sum + file.additions + file.deletions,
0,
);
const codeChanges = codeFiles.reduce(
(sum, file) => sum + file.additions + file.deletions,
0,
);
const docsPoints =
docsChanges > 0
? (CONFIG.DOCS_PR_REVIEW_POINT_TIERS.find(
t => docsChanges >= t.minChanges,
)?.points ?? 0)
: 0;
const codePoints =
codeChanges > 0 || docsChanges === 0
? (CONFIG.CODE_PR_REVIEW_POINT_TIERS.find(
t => codeChanges >= t.minChanges,
)?.points ?? 0)
: 0;
const isReleasePR = pr.title.match(/🔖.*\d+\.\d+\.\d+/);
const prPoints =
config.PR_REVIEW_POINT_TIERS.find(t => totalChanges >= t.minChanges)
?.points ?? 0;
if (isReleasePR) {
if (stats.has(pr.user.login)) {
const creatorStats = stats.get(pr.user.login);
creatorStats.reviews.push({
// release PRs are created by the github-actions bot so we attribute points to the merger
const { data: prDetails } = await octokit.pulls.get({
owner,
repo,
pull_number: pr.number,
});
if (prDetails.merged_by && stats.has(prDetails.merged_by.login)) {
const mergerStats = stats.get(prDetails.merged_by.login);
mergerStats.codeReviews.push({
pr: pr.number.toString(),
points: config.POINTS_PER_RELEASE_PR,
isReleaseCreator: true,
points: CONFIG.POINTS_PER_RELEASE_PR,
isReleaseMerger: true,
});
creatorStats.points += config.POINTS_PER_RELEASE_PR;
mergerStats.points += CONFIG.POINTS_PER_RELEASE_PR;
}
} else {
const uniqueReviewers = new Set();
reviews.data
.filter(
review =>
stats.has(review.user?.login) &&
review.state === 'APPROVED' &&
!uniqueReviewers.has(review.user?.login),
)
.forEach(({ user: { login: reviewer } }) => {
reviews.data.forEach(review => {
if (
review.state === 'APPROVED' &&
stats.has(review.user?.login) &&
!uniqueReviewers.has(review.user?.login)
) {
const reviewer = review.user.login;
uniqueReviewers.add(reviewer);
const userStats = stats.get(reviewer);
userStats.reviews.push({
pr: pr.number.toString(),
points: prPoints,
});
userStats.points += prPoints;
});
if (docsPoints > 0) {
userStats.docsReviews.push({
pr: pr.number.toString(),
points: docsPoints,
});
userStats.points += docsPoints;
}
if (codePoints > 0) {
userStats.codeReviews.push({
pr: pr.number.toString(),
points: codePoints,
});
userStats.points += codePoints;
}
}
});
}
}),
),
@@ -241,7 +273,7 @@ async function countContributorPoints(repo) {
const remover = event.actor.login;
const userStats = stats.get(remover);
userStats.labelRemovals.push(issue.number.toString());
userStats.points += config.POINTS_PER_ISSUE_TRIAGE_ACTION;
userStats.points += CONFIG.POINTS_PER_ISSUE_TRIAGE_ACTION;
}
if (
@@ -251,7 +283,7 @@ async function countContributorPoints(repo) {
const closer = event.actor.login;
const userStats = stats.get(closer);
userStats.issueClosings.push(issue.number.toString());
userStats.points += config.POINTS_PER_ISSUE_CLOSING_ACTION;
userStats.points += CONFIG.POINTS_PER_ISSUE_CLOSING_ACTION;
}
});
}),
@@ -260,27 +292,39 @@ async function countContributorPoints(repo) {
// Print all statistics
printStats(
`PR Review Statistics (${repo})`,
stats => stats.reviews.length,
'Code Review Statistics',
stats => stats.codeReviews.length,
(user, count) =>
`${user}: ${count} (PRs: ${stats
.get(user)
.reviews.map(r => {
if (r.isReleaseCreator) {
return `#${r.pr} (${r.points}pts - Release Creator)`;
.codeReviews.map(r => {
if (r.isReleaseMerger) {
return `#${r.pr} (${r.points}pts - Release Merger)`;
}
return `#${r.pr} (${r.points}pts)`;
})
.join(', ')})`,
);
printStats(
`"Needs Triage" Label Removal Statistics (${repo})`,
'Docs Review Statistics',
stats => stats.docsReviews.length,
(user, count) =>
`${user}: ${count} (PRs: ${stats
.get(user)
.docsReviews.map(r => `#${r.pr} (${r.points}pts)`)
.join(', ')})`,
);
printStats(
'"Needs Triage" Label Removal Statistics',
stats => stats.labelRemovals.length,
(user, count) =>
`${user}: ${count} (Issues: ${stats.get(user).labelRemovals.join(', ')})`,
);
printStats(
`Issue Closing Statistics (${repo})`,
'Issue Closing Statistics',
stats => stats.issueClosings.length,
(user, count) =>
`${user}: ${count} (Issues: ${stats.get(user).issueClosings.join(', ')})`,
@@ -288,7 +332,7 @@ async function countContributorPoints(repo) {
// Print points summary
printStats(
`Points Summary (${repo})`,
'Points Summary',
stats => stats.points,
(user, userPoints) => `${user}: ${userPoints}`,
);
@@ -298,7 +342,7 @@ async function countContributorPoints(repo) {
(sum, userStats) => sum + userStats.points,
0,
);
console.log(`\nTotal points earned for ${repo}: ${totalPoints}`);
console.log(`\nTotal points earned: ${totalPoints}`);
// Return the points
return new Map(
@@ -309,55 +353,5 @@ async function countContributorPoints(repo) {
);
}
/**
* Calculate the points for both repositories and print cumulative results
*/
async function calculateCumulativePoints() {
// Get stats for each repository
const repoPointsResults = await Promise.all(
Array.from(REPOSITORY_CONFIG.keys()).map(countContributorPoints),
);
// Calculate cumulative stats
const cumulativeStats = new Map(repoPointsResults[0]);
// Combine stats from all repositories
for (let i = 1; i < repoPointsResults.length; i++) {
for (const [login, points] of repoPointsResults[i].entries()) {
if (!cumulativeStats.has(login)) {
cumulativeStats.set(login, 0);
}
cumulativeStats.set(login, cumulativeStats.get(login) + points);
}
}
// Print cumulative statistics
console.log('\n\nCUMULATIVE STATISTICS ACROSS ALL REPOSITORIES');
console.log('='.repeat(50));
console.log('\nCumulative Points Summary:');
console.log('='.repeat('Cumulative Points Summary'.length + 1));
const entries = Array.from(cumulativeStats.entries())
.filter(([, count]) => count > 0)
.sort((a, b) => b[1] - a[1]);
if (entries.length === 0) {
console.log('No cumulative points summary found.');
} else {
entries.forEach(([user, points]) => {
console.log(`${user}: ${points}`);
});
}
// Calculate and print total cumulative points
const totalCumulativePoints = Array.from(cumulativeStats.values()).reduce(
(sum, points) => sum + points,
0,
);
console.log('\nTotal cumulative points earned: ' + totalCumulativePoints);
}
// Run the calculations
calculateCumulativePoints().catch(console.error);
countContributorPoints().catch(console.error);

View File

@@ -17,7 +17,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup

View File

@@ -15,7 +15,7 @@ jobs:
autofix:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
- name: Format code

View File

@@ -12,6 +12,7 @@ on:
branches:
- master
pull_request:
merge_group:
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -21,7 +22,7 @@ jobs:
api:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
with:
@@ -30,16 +31,23 @@ jobs:
run: cd packages/api && yarn build
- name: Create package tgz
run: cd packages/api && yarn pack && mv package.tgz actual-api.tgz
- name: Prepare bundle stats artifact
run: cp packages/api/app/stats.json api-stats.json
- name: Upload Build
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-api
path: packages/api/actual-api.tgz
- name: Upload API bundle stats
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: api-build-stats
path: api-stats.json
crdt:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
with:
@@ -49,7 +57,7 @@ jobs:
- name: Create package tgz
run: cd packages/crdt && yarn pack && mv package.tgz actual-crdt.tgz
- name: Upload Build
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-crdt
path: packages/crdt/actual-crdt.tgz
@@ -57,18 +65,18 @@ jobs:
web:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
- name: Build Web
run: yarn build:browser
- name: Upload Build
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-web
path: packages/desktop-client/build
- name: Upload Build Stats
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: build-stats
path: packages/desktop-client/build-stats
@@ -76,7 +84,7 @@ jobs:
server:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
with:
@@ -84,7 +92,7 @@ jobs:
- name: Build Server
run: yarn workspace @actual-app/sync-server build
- name: Upload Build
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: sync-server
path: packages/sync-server/build

View File

@@ -5,6 +5,7 @@ on:
branches:
- master
pull_request:
merge_group:
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -14,7 +15,7 @@ jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
with:
@@ -24,7 +25,7 @@ jobs:
typecheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
with:
@@ -34,7 +35,7 @@ jobs:
validate-cli:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
with:
@@ -46,7 +47,7 @@ jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
with:
@@ -58,8 +59,8 @@ jobs:
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
with:
node-version: 22
- name: Check migrations

View File

@@ -22,7 +22,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Initialize CodeQL
uses: github/codeql-action/init@v3

View File

@@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
- name: Count points

View File

@@ -36,17 +36,17 @@ jobs:
matrix:
os: [ubuntu, alpine]
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
- name: Docker meta
id: meta
uses: docker/metadata-action@v5
uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # v5.9.0
with:
# Push to both Docker Hub and Github Container Registry
images: ${{ env.IMAGES }}
@@ -54,14 +54,14 @@ jobs:
tags: ${{ env.TAGS }}
- name: Login to Docker Hub
uses: docker/login-action@v3
uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
if: github.event_name != 'pull_request' && !github.event.repository.fork
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
if: github.event_name != 'pull_request'
with:
registry: ghcr.io
@@ -76,7 +76,7 @@ jobs:
run: yarn build:server
- name: Build image for testing
uses: docker/build-push-action@v5
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
with:
context: .
push: false
@@ -93,7 +93,7 @@ jobs:
# This will use the cache from the earlier build step and not rebuild the image
# https://docs.docker.com/build/ci/github-actions/test-before-push/
- name: Build and push images
uses: docker/build-push-action@v5
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
with:
context: .
push: ${{ github.event_name != 'pull_request' }}

View File

@@ -28,17 +28,17 @@ jobs:
name: Build Docker image
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
- name: Docker meta
id: meta
uses: docker/metadata-action@v5
uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # v5.9.0
with:
# Push to both Docker Hub and Github Container Registry
images: ${{ env.IMAGES }}
@@ -48,7 +48,7 @@ jobs:
- name: Docker meta for Alpine image
id: alpine-meta
uses: docker/metadata-action@v5
uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # v5.9.0
with:
images: ${{ env.IMAGES }}
# Automatically update :latest
@@ -58,13 +58,13 @@ jobs:
tags: ${{ env.TAGS }}
- name: Login to Docker Hub
uses: docker/login-action@v3
uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
@@ -78,7 +78,7 @@ jobs:
run: yarn build:server
- name: Build and push ubuntu image
uses: docker/build-push-action@v5
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
with:
context: .
push: true
@@ -87,7 +87,7 @@ jobs:
tags: ${{ steps.meta.outputs.tags }}
- name: Build and push alpine image
uses: docker/build-push-action@v5
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
with:
context: .
push: true

164
.github/workflows/docs-spelling.yml vendored Normal file
View File

@@ -0,0 +1,164 @@
name: Check Spelling (Docs)
# Comment management is handled through a secondary job, for details see:
# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions
#
# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment
# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare)
# it needs `contents: write` in order to add a comment.
#
# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment
# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment)
# it needs `pull-requests: write` in order to manipulate those comments.
# Updating pull request branches is managed via comment handling.
# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list
#
# These elements work together to make it happen:
#
# `on.issue_comment`
# This event listens to comments by users asking to update the metadata.
#
# `jobs.update`
# This job runs in response to an issue_comment and will push a new commit
# to update the spelling metadata.
#
# `with.experimental_apply_changes_via_bot`
# Tells the action to support and generate messages that enable it
# to make a commit to update the spelling metadata.
#
# `with.ssh_key`
# In order to trigger workflows when the commit is made, you can provide a
# secret (typically, a write-enabled github deploy key).
#
# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key
on:
push:
branches:
- '**'
tags-ignore:
- '**'
paths:
- 'packages/docs/**'
- '.github/workflows/docs-spelling.yml'
- '.github/actions/docs-spelling/**'
pull_request_target:
branches:
- '**'
tags-ignore:
- '**'
paths:
- 'packages/docs/**'
- '.github/workflows/docs-spelling.yml'
- '.github/actions/docs-spelling/**'
types:
- 'opened'
- 'reopened'
- 'synchronize'
issue_comment:
types:
- 'created'
jobs:
spelling:
name: Check Spelling
permissions:
contents: read
pull-requests: read
actions: read
security-events: write
outputs:
followup: ${{ steps.spelling.outputs.followup }}
runs-on: ubuntu-latest
if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
concurrency:
group: spelling-${{ github.event.pull_request.number || github.ref }}
# note: If you use only_check_changed_files, you do not want cancel-in-progress
cancel-in-progress: true
steps:
- name: check-spelling
id: spelling
uses: check-spelling/check-spelling@main
with:
suppress_push_for_open_pull_request: 1
checkout: true
check_file_names: 1
spell_check_this: check-spelling/spell-check-this@prerelease
post_comment: 0
use_magic_file: 1
experimental_apply_changes_via_bot: 1
use_sarif: 1
extra_dictionary_limit: 12
check_extra_dictionaries: ''
extra_dictionaries: cspell:cpp/src/cpp.txt
cspell:software-terms/src/software-terms.txt
cspell:python/src/python/python-lib.txt
cspell:node/node.txt
cspell:filetypes/filetypes.txt
cspell:aws/aws.txt
cspell:typescript/dict/typescript.txt
cspell:npm/dict/npm.txt
cspell:fullstack/dict/fullstack.txt
cspell:html/dict/html.txt
cspell:css/dict/css.txt
config: .github/actions/docs-spelling
comment-push:
name: Report (Push)
# If your workflow isn't running on push, you can remove this job
runs-on: ubuntu-latest
needs: spelling
permissions:
contents: write
if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push'
steps:
- name: comment
uses: check-spelling/check-spelling@main
with:
checkout: true
spell_check_this: check-spelling/spell-check-this@prerelease
task: ${{ needs.spelling.outputs.followup }}
config: .github/actions/docs-spelling
comment-pr:
name: Report (PR)
# If you workflow isn't running on pull_request*, you can remove this job
runs-on: ubuntu-latest
needs: spelling
permissions:
pull-requests: write
if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')
steps:
- name: comment
uses: check-spelling/check-spelling@main
with:
checkout: true
spell_check_this: check-spelling/spell-check-this@prerelease
task: ${{ needs.spelling.outputs.followup }}
experimental_apply_changes_via_bot: 1
config: .github/actions/docs-spelling
update:
name: Update PR
permissions:
contents: write
pull-requests: write
actions: read
runs-on: ubuntu-latest
if: ${{
github.event_name == 'issue_comment' &&
github.event.issue.pull_request &&
contains(github.event.comment.body, '@check-spelling-bot apply')
}}
concurrency:
group: spelling-update-${{ github.event.issue.number }}
cancel-in-progress: false
steps:
- name: apply spelling updates
uses: check-spelling/check-spelling@main
with:
experimental_apply_changes_via_bot: 1
checkout: true
ssh_key: '${{ secrets.CHECK_SPELLING }}'
config: .github/actions/docs-spelling

View File

@@ -17,7 +17,7 @@ jobs:
outputs:
netlify_url: ${{ steps.netlify.outputs.url }}
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
- name: Wait for Netlify build to finish
@@ -34,7 +34,7 @@ jobs:
container:
image: mcr.microsoft.com/playwright:v1.56.0-jammy
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
- name: Trust the repository directory
@@ -43,7 +43,7 @@ jobs:
run: yarn e2e
env:
E2E_START_URL: ${{ needs.netlify.outputs.netlify_url }}
- uses: actions/upload-artifact@v4
- uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
if: always()
with:
name: desktop-client-test-results
@@ -57,7 +57,7 @@ jobs:
container:
image: mcr.microsoft.com/playwright:v1.56.0-jammy
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
- name: Trust the repository directory
@@ -65,7 +65,7 @@ jobs:
- name: Run Desktop app E2E Tests
run: |
xvfb-run --auto-servernum --server-args="-screen 0 1920x1080x24" -- yarn e2e:desktop
- uses: actions/upload-artifact@v4
- uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
if: always()
with:
name: desktop-app-test-results
@@ -80,14 +80,14 @@ jobs:
container:
image: mcr.microsoft.com/playwright:v1.56.0-jammy
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
- name: Run VRT Tests on Netlify URL
run: yarn vrt
env:
E2E_START_URL: ${{ needs.netlify.outputs.netlify_url }}
- uses: actions/upload-artifact@v4
- uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
if: always()
with:
name: desktop-client-test-results

View File

@@ -29,7 +29,7 @@ jobs:
- macos-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- if: ${{ startsWith(matrix.os, 'windows') }}
run: pip.exe install setuptools
- if: ${{ ! startsWith(matrix.os, 'windows') }}
@@ -62,7 +62,7 @@ jobs:
if: ${{ ! startsWith(matrix.os, 'macos') }}
run: ./bin/package-electron
- name: Upload Build
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-electron-${{ matrix.os }}
path: |
@@ -73,7 +73,7 @@ jobs:
packages/desktop-electron/dist/*.flatpak
- name: Upload Windows Store Build
if: ${{ startsWith(matrix.os, 'windows') }}
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-electron-${{ matrix.os }}-appx
path: |
@@ -83,7 +83,7 @@ jobs:
run: |
echo "version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
- name: Add to new release
uses: softprops/action-gh-release@v2
uses: softprops/action-gh-release@5be0e66d93ac7ed76da52eca8bb058f665c3a5fe # v2.4.2
with:
draft: true
body: |
@@ -113,7 +113,7 @@ jobs:
Install-Module -Name StoreBroker -AcceptLicense -Force -Scope CurrentUser -Verbose
- name: Download Microsoft Store artifacts
uses: actions/download-artifact@v4
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
name: actual-electron-windows-latest-appx

View File

@@ -24,7 +24,7 @@ jobs:
- macos-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- if: ${{ startsWith(matrix.os, 'windows') }}
run: pip.exe install setuptools
- if: ${{ ! startsWith(matrix.os, 'windows') }}
@@ -46,19 +46,66 @@ jobs:
uses: ./.github/actions/setup
- name: Build Electron
run: ./bin/package-electron
- name: Upload Build
uses: actions/upload-artifact@v4
- name: Upload Linux x64 AppImage
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-electron-${{ matrix.os }}
path: |
packages/desktop-electron/dist/*.dmg
packages/desktop-electron/dist/*.exe
!packages/desktop-electron/dist/Actual-windows.exe
packages/desktop-electron/dist/*.AppImage
packages/desktop-electron/dist/*.flatpak
name: Actual-linux-x86_64.AppImage
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-linux-x86_64.AppImage
- name: Upload Linux arm64 AppImage
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-linux-arm64.AppImage
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-linux-arm64.AppImage
- name: Upload Linux x64 flatpak
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-linux-x86_64.flatpak
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-linux-x86_64.flatpak
- name: Upload Windows x32 exe
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-windows-ia32.exe
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-windows-ia32.exe
- name: Upload Windows x64 exe
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-windows-x64.exe
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-windows-x64.exe
- name: Upload Windows arm64 exe
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-windows-arm64.exe
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-windows-arm64.exe
- name: Upload Mac x64 dmg
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-mac-x64.dmg
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-mac-x64.dmg
- name: Upload Mac arm64 dmg
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-mac-arm64.dmg
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-mac-arm64.dmg
- name: Upload Windows Store Build
if: ${{ startsWith(matrix.os, 'windows') }}
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-electron-${{ matrix.os }}-appx
path: |

View File

@@ -17,7 +17,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
ref: ${{ github.event.inputs.ref }}
- name: Bump package versions
@@ -48,7 +48,7 @@ jobs:
echo "version=$NEW_WEB_VERSION" >> "$GITHUB_OUTPUT"
- name: Create PR
uses: peter-evans/create-pull-request@v7
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
with:
commit-message: '🔖 (${{ steps.bump_package_versions.outputs.version }})'
title: '🔖 (${{ steps.bump_package_versions.outputs.version }})'

View File

@@ -12,7 +12,7 @@ jobs:
if: github.repository == 'actualbudget/actual'
steps:
- name: Check out main repository
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
path: actual
- name: Set up environment
@@ -44,7 +44,7 @@ jobs:
push \
actualbudget/actual
- name: Check out updated translations
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
ssh-key: ${{ secrets.STRING_IMPORT_DEPLOY_KEY }}
repository: actualbudget/translations

View File

@@ -9,16 +9,17 @@ jobs:
if: ${{ github.event.label.name == 'feature' }}
runs-on: ubuntu-latest
steps:
- uses: actions-ecosystem/action-add-labels@v1
- uses: actions-ecosystem/action-add-labels@bd52874380e3909a1ac983768df6976535ece7f8 # v1.1.0
with:
labels: needs votes
github_token: ${{ secrets.GITHUB_TOKEN }}
- name: Add reactions
uses: aidan-mundy/react-to-issue@v1.1.1
uses: aidan-mundy/react-to-issue@109392cac5159c2df6c47c8ab3b5d6b708852fe5 # v1.1.2
with:
issue-number: ${{ github.event.issue.number }}
reactions: '+1'
- name: Create comment
uses: peter-evans/create-or-update-comment@v3
uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
with:
issue-number: ${{ github.event.issue.number }}
body: |

View File

@@ -24,8 +24,8 @@ jobs:
runs-on: ubuntu-latest
steps:
# This is not a security concern because we have approved & merged the PR
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
with:
node-version: 22
- name: Handle feature requests

View File

@@ -9,6 +9,6 @@ jobs:
if: ${{ !contains(github.event.issue.labels.*.name, 'feature') && contains(github.event.issue.labels.*.name, 'help wanted') }}
runs-on: ubuntu-latest
steps:
- uses: actions-ecosystem/action-remove-labels@v1
- uses: actions-ecosystem/action-remove-labels@2ce5d41b4b6aa8503e285553f75ed56e0a40bae0 # v1.3.0
with:
labels: help wanted

View File

@@ -21,7 +21,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Repository Checkout
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup

View File

@@ -0,0 +1,131 @@
name: Publish nightly desktop app
# Publish nightly version of desktop app - Runs every day at midnight
on:
schedule:
- cron: '0 0 * * *'
workflow_dispatch:
defaults:
run:
shell: bash
env:
CI: true
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
jobs:
build:
strategy:
matrix:
os:
- ubuntu-22.04
- windows-latest
- macos-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- if: ${{ startsWith(matrix.os, 'windows') }}
run: pip.exe install setuptools
- if: ${{ ! startsWith(matrix.os, 'windows') }}
run: |
mkdir .venv
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install setuptools
- if: ${{ startsWith(matrix.os, 'ubuntu') }}
run: |
sudo apt-get update
sudo apt-get install flatpak -y
sudo apt-get install flatpak-builder -y
sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
sudo flatpak install org.freedesktop.Sdk//24.08 -y
sudo flatpak install org.freedesktop.Platform//24.08 -y
sudo flatpak install org.electronjs.Electron2.BaseApp//24.08 -y
- name: Set up environment
uses: ./.github/actions/setup
- name: Update package versions
run: |
# Get new nightly version
NEW_DESKTOP_APP_VERSION=$(node ./packages/ci-actions/bin/get-next-package-version.js --package-json ./packages/desktop-electron/package.json --type nightly)
# Set package version
npm version $NEW_DESKTOP_APP_VERSION --no-git-tag-version --workspace=desktop-electron --no-workspaces-update
- name: Build Electron for Mac
if: ${{ startsWith(matrix.os, 'macos') }}
run: ./bin/package-electron
env:
CSC_KEY_PASSWORD: ${{ secrets.CSC_KEY_PASSWORD }}
CSC_LINK: ${{ secrets.CSC_LINK }}
APPLE_ID: ${{ secrets.APPLE_ID }}
APPLE_APP_SPECIFIC_PASSWORD: ${{ secrets.APPLE_APP_SPECIFIC_PASSWORD }}
APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
- name: Build Electron
if: ${{ ! startsWith(matrix.os, 'macos') }}
run: ./bin/package-electron
- name: Upload Linux x64 AppImage
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-linux-x86_64.AppImage
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-linux-x86_64.AppImage
- name: Upload Linux arm64 AppImage
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-linux-arm64.AppImage
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-linux-arm64.AppImage
- name: Upload Windows x32 exe
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-windows-ia32.exe
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-windows-ia32.exe
- name: Upload Windows x64 exe
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-windows-x64.exe
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-windows-x64.exe
- name: Upload Windows arm64 exe
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-windows-arm64.exe
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-windows-arm64.exe
- name: Upload Mac x64 dmg
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-mac-x64.dmg
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-mac-x64.dmg
- name: Upload Mac arm64 dmg
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: Actual-mac-arm64.dmg
if-no-files-found: ignore
path: packages/desktop-electron/dist/Actual-mac-arm64.dmg
- name: Upload Windows Store Build
if: ${{ startsWith(matrix.os, 'windows') }}
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: actual-electron-${{ matrix.os }}-appx
path: |
packages/desktop-electron/dist/*.appx

View File

@@ -12,7 +12,7 @@ jobs:
name: Build and pack npm packages
if: github.event.repository.fork == false
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
@@ -49,7 +49,7 @@ jobs:
yarn workspace @actual-app/api pack --filename @actual-app/api.tgz
- name: Upload package artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: npm-packages
path: |
@@ -66,12 +66,12 @@ jobs:
packages: write
steps:
- name: Download the artifacts
uses: actions/download-artifact@v4
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
name: npm-packages
- name: Setup node and npm registry
uses: actions/setup-node@v4
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
with:
node-version: 22
registry-url: 'https://registry.npmjs.org'

View File

@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
name: Build and pack npm packages
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up environment
uses: ./.github/actions/setup
@@ -32,7 +32,7 @@ jobs:
yarn workspace @actual-app/api pack --filename @actual-app/api.tgz
- name: Upload package artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: npm-packages
path: |
@@ -49,12 +49,12 @@ jobs:
packages: write
steps:
- name: Download the artifacts
uses: actions/download-artifact@v4
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
name: npm-packages
- name: Setup node and npm registry
uses: actions/setup-node@v4
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
with:
node-version: 22
registry-url: 'https://registry.npmjs.org'

View File

@@ -12,10 +12,21 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Check release notes
if: startsWith(github.head_ref, 'release/') == false
uses: actualbudget/actions/release-notes/check@main
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
fetch-depth: 0
- name: Get changed files
id: changed-files
run: |
git fetch origin ${{ github.base_ref }}
CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }}...HEAD)
NON_DOCS_FILES=$(echo "$CHANGED_FILES" | grep -v -e "^packages/docs/" -e "^\.github/actions/docs-spelling/" || true)
if [ -z "$NON_DOCS_FILES" ] && [ -n "$CHANGED_FILES" ]; then
echo "only_docs=true" >> $GITHUB_OUTPUT
echo "only documentation files changed, skipping release notes check"
else
echo "only_docs=false" >> $GITHUB_OUTPUT
fi
- name: Generate release notes
if: startsWith(github.head_ref, 'release/') == true
uses: actualbudget/actions/release-notes/generate@main

View File

@@ -26,40 +26,73 @@ jobs:
runs-on: ubuntu-latest
permissions:
pull-requests: write
contents: read
steps:
- name: Wait for ${{github.base_ref}} build to succeed
uses: fountainhead/action-wait-for-check@v1.2.0
id: master-build
- name: Checkout base branch
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
ref: ${{ github.base_ref }}
- name: Set up environment
uses: ./.github/actions/setup
with:
download-translations: 'false'
- name: Wait for ${{github.base_ref}} web build to succeed
uses: fountainhead/action-wait-for-check@5a908a24814494009c4bb27c242ea38c93c593be # v1.2.0
id: master-web-build
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: web
ref: ${{github.base_ref}}
- name: Wait for ${{github.base_ref}} API build to succeed
uses: fountainhead/action-wait-for-check@5a908a24814494009c4bb27c242ea38c93c593be # v1.2.0
id: master-api-build
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: api
ref: ${{github.base_ref}}
- name: Wait for PR build to succeed
uses: fountainhead/action-wait-for-check@v1.2.0
id: wait-for-build
uses: fountainhead/action-wait-for-check@5a908a24814494009c4bb27c242ea38c93c593be # v1.2.0
id: wait-for-web-build
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: web
ref: ${{github.event.pull_request.head.sha}}
- name: Wait for API PR build to succeed
uses: fountainhead/action-wait-for-check@5a908a24814494009c4bb27c242ea38c93c593be # v1.2.0
id: wait-for-api-build
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: api
ref: ${{github.event.pull_request.head.sha}}
- name: Report build failure
if: steps.wait-for-build.outputs.conclusion == 'failure'
if: steps.wait-for-web-build.outputs.conclusion == 'failure' || steps.wait-for-api-build.outputs.conclusion == 'failure'
run: |
echo "Build failed on PR branch or ${{github.base_ref}}"
exit 1
- name: Download build artifact from ${{github.base_ref}}
uses: dawidd6/action-download-artifact@v6
id: pr-build
- name: Download web build artifact from ${{github.base_ref}}
uses: dawidd6/action-download-artifact@ac66b43f0e6a346234dd65d4d0c8fbb31cb316e5 # v11
id: pr-web-build
with:
branch: ${{github.base_ref}}
workflow: build.yml
workflow_conclusion: '' # ignore the conclusion of the workflow, since we already checked it
name: build-stats
path: base
- name: Download build artifact from PR
uses: dawidd6/action-download-artifact@v6
- name: Download API build artifact from ${{github.base_ref}}
uses: dawidd6/action-download-artifact@ac66b43f0e6a346234dd65d4d0c8fbb31cb316e5 # v11
id: pr-api-build
with:
branch: ${{github.base_ref}}
workflow: build.yml
workflow_conclusion: '' # ignore the conclusion of the workflow, since we already checked it
name: api-build-stats
path: base
- name: Download build stats from PR
uses: dawidd6/action-download-artifact@ac66b43f0e6a346234dd65d4d0c8fbb31cb316e5 # v11
with:
pr: ${{github.event.pull_request.number}}
workflow: build.yml
@@ -67,25 +100,46 @@ jobs:
name: build-stats
path: head
allow_forks: true
- name: Download API stats from PR
uses: dawidd6/action-download-artifact@ac66b43f0e6a346234dd65d4d0c8fbb31cb316e5 # v11
with:
pr: ${{github.event.pull_request.number}}
workflow: build.yml
workflow_conclusion: '' # ignore the conclusion of the workflow, since we already checked it
name: api-build-stats
path: head
allow_forks: true
- name: Strip content hashes from stats files
run: |
sed -i -E 's/index\.[0-9a-zA-Z_-]{8,}\./index./g' ./head/web-stats.json
sed -i -E 's/\.[0-9a-zA-Z_-]{8,}\.chunk\././g' ./head/web-stats.json
sed -i -E 's/\.[0-9a-f]{8,}\././g' ./head/*.json
sed -i -E 's/index\.[0-9a-zA-Z_-]{8,}\./index./g' ./base/web-stats.json
sed -i -E 's/\.[0-9a-zA-Z_-]{8,}\.chunk\././g' ./base/web-stats.json
sed -i -E 's/\.[0-9a-f]{8,}\././g' ./base/*.json
- uses: twk3/rollup-size-compare-action@v1.1.1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
current-stats-json-path: ./head/web-stats.json
base-stats-json-path: ./base/web-stats.json
title: desktop-client
- uses: twk3/rollup-size-compare-action@v1.1.1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
current-stats-json-path: ./head/loot-core-stats.json
base-stats-json-path: ./base/loot-core-stats.json
title: loot-core
if [ -f ./head/web-stats.json ]; then
sed -i -E 's/index\.[0-9a-zA-Z_-]{8,}\./index./g' ./head/web-stats.json
sed -i -E 's/\.[0-9a-zA-Z_-]{8,}\.chunk\././g' ./head/web-stats.json
fi
if [ -f ./base/web-stats.json ]; then
sed -i -E 's/index\.[0-9a-zA-Z_-]{8,}\./index./g' ./base/web-stats.json
sed -i -E 's/\.[0-9a-zA-Z_-]{8,}\.chunk\././g' ./base/web-stats.json
fi
for file in ./head/*.json ./base/*.json; do
if [ -f "$file" ]; then
sed -i -E 's/\.[0-9a-f]{8,}\././g' "$file"
fi
done
- name: Generate combined bundle stats comment
run: |
node packages/ci-actions/bin/bundle-stats-comment.mjs \
--base desktop-client=./base/web-stats.json \
--base loot-core=./base/loot-core-stats.json \
--base api=./base/api-stats.json \
--head desktop-client=./head/web-stats.json \
--head loot-core=./head/loot-core-stats.json \
--head api=./head/api-stats.json \
--identifier combined > bundle-stats-comment.md
- name: Post combined bundle stats comment
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_REPOSITORY: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }}
run: |
node packages/ci-actions/bin/update-bundle-stats-comment.mjs \
--comment-file bundle-stats-comment.md \
--identifier '<!--- bundlestats-action-comment key:combined --->'

View File

@@ -8,7 +8,7 @@ jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
- uses: actions/stale@5f858e3efba33a5ca4407a664cc011ad407f2008 # v10.1.0
with:
stale-pr-message: 'This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
close-pr-message: 'This PR was closed because it has been stalled for 5 days with no activity.'
@@ -18,7 +18,7 @@ jobs:
stale-wip:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
- uses: actions/stale@5f858e3efba33a5ca4407a664cc011ad407f2008 # v10.1.0
with:
stale-pr-message: ':wave: Hi! It looks like this PR has not had any changes for a week now. Would you like someone to review this PR? If so - please remove the "[WIP]" prefix from the PR title. That will let the community know that this PR is open for a review.'
days-before-stale: 7
@@ -29,7 +29,7 @@ jobs:
stale-needs-info:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
- uses: actions/stale@5f858e3efba33a5ca4407a664cc011ad407f2008 # v10.1.0
with:
stale-issue-label: 'needs info'
days-before-stale: -1

View File

@@ -19,7 +19,7 @@ jobs:
if: ${{ github.event.workflow_run.conclusion == 'success' }}
steps:
- name: Download patch artifact
uses: actions/download-artifact@v4
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
run-id: ${{ github.event.workflow_run.id }}
@@ -27,7 +27,7 @@ jobs:
path: /tmp/artifacts
- name: Download metadata artifact
uses: actions/download-artifact@v4
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
run-id: ${{ github.event.workflow_run.id }}
@@ -37,17 +37,14 @@ jobs:
- name: Extract metadata
id: metadata
run: |
# Find the metadata directory (will be vrt-metadata-{PR_NUMBER})
METADATA_DIR=$(find /tmp/metadata -mindepth 1 -maxdepth 1 -type d | head -n 1)
if [ -z "$METADATA_DIR" ]; then
if [ ! -f "/tmp/metadata/pr-number.txt" ]; then
echo "No metadata found, skipping..."
exit 0
fi
PR_NUMBER=$(cat "$METADATA_DIR/pr-number.txt")
HEAD_REF=$(cat "$METADATA_DIR/head-ref.txt")
HEAD_REPO=$(cat "$METADATA_DIR/head-repo.txt")
PR_NUMBER=$(cat "/tmp/metadata/pr-number.txt")
HEAD_REF=$(cat "/tmp/metadata/head-ref.txt")
HEAD_REPO=$(cat "/tmp/metadata/head-repo.txt")
echo "pr_number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
echo "head_ref=$HEAD_REF" >> "$GITHUB_OUTPUT"
@@ -57,7 +54,7 @@ jobs:
- name: Checkout fork branch
if: steps.metadata.outputs.pr_number != ''
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
repository: ${{ steps.metadata.outputs.head_repo }}
ref: ${{ steps.metadata.outputs.head_ref }}
@@ -68,9 +65,7 @@ jobs:
if: steps.metadata.outputs.pr_number != ''
id: apply
run: |
# Find the patch file
PATCH_DIR=$(find /tmp/artifacts -mindepth 1 -maxdepth 1 -type d | head -n 1)
PATCH_FILE="$PATCH_DIR/vrt-update.patch"
PATCH_FILE="/tmp/artifacts/vrt-update.patch"
if [ ! -f "$PATCH_FILE" ]; then
echo "No patch file found"
@@ -132,7 +127,7 @@ jobs:
- name: Comment on PR - Success
if: steps.apply.outputs.applied == 'true'
uses: actions/github-script@v7
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
with:
script: |
await github.rest.issues.createComment({
@@ -144,7 +139,7 @@ jobs:
- name: Comment on PR - Failure
if: failure() && steps.metadata.outputs.pr_number != ''
uses: actions/github-script@v7
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
with:
script: |
const error = `${{ steps.apply.outputs.error }}` || 'Unknown error occurred';

View File

@@ -22,7 +22,7 @@ jobs:
container:
image: mcr.microsoft.com/playwright:v1.56.0-jammy
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
ref: ${{ github.event.pull_request.head.sha }}
@@ -82,7 +82,7 @@ jobs:
- name: Upload patch artifact
if: steps.create-patch.outputs.has_changes == 'true'
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: vrt-patch-${{ github.event.pull_request.number }}
path: vrt-update.patch
@@ -98,7 +98,7 @@ jobs:
- name: Upload PR metadata
if: steps.create-patch.outputs.has_changes == 'true'
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
with:
name: vrt-metadata-${{ github.event.pull_request.number }}
path: pr-metadata/

View File

@@ -10,6 +10,7 @@ packages/desktop-client/bundle.browser.js
packages/desktop-client/stats.json
packages/desktop-client/.swc/
packages/desktop-client/build/
packages/desktop-client/dev-dist/
packages/desktop-client/locale/
packages/desktop-client/build-electron/
packages/desktop-client/build-stats/
@@ -26,5 +27,10 @@ packages/loot-core/**/node_modules/*
packages/loot-core/**/lib-dist/*
packages/loot-core/**/proto/*
packages/sync-server/coverage/
packages/sync-server/user-files/
packages/sync-server/server-files/
.yarn/*
upcoming-release-notes/*
# temporary
packages/docs/*

View File

@@ -7,7 +7,7 @@ This guide provides comprehensive information for AI agents (like Cursor) workin
**Actual Budget** is a local-first personal finance tool written in TypeScript/JavaScript. It's 100% free and open-source with synchronization capabilities across devices.
- **Repository**: https://github.com/actualbudget/actual
- **Community Docs**: https://github.com/actualbudget/docs or https://actualbudget.org/docs
- **Community Docs**: https://github.com/actualbudget/actual/tree/master/packages/docs or https://actualbudget.org/docs
- **License**: MIT
- **Primary Language**: TypeScript (with React)
- **Build System**: Yarn 4 workspaces (monorepo)

View File

@@ -1,15 +1,15 @@
import globals from 'globals';
import tsParser from '@typescript-eslint/parser';
import { defineConfig } from 'eslint/config';
import pluginImport from 'eslint-plugin-import';
import pluginJSXA11y from 'eslint-plugin-jsx-a11y';
import pluginReact from 'eslint-plugin-react';
import pluginReactHooks from 'eslint-plugin-react-hooks';
import pluginTypescript from 'typescript-eslint';
import pluginTypescriptPaths from 'eslint-plugin-typescript-paths';
import pluginActual from './packages/eslint-plugin-actual/lib/index.js';
import globals from 'globals';
import pluginTypescript from 'typescript-eslint';
import tsParser from '@typescript-eslint/parser';
// eslint-disable-next-line import/extensions
import pluginActual from './packages/eslint-plugin-actual/lib/index.js';
const confusingBrowserGlobals = [
// https://github.com/facebook/create-react-app/tree/main/packages/confusing-browser-globals
@@ -75,34 +75,33 @@ const confusingBrowserGlobals = [
export default defineConfig(
{
ignores: [
//temporary
'packages/docs',
'packages/api/app/bundle.api.js',
'packages/api/app/stats.json',
'packages/api/dist',
'packages/api/@types',
'packages/api/migrations',
'packages/crdt/dist',
'packages/component-library/src/icons/**/*',
'packages/desktop-client/bundle.browser.js',
'packages/desktop-client/build/',
'packages/desktop-client/dev-dist/',
'packages/desktop-client/service-worker/*',
'packages/desktop-client/build-electron/',
'packages/desktop-client/build-stats/',
'packages/desktop-client/public/kcab/',
'packages/desktop-client/public/data/',
'packages/desktop-client/**/node_modules/*',
'packages/desktop-client/node_modules/',
'packages/desktop-client/test-results/',
'packages/desktop-client/playwright-report/',
'packages/desktop-electron/client-build/',
'packages/desktop-electron/build/',
'packages/desktop-electron/dist/',
'packages/loot-core/**/node_modules/*',
'packages/loot-core/**/lib-dist/*',
'packages/loot-core/**/proto/*',
'packages/sync-server/build/',
'packages/plugins-service/dist/',
'packages/sync-server/user-files/',
'packages/sync-server/server-files/',
'.yarn/*',
'.github/*',
'**/build/',
'**/dist/',
'**/node_modules/',
],
},
{
@@ -164,7 +163,7 @@ export default defineConfig(
},
},
{
files: ['**/*.{js,ts,jsx,tsx}'],
files: ['**/*.{js,ts,jsx,tsx,mjs,mts}'],
plugins: {
'jsx-a11y': pluginJSXA11y,
'react-hooks': pluginReactHooks,
@@ -448,7 +447,7 @@ export default defineConfig(
'react-hooks/exhaustive-deps': [
'warn',
{
additionalHooks: '(useQuery)',
additionalHooks: '(useQuery|useEffectAfterMount)',
},
],
@@ -665,7 +664,7 @@ export default defineConfig(
'warn',
{
types: {
// forbid FC as superflous
// forbid FC as superfluous
FunctionComponent: {
message:
'Type the props argument and let TS infer or use ComponentType for a component prop',
@@ -710,14 +709,18 @@ export default defineConfig(
// Allow configuring vitest with default exports (recommended as per vitest docs)
{
files: ['**/vitest.config.ts', '**/vitest.web.config.ts'],
files: [
'**/vitest.config.{ts,mts}',
'**/vitest.web.config.ts',
'**/vite.config.{ts,mts}',
'eslint.config.mjs',
],
rules: {
'import/no-anonymous-default-export': 'off',
'import/no-default-export': 'off',
},
},
{},
{
// TODO: fix the issues in these files
files: [

View File

@@ -23,6 +23,7 @@
"start:server-monitor": "yarn workspace @actual-app/sync-server start-monitor",
"start:server-dev": "NODE_ENV=development BROWSER_OPEN=localhost:5006 yarn npm-run-all --parallel 'start:server-monitor' 'start'",
"start:desktop": "yarn desktop-dependencies && npm-run-all --parallel 'start:desktop-*'",
"start:docs": "yarn workspace docs start",
"desktop-dependencies": "npm-run-all --parallel rebuild-electron build:browser-backend build:plugins-service",
"start:desktop-node": "yarn workspace loot-core watch:node",
"start:desktop-client": "yarn workspace @actual-app/web watch",
@@ -38,6 +39,7 @@
"build:desktop": "./bin/package-electron",
"build:plugins-service": "yarn workspace plugins-service build",
"build:api": "yarn workspace @actual-app/api build",
"build:docs": "yarn workspace docs build",
"generate:i18n": "yarn workspace @actual-app/web generate:i18n",
"generate:release-notes": "ts-node ./bin/release-note-generator.ts",
"test": "lage test --continue",
@@ -57,34 +59,34 @@
"prepare": "husky"
},
"devDependencies": {
"@octokit/rest": "^22.0.0",
"@types/node": "^22.18.11",
"@octokit/rest": "^22.0.1",
"@types/node": "^22.19.1",
"@types/prompts": "^2.4.9",
"@typescript-eslint/parser": "^8.46.0",
"@typescript-eslint/parser": "^8.46.4",
"cross-env": "^10.1.0",
"eslint": "^9.37.0",
"eslint": "^9.39.1",
"eslint-config-prettier": "^10.1.8",
"eslint-import-resolver-typescript": "^4.4.4",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-jsx-a11y": "^6.10.2",
"eslint-plugin-react": "^7.37.5",
"eslint-plugin-react-hooks": "^7.0.0",
"eslint-plugin-react-hooks": "^7.0.1",
"eslint-plugin-typescript-paths": "^0.0.33",
"globals": "^16.4.0",
"globals": "^16.5.0",
"html-to-image": "^1.11.13",
"husky": "^9.1.7",
"lage": "^2.14.14",
"lint-staged": "^16.2.3",
"minimatch": "^10.0.3",
"lage": "^2.14.15",
"lint-staged": "^16.2.6",
"minimatch": "^10.1.1",
"node-jq": "^6.3.1",
"npm-run-all": "^4.1.5",
"p-limit": "^7.1.1",
"p-limit": "^7.2.0",
"prettier": "^3.6.2",
"prompts": "^2.4.2",
"source-map-support": "^0.5.21",
"ts-node": "^10.9.2",
"typescript": "^5.9.3",
"typescript-eslint": "^8.46.0",
"typescript-eslint": "^8.46.4",
"typescript-strict-plugin": "^2.4.4"
},
"resolutions": {

View File

@@ -1,7 +1,8 @@
// @ts-strict-ignore
import * as fs from 'fs/promises';
import * as path from 'path';
import { type RuleEntity } from 'loot-core/types/models';
import * as api from './index';
const budgetName = 'test-budget';
@@ -282,7 +283,7 @@ describe('API CRUD operations', () => {
expect(await api.getAccountBalance(accountId2)).toEqual(0);
await api.updateAccount(accountId1, { offbudget: false });
await api.closeAccount(accountId1, accountId2, null);
await api.closeAccount(accountId1, accountId2);
await api.deleteAccount(accountId2);
// accounts successfully updated, and one of them deleted
@@ -505,7 +506,7 @@ describe('API CRUD operations', () => {
...rule,
stage: 'post',
conditionsOp: 'or',
};
} satisfies RuleEntity;
expect(await api.updateRule(updatedRule)).toEqual(updatedRule);
expect(await api.getRules()).toEqual(
@@ -719,7 +720,7 @@ describe('API CRUD operations', () => {
// Test without notes
const transactionsWithoutNotes = [
{ date: '2023-11-03', imported_id: '11', amount: 100, notes: null },
{ date: '2023-11-03', imported_id: '11', amount: 100 },
];
const addResultWithoutNotes = await api.addTransactions(

View File

@@ -1,6 +1,18 @@
// @ts-strict-ignore
import type {
APIAccountEntity,
APICategoryEntity,
APICategoryGroupEntity,
APIFileEntity,
APIPayeeEntity,
APIScheduleEntity,
} from 'loot-core/server/api-models';
import type { Query } from 'loot-core/shared/query';
import type { Handlers } from 'loot-core/types/handlers';
import type { ImportTransactionEntity } from 'loot-core/types/models/import-transaction';
import type {
ImportTransactionEntity,
RuleEntity,
TransactionEntity,
} from 'loot-core/types/models';
import * as injected from './injected';
@@ -13,8 +25,11 @@ function send<K extends keyof Handlers, T extends Handlers[K]>(
return injected.send(name, args);
}
export async function runImport(name, func) {
await send('api/start-import', { budgetName: name });
export async function runImport(
budgetName: APIFileEntity['name'],
func: () => Promise<void>,
) {
await send('api/start-import', { budgetName });
try {
await func();
} catch (e) {
@@ -24,11 +39,14 @@ export async function runImport(name, func) {
await send('api/finish-import');
}
export async function loadBudget(budgetId) {
export async function loadBudget(budgetId: string) {
return send('api/load-budget', { id: budgetId });
}
export async function downloadBudget(syncId, { password }: { password? } = {}) {
export async function downloadBudget(
syncId: string,
{ password }: { password?: string } = {},
) {
return send('api/download-budget', { syncId, password });
}
@@ -40,11 +58,13 @@ export async function sync() {
return send('api/sync');
}
export async function runBankSync(args?: { accountId: string }) {
export async function runBankSync(args?: {
accountId: APIAccountEntity['id'];
}) {
return send('api/bank-sync', args);
}
export async function batchBudgetUpdates(func) {
export async function batchBudgetUpdates(func: () => Promise<void>) {
await send('api/batch-budget-start');
try {
await func();
@@ -57,11 +77,11 @@ export async function batchBudgetUpdates(func) {
* @deprecated Please use `aqlQuery` instead.
* This function will be removed in a future release.
*/
export function runQuery(query) {
export function runQuery(query: Query) {
return send('api/query', { query: query.serialize() });
}
export function aqlQuery(query) {
export function aqlQuery(query: Query) {
return send('api/query', { query: query.serialize() });
}
@@ -69,22 +89,33 @@ export function getBudgetMonths() {
return send('api/budget-months');
}
export function getBudgetMonth(month) {
export function getBudgetMonth(month: string) {
return send('api/budget-month', { month });
}
export function setBudgetAmount(month, categoryId, value) {
export function setBudgetAmount(
month: string,
categoryId: APICategoryEntity['id'],
value: number,
) {
return send('api/budget-set-amount', { month, categoryId, amount: value });
}
export function setBudgetCarryover(month, categoryId, flag) {
export function setBudgetCarryover(
month: string,
categoryId: APICategoryEntity['id'],
flag: boolean,
) {
return send('api/budget-set-carryover', { month, categoryId, flag });
}
export function addTransactions(
accountId,
transactions,
{ learnCategories = false, runTransfers = false } = {},
accountId: APIAccountEntity['id'],
transactions: Omit<ImportTransactionEntity, 'account'>[],
{
learnCategories = false,
runTransfers = false,
}: { learnCategories?: boolean; runTransfers?: boolean } = {},
) {
return send('api/transactions-add', {
accountId,
@@ -100,7 +131,7 @@ export interface ImportTransactionsOpts {
}
export function importTransactions(
accountId: string,
accountId: APIAccountEntity['id'],
transactions: ImportTransactionEntity[],
opts: ImportTransactionsOpts = {
defaultCleared: true,
@@ -115,15 +146,22 @@ export function importTransactions(
});
}
export function getTransactions(accountId, startDate, endDate) {
export function getTransactions(
accountId: APIAccountEntity['id'],
startDate: string,
endDate: string,
) {
return send('api/transactions-get', { accountId, startDate, endDate });
}
export function updateTransaction(id, fields) {
export function updateTransaction(
id: TransactionEntity['id'],
fields: Partial<TransactionEntity>,
) {
return send('api/transaction-update', { id, fields });
}
export function deleteTransaction(id) {
export function deleteTransaction(id: TransactionEntity['id']) {
return send('api/transaction-delete', { id });
}
@@ -131,15 +169,25 @@ export function getAccounts() {
return send('api/accounts-get');
}
export function createAccount(account, initialBalance?) {
export function createAccount(
account: Omit<APIAccountEntity, 'id'>,
initialBalance?: number,
) {
return send('api/account-create', { account, initialBalance });
}
export function updateAccount(id, fields) {
export function updateAccount(
id: APIAccountEntity['id'],
fields: Partial<APIAccountEntity>,
) {
return send('api/account-update', { id, fields });
}
export function closeAccount(id, transferAccountId?, transferCategoryId?) {
export function closeAccount(
id: APIAccountEntity['id'],
transferAccountId?: APIAccountEntity['id'],
transferCategoryId?: APICategoryEntity['id'],
) {
return send('api/account-close', {
id,
transferAccountId,
@@ -147,15 +195,15 @@ export function closeAccount(id, transferAccountId?, transferCategoryId?) {
});
}
export function reopenAccount(id) {
export function reopenAccount(id: APIAccountEntity['id']) {
return send('api/account-reopen', { id });
}
export function deleteAccount(id) {
export function deleteAccount(id: APIAccountEntity['id']) {
return send('api/account-delete', { id });
}
export function getAccountBalance(id, cutoff?) {
export function getAccountBalance(id: APIAccountEntity['id'], cutoff?: Date) {
return send('api/account-balance', { id, cutoff });
}
@@ -163,15 +211,21 @@ export function getCategoryGroups() {
return send('api/category-groups-get');
}
export function createCategoryGroup(group) {
export function createCategoryGroup(group: Omit<APICategoryGroupEntity, 'id'>) {
return send('api/category-group-create', { group });
}
export function updateCategoryGroup(id, fields) {
export function updateCategoryGroup(
id: APICategoryGroupEntity['id'],
fields: Partial<APICategoryGroupEntity>,
) {
return send('api/category-group-update', { id, fields });
}
export function deleteCategoryGroup(id, transferCategoryId?) {
export function deleteCategoryGroup(
id: APICategoryGroupEntity['id'],
transferCategoryId?: APICategoryEntity['id'],
) {
return send('api/category-group-delete', { id, transferCategoryId });
}
@@ -179,15 +233,21 @@ export function getCategories() {
return send('api/categories-get', { grouped: false });
}
export function createCategory(category) {
export function createCategory(category: Omit<APICategoryEntity, 'id'>) {
return send('api/category-create', { category });
}
export function updateCategory(id, fields) {
export function updateCategory(
id: APICategoryEntity['id'],
fields: Partial<APICategoryEntity>,
) {
return send('api/category-update', { id, fields });
}
export function deleteCategory(id, transferCategoryId?) {
export function deleteCategory(
id: APICategoryEntity['id'],
transferCategoryId?: APICategoryEntity['id'],
) {
return send('api/category-delete', { id, transferCategoryId });
}
@@ -199,19 +259,25 @@ export function getPayees() {
return send('api/payees-get');
}
export function createPayee(payee) {
export function createPayee(payee: Omit<APIPayeeEntity, 'id'>) {
return send('api/payee-create', { payee });
}
export function updatePayee(id, fields) {
export function updatePayee(
id: APIPayeeEntity['id'],
fields: Partial<APIPayeeEntity>,
) {
return send('api/payee-update', { id, fields });
}
export function deletePayee(id) {
export function deletePayee(id: APIPayeeEntity['id']) {
return send('api/payee-delete', { id });
}
export function mergePayees(targetId, mergeIds) {
export function mergePayees(
targetId: APIPayeeEntity['id'],
mergeIds: APIPayeeEntity['id'][],
) {
return send('api/payees-merge', { targetId, mergeIds });
}
@@ -219,35 +285,39 @@ export function getRules() {
return send('api/rules-get');
}
export function getPayeeRules(id) {
export function getPayeeRules(id: RuleEntity['id']) {
return send('api/payee-rules-get', { id });
}
export function createRule(rule) {
export function createRule(rule: Omit<RuleEntity, 'id'>) {
return send('api/rule-create', { rule });
}
export function updateRule(rule) {
export function updateRule(rule: RuleEntity) {
return send('api/rule-update', { rule });
}
export function deleteRule(id: string) {
export function deleteRule(id: RuleEntity['id']) {
return send('api/rule-delete', id);
}
export function holdBudgetForNextMonth(month, amount) {
export function holdBudgetForNextMonth(month: string, amount: number) {
return send('api/budget-hold-for-next-month', { month, amount });
}
export function resetBudgetHold(month) {
export function resetBudgetHold(month: string) {
return send('api/budget-reset-hold', { month });
}
export function createSchedule(schedule) {
export function createSchedule(schedule: Omit<APIScheduleEntity, 'id'>) {
return send('api/schedule-create', schedule);
}
export function updateSchedule(id, fields, resetNextDate?: boolean) {
export function updateSchedule(
id: APIScheduleEntity['id'],
fields: Partial<APIScheduleEntity>,
resetNextDate?: boolean,
) {
return send('api/schedule-update', {
id,
fields,
@@ -255,7 +325,7 @@ export function updateSchedule(id, fields, resetNextDate?: boolean) {
});
}
export function deleteSchedule(scheduleId) {
export function deleteSchedule(scheduleId: APIScheduleEntity['id']) {
return send('api/schedule-delete', scheduleId);
}
@@ -263,7 +333,10 @@ export function getSchedules() {
return send('api/schedules-get');
}
export function getIDByName(type, name) {
export function getIDByName(
type: 'accounts' | 'schedules' | 'categories' | 'payees',
name: string,
) {
return send('api/get-id-by-name', { type, name });
}

View File

@@ -1,6 +1,6 @@
{
"name": "@actual-app/api",
"version": "25.10.0",
"version": "25.11.0",
"license": "MIT",
"description": "An API for Actual",
"engines": {
@@ -32,6 +32,6 @@
"devDependencies": {
"tsc-alias": "^1.8.16",
"typescript": "^5.9.3",
"vitest": "^3.2.4"
"vitest": "^4.0.9"
}
}

View File

@@ -5,11 +5,6 @@ export default {
// print only console.error
return type === 'stderr';
},
poolOptions: {
threads: {
maxThreads: 2,
minThreads: 1,
},
},
maxWorkers: 2,
},
};

View File

@@ -0,0 +1,678 @@
#!/usr/bin/env node
/**
* Generates a combined bundle stats comment for GitHub Actions.
* Heavily inspired by https://github.com/twk3/rollup-size-compare-action (MIT).
*/
import { readFile } from 'node:fs/promises';
import path from 'node:path';
import process from 'node:process';
const REQUIRED_ARGS = new Map([
['base', 'Mapping of bundle names to base stats JSON'],
['head', 'Mapping of bundle names to head stats JSON'],
]);
function parseRawArgs(argv) {
const args = new Map();
for (let index = 2; index < argv.length; index += 1) {
const key = argv[index];
if (!key?.startsWith('--')) {
throw new Error(
`Unexpected argument “${key ?? ''}”. Use --key value pairs.`,
);
}
const values = [];
while (index + 1 < argv.length && !argv[index + 1].startsWith('--')) {
values.push(argv[index + 1]);
index += 1;
}
if (values.length === 0) {
throw new Error(`Missing value for argument “${key}”.`);
}
const keyName = key.slice(2);
// Accumulate values if the key already exists
if (args.has(keyName)) {
args.set(keyName, [...args.get(keyName), ...values]);
} else {
args.set(keyName, values);
}
}
return args;
}
function getSingleValue(args, key) {
const values = args.get(key);
if (!values) {
return undefined;
}
if (values.length !== 1) {
throw new Error(`Argument “--${key}” must have exactly one value.`);
}
return values[0];
}
function parseMapping(values, key, description) {
if (!values || values.length === 0) {
throw new Error(`Missing required argument “--${key}” (${description}).`);
}
if (values.length === 1) {
const [rawValue] = values;
const trimmed = rawValue.trim();
if (trimmed.startsWith('{')) {
try {
const parsed = JSON.parse(trimmed);
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
throw new Error('Value must be a JSON object.');
}
return new Map(
Object.entries(parsed).map(([name, pathValue]) => {
if (typeof pathValue !== 'string') {
throw new Error(
`Value for “${name}” in “--${key}” must be a string path.`,
);
}
return [name, pathValue];
}),
);
} catch (error) {
const message =
error instanceof Error ? error.message : 'Unknown parsing error';
throw new Error(
`Failed to parse “--${key}” value as JSON object: ${message}`,
);
}
}
}
const entries = new Map();
for (const value of values) {
const [rawName, ...rawPathParts] = value.split('=');
if (!rawName || rawPathParts.length === 0) {
throw new Error(
`Argument “--${key}” must be provided as name=path pairs or a JSON object.`,
);
}
const name = rawName.trim();
const pathValue = rawPathParts.join('=').trim();
if (!name) {
throw new Error(`Argument “--${key}” contains an empty bundle name.`);
}
if (!pathValue) {
throw new Error(
`Argument “--${key}” for bundle “${name}” must include a non-empty path.`,
);
}
entries.set(name, pathValue);
}
if (entries.size === 0) {
throw new Error(`Argument “--${key}” must define at least one bundle.`);
}
return entries;
}
function parseArgs(argv) {
const args = parseRawArgs(argv);
const baseMap = parseMapping(
args.get('base'),
'base',
REQUIRED_ARGS.get('base'),
);
const headMap = parseMapping(
args.get('head'),
'head',
REQUIRED_ARGS.get('head'),
);
const sections = [];
for (const [name, basePath] of baseMap.entries()) {
const headPath = headMap.get(name);
if (!headPath) {
throw new Error(
`Bundle “${name}” is missing a corresponding “--head” entry.`,
);
}
sections.push({
name,
basePath,
headPath,
});
}
for (const name of headMap.keys()) {
if (!baseMap.has(name)) {
throw new Error(
`Bundle “${name}” is missing a corresponding “--base” entry.`,
);
}
}
return {
sections,
identifier: getSingleValue(args, 'identifier') ?? 'bundle-stats',
};
}
async function loadStats(filePath) {
try {
const absolutePath = path.resolve(process.cwd(), filePath);
const fileContents = await readFile(absolutePath, 'utf8');
const parsed = JSON.parse(fileContents);
// Validate that we got a meaningful stats object
if (!parsed || typeof parsed !== 'object') {
throw new Error('Stats file does not contain a valid JSON object');
}
return parsed;
} catch (error) {
const message =
error instanceof Error
? error.message
: 'Unknown error while parsing stats file';
console.error(`[bundle-stats] Failed to parse “${filePath}”: ${message}`);
throw new Error(`Failed to load stats file “${filePath}”: ${message}`);
}
}
function findAllChildren(node = {}) {
if (Array.isArray(node.children)) {
return node.children.flatMap(findAllChildren);
}
return [node];
}
function trimPath(input) {
if (!input) {
return '';
}
return input.replace(/.*node_modules/, '/node_modules');
}
function assetNameToSizeMap(statAssets = {}) {
const children = statAssets?.tree?.children;
if (!Array.isArray(children) || children.length === 0) {
return new Map();
}
return new Map(
children.map(asset => {
const descendants = findAllChildren(asset);
let size = 0;
let gzipSize = statAssets?.options?.gzip ? 0 : null;
for (const mod of descendants) {
const nodePart = statAssets?.nodeParts?.[mod.uid];
if (!nodePart) {
continue;
}
size += nodePart.renderedLength ?? 0;
if (gzipSize !== null) {
gzipSize += nodePart.gzipLength ?? 0;
}
}
return [trimPath(asset.name), { size, gzipSize }];
}),
);
}
function chunkModuleNameToSizeMap(statChunks = {}) {
if (!statChunks?.tree) {
return new Map();
}
return new Map(
findAllChildren(statChunks.tree).map(mod => {
const modInfo = statChunks?.nodeParts?.[mod.uid] ?? {};
const meta = statChunks?.nodeMetas?.[modInfo.metaUid] ?? {};
const id = trimPath(meta.id ?? '');
return [
id,
{
size: modInfo.renderedLength ?? 0,
gzipSize: statChunks?.options?.gzip
? (modInfo.gzipLength ?? 0)
: null,
},
];
}),
);
}
function sortDiffDescending(items) {
return items.sort((a, b) => Math.abs(b.diff) - Math.abs(a.diff));
}
function normaliseGzip(value) {
if (value == null || Number.isNaN(value)) {
return NaN;
}
return value;
}
function getAssetDiff(name, oldSize, newSize) {
const diff = newSize.size - oldSize.size;
const percent =
oldSize.size === 0
? newSize.size === 0
? 0
: Infinity
: +((1 - newSize.size / oldSize.size) * -100).toFixed(5) || 0;
return {
name,
new: {
size: newSize.size,
gzipSize: normaliseGzip(newSize.gzipSize),
},
old: {
size: oldSize.size,
gzipSize: normaliseGzip(oldSize.gzipSize),
},
diff,
diffPercentage: percent,
};
}
function webpackStatsDiff(oldAssets, newAssets) {
const added = [];
const removed = [];
const bigger = [];
const smaller = [];
const unchanged = [];
let newSizeTotal = 0;
let oldSizeTotal = 0;
let newGzipSizeTotal = 0;
let oldGzipSizeTotal = 0;
for (const [name, oldAssetSizes] of oldAssets) {
oldSizeTotal += oldAssetSizes.size;
oldGzipSizeTotal += oldAssetSizes.gzipSize ?? NaN;
const newAsset = newAssets.get(name);
if (!newAsset) {
removed.push(getAssetDiff(name, oldAssetSizes, { size: 0, gzipSize: 0 }));
continue;
}
const diff = getAssetDiff(name, oldAssetSizes, newAsset);
if (diff.diffPercentage > 0) {
bigger.push(diff);
} else if (diff.diffPercentage < 0) {
smaller.push(diff);
} else {
unchanged.push(diff);
}
}
for (const [name, newAssetSizes] of newAssets) {
newSizeTotal += newAssetSizes.size;
newGzipSizeTotal += newAssetSizes.gzipSize ?? NaN;
if (!oldAssets.has(name)) {
added.push(getAssetDiff(name, { size: 0, gzipSize: 0 }, newAssetSizes));
}
}
const oldFilesCount = oldAssets.size;
const newFilesCount = newAssets.size;
return {
added: sortDiffDescending(added),
removed: sortDiffDescending(removed),
bigger: sortDiffDescending(bigger),
smaller: sortDiffDescending(smaller),
unchanged,
total: getAssetDiff(
oldFilesCount === newFilesCount
? `${newFilesCount}`
: `${oldFilesCount}${newFilesCount}`,
{ size: oldSizeTotal, gzipSize: oldGzipSizeTotal },
{ size: newSizeTotal, gzipSize: newGzipSizeTotal },
),
};
}
function getStatsDiff(oldStats, newStats) {
return webpackStatsDiff(
assetNameToSizeMap(oldStats),
assetNameToSizeMap(newStats),
);
}
function getChunkModuleDiff(oldStats, newStats) {
const diff = webpackStatsDiff(
chunkModuleNameToSizeMap(oldStats),
chunkModuleNameToSizeMap(newStats),
);
if (
diff.added.length === 0 &&
diff.removed.length === 0 &&
diff.bigger.length === 0 &&
diff.smaller.length === 0
) {
return null;
}
return diff;
}
const BYTES_PER_KILOBYTE = 1024;
const FILE_SIZE_DENOMINATIONS = [
'B',
'kB',
'MB',
'GB',
'TB',
'PB',
'EB',
'ZB',
'YB',
'BB',
];
function formatFileSizeIEC(bytes, precision = 2) {
if (bytes == null || Number.isNaN(bytes)) {
return 'N/A';
}
if (bytes === 0) {
return `0 ${FILE_SIZE_DENOMINATIONS[0]}`;
}
const absBytes = Math.abs(bytes);
const denominationIndex = Math.floor(
Math.log(absBytes) / Math.log(BYTES_PER_KILOBYTE),
);
const value = absBytes / Math.pow(BYTES_PER_KILOBYTE, denominationIndex);
const stripped = parseFloat(value.toFixed(precision));
return `${stripped} ${FILE_SIZE_DENOMINATIONS[denominationIndex]}`;
}
function conditionalPercentage(number) {
if (number === Infinity || number === -Infinity) {
return '-';
}
const absValue = Math.abs(number);
if (absValue === 0 || absValue === 100) {
return `${number}%`;
}
const value = Number.isFinite(absValue) ? absValue.toFixed(2) : absValue;
return `${signFor(number)}${value}%`;
}
function capitalize(text) {
if (!text) return '';
return `${text[0].toUpperCase()}${text.slice(1)}`;
}
function makeHeader(columns) {
const header = columns.join(' | ');
const separator = columns
.map(column =>
Array.from({ length: column.length })
.map(() => '-')
.join(''),
)
.join(' | ');
return `${header}\n${separator}`;
}
const TOTAL_HEADERS = makeHeader([
'Files count',
'Total bundle size',
'% Changed',
]);
const TABLE_HEADERS = makeHeader(['Asset', 'File Size', '% Changed']);
const CHUNK_TABLE_HEADERS = makeHeader(['File', 'Δ', 'Size']);
function signFor(num) {
if (num === 0) return '';
return num > 0 ? '+' : '-';
}
function toFileSizeDiff(oldSize, newSize, diff) {
const diffLine = [
`${formatFileSizeIEC(oldSize)}${formatFileSizeIEC(newSize)}`,
];
if (typeof diff !== 'undefined') {
diffLine.push(`(${signFor(diff)}${formatFileSizeIEC(diff)})`);
}
return diffLine.join(' ');
}
function toFileSizeDiffCell(asset) {
const lines = [];
if (asset.diff === 0) {
lines.push(formatFileSizeIEC(asset.new.size));
if (asset.new.gzipSize) {
lines.push(formatFileSizeIEC(asset.new.gzipSize));
}
} else {
lines.push(toFileSizeDiff(asset.old.size, asset.new.size, asset.diff));
if (asset.old.gzipSize || asset.new.gzipSize) {
lines.push(
`${toFileSizeDiff(asset.old.gzipSize, asset.new.gzipSize)} (gzip)`,
);
}
}
return lines.join('<br />');
}
function printAssetTableRow(asset) {
return [
asset.name,
toFileSizeDiffCell(asset),
conditionalPercentage(asset.diffPercentage),
].join(' | ');
}
function printAssetTablesByGroup(statsDiff) {
const statsFields = ['added', 'removed', 'bigger', 'smaller', 'unchanged'];
return statsFields
.map(field => {
const assets = statsDiff[field] ?? [];
if (assets.length === 0) {
return `**${capitalize(field)}**\nNo assets were ${field}`;
}
return `**${capitalize(field)}**\n${TABLE_HEADERS}\n${assets
.map(asset => printAssetTableRow(asset))
.join('\n')}`;
})
.join('\n\n');
}
function getDiffEmoji(diff) {
if (diff.diffPercentage === Infinity) return '🆕';
if (diff.diffPercentage <= -100) return '🔥';
if (diff.diffPercentage > 0) return '📈';
if (diff.diffPercentage < 0) return '📉';
return ' ';
}
function getTrimmedChunkName(chunkModule) {
const chunkName = chunkModule.name ?? '';
if (chunkName.startsWith('./')) {
return chunkName.substring(2);
}
if (chunkName.startsWith('/')) {
return chunkName.substring(1);
}
return chunkName;
}
function printChunkModuleRow(chunkModule) {
const emoji = getDiffEmoji(chunkModule);
const chunkName = getTrimmedChunkName(chunkModule);
const diffPart = `${chunkModule.diff >= 0 ? '+' : '-'}${formatFileSizeIEC(chunkModule.diff)}`;
const percentPart = Number.isFinite(chunkModule.diffPercentage)
? ` (${conditionalPercentage(chunkModule.diffPercentage)})`
: '';
return [
`\`${chunkName}\``,
`${emoji} ${diffPart}${percentPart}`,
`${formatFileSizeIEC(chunkModule.old.size)}${formatFileSizeIEC(chunkModule.new.size)}`,
].join(' | ');
}
function printChunkModulesTable(statsDiff) {
if (!statsDiff) {
return '';
}
const changedModules = [
...(statsDiff.added ?? []),
...(statsDiff.removed ?? []),
...(statsDiff.bigger ?? []),
...(statsDiff.smaller ?? []),
].sort((a, b) => b.diffPercentage - a.diffPercentage);
if (changedModules.length === 0) {
return `<details>\n<summary>Changeset</summary>\nNo files were changed\n</details>`;
}
const rows = changedModules
.slice(0, 100)
.map(chunkModule => printChunkModuleRow(chunkModule))
.join('\n');
const summarySuffix =
changedModules.length > 100 ? ' (largest 100 files by percent change)' : '';
return `<details>\n<summary>Changeset${summarySuffix}</summary>\n\n${CHUNK_TABLE_HEADERS}\n${rows}\n</details>`;
}
function printTotalAssetTable(statsDiff) {
return `**Total**\n${TOTAL_HEADERS}\n${printAssetTableRow(statsDiff.total)}`;
}
function renderSection(title, statsDiff, chunkModuleDiff) {
const { total, ...groups } = statsDiff;
const parts = [`#### ${title}`, '', printTotalAssetTable({ total })];
const chunkTable = printChunkModulesTable(chunkModuleDiff);
if (chunkTable) {
parts.push('', chunkTable);
}
parts.push(
'',
`<details>\n<summary>View detailed bundle breakdown</summary>\n<div>\n\n${printAssetTablesByGroup(
groups,
)}\n</div>\n</details>`,
);
return parts.join('\n');
}
async function main() {
const args = parseArgs(process.argv);
console.error(
`[bundle-stats] Found ${args.sections.length} sections to process`,
);
args.sections.forEach((section, index) => {
console.error(
`[bundle-stats] Section ${index + 1}: ${section.name} (base: ${section.basePath}, head: ${section.headPath})`,
);
});
const sections = [];
for (const section of args.sections) {
console.error(`[bundle-stats] Processing section: ${section.name}`);
console.error(
`[bundle-stats] Loading base stats from: ${section.basePath}`,
);
const baseStats = await loadStats(section.basePath);
console.error(
`[bundle-stats] Loading head stats from: ${section.headPath}`,
);
const headStats = await loadStats(section.headPath);
const statsDiff = getStatsDiff(baseStats, headStats);
const chunkDiff = getChunkModuleDiff(baseStats, headStats);
console.error(
`[bundle-stats] Section ${section.name}: ${statsDiff.total.name} files, total size ${statsDiff.total.old.size}${statsDiff.total.new.size}`,
);
sections.push({
name: section.name,
statsDiff,
chunkDiff,
});
}
const identifier = `<!--- bundlestats-action-comment key:${args.identifier} --->`;
const comment = [
'### Bundle Stats',
'',
sections
.map(section =>
renderSection(section.name, section.statsDiff, section.chunkDiff),
)
.join('\n\n---\n\n'),
'',
identifier,
'',
].join('\n');
process.stdout.write(comment);
}
main().catch(error => {
console.error(error);
process.exitCode = 1;
});

View File

@@ -0,0 +1,151 @@
#!/usr/bin/env node
/**
* Updates (or creates) a bundle stats comment on a pull request.
* Requires the following environment variables to be set:
* - GITHUB_TOKEN
* - GITHUB_REPOSITORY (owner/repo)
* - PR_NUMBER
*/
import { readFile } from 'node:fs/promises';
import path from 'node:path';
import process from 'node:process';
import { Octokit } from '@octokit/rest';
function parseArgs(argv) {
const args = {
commentFile: null,
identifier: null,
};
for (let i = 2; i < argv.length; i += 2) {
const key = argv[i];
const value = argv[i + 1];
if (!key?.startsWith('--')) {
throw new Error(
`Unexpected argument “${key ?? ''}”. Use --key value pairs.`,
);
}
if (typeof value === 'undefined') {
throw new Error(`Missing value for argument “${key}”.`);
}
switch (key) {
case '--comment-file':
args.commentFile = value;
break;
case '--identifier':
args.identifier = value;
break;
default:
throw new Error(`Unknown argument “${key}”.`);
}
}
if (!args.commentFile) {
throw new Error('Missing required argument “--comment-file“.');
}
if (!args.identifier) {
throw new Error('Missing required argument “--identifier“.');
}
return args;
}
async function loadCommentBody(commentFile) {
const absolutePath = path.resolve(process.cwd(), commentFile);
return readFile(absolutePath, 'utf8');
}
function getRepoInfo() {
const repository = process.env.GITHUB_REPOSITORY;
if (!repository) {
throw new Error('GITHUB_REPOSITORY environment variable is required.');
}
const [owner, repo] = repository.split('/');
if (!owner || !repo) {
throw new Error(`Invalid GITHUB_REPOSITORY value “${repository}”.`);
}
return { owner, repo };
}
function getPullRequestNumber() {
const rawNumber = process.env.PR_NUMBER ?? '';
const prNumber = Number.parseInt(rawNumber, 10);
if (!Number.isInteger(prNumber) || prNumber <= 0) {
throw new Error(
'PR_NUMBER environment variable must be a positive integer.',
);
}
return prNumber;
}
function assertGitHubToken() {
const token = process.env.GITHUB_TOKEN;
if (!token) {
throw new Error('GITHUB_TOKEN environment variable is required.');
}
return token;
}
async function listComments(octokit, owner, repo, issueNumber) {
return octokit.paginate(octokit.rest.issues.listComments, {
owner,
repo,
issue_number: issueNumber,
per_page: 100,
});
}
function isGitHubActionsBot(comment) {
return comment.user?.login === 'github-actions[bot]';
}
async function main() {
const { commentFile, identifier } = parseArgs(process.argv);
const commentBody = await loadCommentBody(commentFile);
const token = assertGitHubToken();
const { owner, repo } = getRepoInfo();
const issueNumber = getPullRequestNumber();
const octokit = new Octokit({ auth: token });
const comments = await listComments(octokit, owner, repo, issueNumber);
const existingComment = comments.find(
comment =>
isGitHubActionsBot(comment) && comment.body?.includes(identifier),
);
if (existingComment) {
await octokit.rest.issues.updateComment({
owner,
repo,
comment_id: existingComment.id,
body: commentBody,
});
console.log('Updated existing bundle stats comment.');
} else {
await octokit.rest.issues.createComment({
owner,
repo,
issue_number: issueNumber,
body: commentBody,
});
console.log('Created new bundle stats comment.');
}
}
main().catch(error => {
console.error(error);
process.exitCode = 1;
});

View File

@@ -3,7 +3,7 @@
"private": true,
"type": "module",
"devDependencies": {
"vitest": "^3.2.4"
"vitest": "^4.0.9"
},
"scripts": {
"test": "vitest --run"

View File

@@ -5,10 +5,7 @@ export default defineConfig({
globals: true,
include: ['src/**/*.test.(js|jsx|ts|tsx)'],
environment: 'node',
poolOptions: {
threads: {
singleThread: true,
},
},
maxWorkers: 1,
isolate: false,
},
});

View File

@@ -13,10 +13,10 @@
},
"devDependencies": {
"@svgr/cli": "^8.1.0",
"@types/react": "^19.2.2",
"@types/react": "^19.2.5",
"react": "19.2.0",
"react-dom": "19.2.0",
"vitest": "^3.2.4"
"vitest": "^4.0.9"
},
"exports": {
"./hooks/*": "./src/hooks/*.ts",
@@ -40,7 +40,6 @@
"./popover": "./src/Popover.tsx",
"./select": "./src/Select.tsx",
"./space-between": "./src/SpaceBetween.tsx",
"./stack": "./src/Stack.tsx",
"./styles": "./src/styles.ts",
"./text": "./src/Text.tsx",
"./text-one-line": "./src/TextOneLine.tsx",

View File

@@ -4,6 +4,7 @@ import {
isValidElement,
type ReactElement,
Ref,
RefObject,
useEffect,
useRef,
} from 'react';
@@ -11,15 +12,20 @@ import {
type InitialFocusProps<T extends HTMLElement> = {
/**
* The child element to focus when the component mounts. This can be either a single React element or a function that returns a React element.
* The child element should have a `ref` prop for this to work. For child components which receives a ref via another prop
* e.g. `inputRef`, use a function as child and pass the ref to the appropriate prop.
*/
children: ReactElement<{ ref: Ref<T> }> | ((ref: Ref<T>) => ReactElement);
children:
| ReactElement<{ ref: Ref<T> }>
| ((ref: RefObject<T | null>) => ReactElement);
};
/**
* InitialFocus sets focus on its child element
* when it mounts.
* @param {Object} props - The component props.
* @param {ReactElement | function} props.children - A single React element or a function that returns a React element.
* @param {ReactElement | function} children - A single React element or a function that returns a React element.
* The child element should have a `ref` prop for this to work. For child components which receives a ref via another prop
* e.g. `inputRef`, use a function as child and pass the ref to the appropriate prop.
*/
export function InitialFocus<T extends HTMLElement = HTMLElement>({
children,

View File

@@ -34,6 +34,7 @@ export const Popover = ({
return (
<ReactAriaPopover
data-popover={true}
ref={ref}
placement="bottom end"
offset={1}

View File

@@ -6,6 +6,8 @@ import { View } from './View';
type SpaceBetweenProps = {
direction?: 'horizontal' | 'vertical';
gap?: number;
wrap?: boolean;
align?: 'start' | 'center' | 'end' | 'stretch';
style?: CSSProperties;
children: ReactNode;
};
@@ -13,18 +15,22 @@ type SpaceBetweenProps = {
export const SpaceBetween = ({
direction = 'horizontal',
gap = 15,
wrap = true,
align = 'center',
style,
children,
...props
}: SpaceBetweenProps) => {
return (
<View
style={{
flexWrap: 'wrap',
flexWrap: wrap ? 'wrap' : 'nowrap',
flexDirection: direction === 'horizontal' ? 'row' : 'column',
alignItems: 'center',
alignItems: align,
gap,
...style,
}}
{...props}
>
{children}
</View>

View File

@@ -1,105 +0,0 @@
// @ts-strict-ignore
import React, {
Children,
type ComponentProps,
Fragment,
cloneElement,
forwardRef,
type ReactNode,
type CSSProperties,
} from 'react';
import { Text } from './Text';
import { View } from './View';
function getChildren(key, children) {
return Children.toArray(children).reduce(
(list, child) => {
if (child) {
if (
typeof child === 'object' &&
'type' in child &&
child.type === Fragment
) {
return list.concat(
getChildren(
child.key,
typeof child.props === 'object' && 'children' in child.props
? child.props.children
: [],
),
);
}
list.push({ key: key + child['key'], child });
return list;
}
return list;
},
[] as Array<{ key: string; child: ReactNode }>,
);
}
type StackProps = ComponentProps<typeof View> & {
direction?: CSSProperties['flexDirection'];
align?: string;
justify?: string;
spacing?: number;
debug?: boolean;
};
export const Stack = forwardRef<HTMLDivElement, StackProps>(
(
{
direction = 'column',
align,
justify,
spacing = 3,
children,
debug,
style,
...props
},
ref,
) => {
const isReversed = direction.endsWith('reverse');
const isHorizontal = direction.startsWith('row');
const validChildren = getChildren('', children);
return (
<View
style={{
flexDirection: direction,
alignItems: align,
justifyContent: justify,
...style,
}}
innerRef={ref}
{...props}
>
{validChildren.map(({ key, child }, index) => {
const isLastChild = validChildren.length === index + 1;
let marginProp;
if (isHorizontal) {
marginProp = isReversed ? 'marginLeft' : 'marginRight';
} else {
marginProp = isReversed ? 'marginTop' : 'marginBottom';
}
return cloneElement(
typeof child === 'string' ? <Text>{child}</Text> : child,
{
key,
style: {
...(debug && { borderWidth: 1, borderColor: 'red' }),
...(isLastChild ? null : { [marginProp]: spacing * 5 }),
...(child.props ? child.props.style : null),
},
},
);
})}
</View>
);
},
);
Stack.displayName = 'Stack';

View File

@@ -15,12 +15,14 @@ type TooltipProps = Partial<ComponentProps<typeof AriaTooltip>> & {
children: ReactNode;
content: ReactNode;
triggerProps?: Partial<ComponentProps<typeof TooltipTrigger>>;
disablePointerEvents?: boolean;
};
export const Tooltip = ({
children,
content,
triggerProps = {},
disablePointerEvents = false,
...props
}: TooltipProps) => {
const triggerRef = useRef(null);
@@ -69,7 +71,14 @@ export const Tooltip = ({
>
{children}
<AriaTooltip triggerRef={triggerRef} style={styles.tooltip} {...props}>
<AriaTooltip
triggerRef={triggerRef}
style={{
...styles.tooltip,
...(disablePointerEvents && { pointerEvents: 'none' }),
}}
{...props}
>
{content}
</AriaTooltip>
</TooltipTrigger>

View File

@@ -1,7 +1,6 @@
// @ts-strict-ignore
import path from 'path';
function indexTemplate(filePaths) {
function indexTemplate(filePaths: { path: string }[]) {
const exportEntries = filePaths.map(({ path: filePath }) => {
const basename = path.basename(filePath, path.extname(filePath));
const exportName = `Svg${basename}`;

View File

@@ -1,5 +1,6 @@
// @ts-strict-ignore
const tmpl = ({ imports, interfaces, componentName, props, jsx }, { tpl }) => {
import { type Config } from '@svgr/core';
const tmpl: Config['template'] = ({ imports, interfaces, componentName, props, jsx }, { tpl }) => {
return tpl`
${imports};

View File

@@ -21,12 +21,7 @@ export default defineConfig({
environment: 'jsdom',
globals: true,
include: ['src/**/*.web.test.(js|jsx|ts|tsx)'],
poolOptions: {
threads: {
maxThreads: 2,
minThreads: 1,
},
},
maxWorkers: 2,
},
resolve: {
alias: [

View File

@@ -20,10 +20,10 @@
"uuid": "^13.0.0"
},
"devDependencies": {
"@types/google-protobuf": "^3.15.12",
"protoc-gen-js": "^3.21.4-4",
"ts-protoc-gen": "^0.15.0",
"@types/google-protobuf": "3.15.12",
"protoc-gen-js": "3.21.4-4",
"ts-protoc-gen": "0.15.0",
"typescript": "^5.9.3",
"vitest": "^3.2.4"
"vitest": "^4.0.9"
}
}

View File

@@ -12,5 +12,5 @@
"outDir": "dist"
},
"include": ["."],
"exclude": ["dist"]
"exclude": ["dist", "**/*.test.ts", "**/*.spec.ts"]
}

View File

@@ -31,3 +31,6 @@ public/*.wasm
# translations
locale/
# service worker build output
dev-dist

Binary file not shown.

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 KiB

After

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 152 KiB

After

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

After

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 114 KiB

View File

@@ -194,47 +194,71 @@ export class AccountPage {
transaction: TransactionEntry,
) {
if (transaction.debit) {
// double click to ensure the content is selected when adding split transactions
await transactionRow.getByTestId('debit').dblclick();
await this.page.keyboard.type(transaction.debit);
const debitCell = transactionRow.getByTestId('debit');
await debitCell.click();
const debitInput = debitCell.getByRole('textbox');
await this.selectInputText(debitInput);
await debitInput.pressSequentially(transaction.debit);
await this.page.keyboard.press('Tab');
}
if (transaction.credit) {
await transactionRow.getByTestId('credit').click();
await this.page.keyboard.type(transaction.credit);
const creditCell = transactionRow.getByTestId('credit');
await creditCell.click();
const creditInput = creditCell.getByRole('textbox');
await this.selectInputText(creditInput);
await creditInput.pressSequentially(transaction.credit);
await this.page.keyboard.press('Tab');
}
if (transaction.account) {
await transactionRow.getByTestId('account').click();
await this.page.keyboard.type(transaction.account);
const accountCell = transactionRow.getByTestId('account');
await accountCell.click();
const accountInput = accountCell.getByRole('textbox');
await this.selectInputText(accountInput);
await accountInput.pressSequentially(transaction.account);
await this.page.keyboard.press('Tab');
}
if (transaction.payee) {
await transactionRow.getByTestId('payee').click();
await this.page.keyboard.type(transaction.payee);
const payeeCell = transactionRow.getByTestId('payee');
await payeeCell.click();
const payeeInput = payeeCell.getByRole('textbox');
await this.selectInputText(payeeInput);
await payeeInput.pressSequentially(transaction.payee);
await this.page.keyboard.press('Tab');
}
if (transaction.notes) {
await transactionRow.getByTestId('notes').click();
await this.page.keyboard.type(transaction.notes);
const notesCell = transactionRow.getByTestId('notes');
await notesCell.click();
const notesInput = notesCell.getByRole('textbox');
await this.selectInputText(notesInput);
await notesInput.pressSequentially(transaction.notes);
await this.page.keyboard.press('Tab');
}
if (transaction.category) {
await transactionRow.getByTestId('category').click();
const categoryCell = transactionRow.getByTestId('category');
await categoryCell.click();
if (transaction.category === 'split') {
await this.page.getByTestId('split-transaction-button').click();
} else {
await this.page.keyboard.type(transaction.category);
const categoryInput = categoryCell.getByRole('textbox');
await this.selectInputText(categoryInput);
await categoryInput.pressSequentially(transaction.category);
await this.page.keyboard.press('Tab');
}
}
}
async selectInputText(input: Locator) {
const value = await input.inputValue();
if (value) {
await input.selectText();
}
}
}
class FilterTooltip {

View File

@@ -0,0 +1,171 @@
import { type Page, type Locator } from '@playwright/test';
type ConditionsEntry = {
field: string;
op: string;
value: string;
};
type ActionsEntry = {
field: string;
op?: string;
value: string;
};
type SplitsEntry = {
field: string;
op?: string;
value?: string;
};
type RuleEntry = {
conditionsOp?: string | RegExp;
conditions?: ConditionsEntry[];
actions?: ActionsEntry[];
splits?: Array<SplitsEntry[]>;
};
export class EditRuleModal {
readonly page: Page;
readonly locator: Locator;
readonly heading: Locator;
readonly conditionsOpButton: Locator;
readonly conditionList: Locator;
readonly actionList: Locator;
readonly splitIntoMultipleTransactionsButton: Locator;
readonly saveButton: Locator;
readonly cancelButton: Locator;
constructor(locator: Locator) {
this.locator = locator;
this.page = locator.page();
this.heading = locator.getByRole('heading');
this.conditionsOpButton = locator
.getByTestId('conditions-op')
.getByRole('button');
this.conditionList = locator.getByTestId('condition-list');
this.actionList = locator.getByTestId('action-list');
this.splitIntoMultipleTransactionsButton = locator.getByTestId(
'add-split-transactions',
);
this.saveButton = locator.getByRole('button', { name: 'Save' });
this.cancelButton = locator.getByRole('button', { name: 'Cancel' });
}
async fill(data: RuleEntry) {
if (data.conditionsOp) {
await this.selectConditionsOp(data.conditionsOp);
}
if (data.conditions) {
await this.fillEditorFields(data.conditions, this.conditionList, true);
}
if (data.actions) {
await this.fillEditorFields(data.actions, this.actionList);
}
if (data.splits) {
let idx = data.actions?.length ?? 0;
for (const splitActions of data.splits) {
await this.splitIntoMultipleTransactionsButton.click();
await this.fillEditorFields(splitActions, this.actionList.nth(idx));
idx++;
}
}
}
async fillEditorFields(
data: Array<ConditionsEntry | ActionsEntry | SplitsEntry>,
rootElement: Locator,
fieldFirst = false,
) {
for (const [idx, entry] of data.entries()) {
const { field, op, value } = entry;
const row = await this.getRow(rootElement, idx);
if (!(await row.isVisible())) {
await this.addEntry(rootElement);
}
if (op && !fieldFirst) {
await this.selectOp(row, op);
}
if (field) {
await this.selectField(row, field);
}
if (op && fieldFirst) {
await this.selectOp(row, op);
}
if (value && value.length > 0) {
const input = row.getByRole('textbox');
const existingValue = await input.inputValue();
if (existingValue) {
await input.selectText();
}
// Using pressSequentially here to simulate user typing.
// When using .fill(...), playwright just "pastes" the entire word onto the input
// and for some reason this breaks the autocomplete highlighting logic
// e.g. "Create payee" option is not being highlighted.
await input.pressSequentially(value);
await this.page.keyboard.press('Enter');
}
}
}
async selectConditionsOp(conditionsOp: string | RegExp) {
await this.conditionsOpButton.click();
const conditionsOpSelectOption =
await this.getPopoverSelectOption(conditionsOp);
await conditionsOpSelectOption.click();
}
async selectOp(row: Locator, op: string) {
await row.getByTestId('op-select').getByRole('button').click();
const opSelectOption = await this.getPopoverSelectOption(op);
await opSelectOption.waitFor({ state: 'visible' });
await opSelectOption.click();
}
async selectField(row: Locator, field: string) {
await row.getByTestId('field-select').getByRole('button').click();
const fieldSelectOption = await this.getPopoverSelectOption(field);
await fieldSelectOption.waitFor({ state: 'visible' });
await fieldSelectOption.click();
}
async getRow(locator: Locator, index: number) {
return locator.getByTestId('editor-row').nth(index);
}
async addEntry(locator: Locator) {
await locator.getByRole('button', { name: 'Add entry' }).click();
}
async getPopoverSelectOption(value: string | RegExp) {
// Need to use page because popover is rendered outside of modal locator
return this.page
.locator('[data-popover]')
.getByRole('button', { name: value, exact: true });
}
async save() {
await this.saveButton.click();
}
async cancel() {
await this.cancelButton.click();
}
async close() {
await this.heading.getByRole('button', { name: 'Close' }).click();
}
}

View File

@@ -51,7 +51,7 @@ export class MobilePayeesPage {
}
/**
* Click on a payee to view/edit rules
* Click on a payee to open the edit page
*/
async clickPayee(index: number) {
const payee = this.getNthPayee(index);

View File

@@ -1,52 +1,26 @@
import { type Locator, type Page } from '@playwright/test';
type ConditionsEntry = {
field: string;
op: string;
value: string;
};
type ActionsEntry = {
field: string;
op?: string;
value: string;
};
type SplitsEntry = {
field: string;
op?: string;
value?: string;
};
type RuleEntry = {
conditionsOp?: string | RegExp;
conditions?: ConditionsEntry[];
actions?: ActionsEntry[];
splits?: Array<SplitsEntry[]>;
};
import { EditRuleModal } from './edit-rule-modal';
export class RulesPage {
readonly page: Page;
readonly searchBox: Locator;
readonly createNewRuleButton: Locator;
constructor(page: Page) {
this.page = page;
this.searchBox = page.getByPlaceholder('Filter rules...');
this.createNewRuleButton = page.getByRole('button', {
name: 'Create new rule',
});
}
/**
* Create a new rule
* Open the edit rule modal to create a new rule.
*/
async createRule(data: RuleEntry) {
await this.page
.getByRole('button', {
name: 'Create new rule',
})
.click();
await this._fillRuleFields(data);
await this.page.getByRole('button', { name: 'Save' }).click();
async createNewRule() {
await this.createNewRuleButton.click();
return new EditRuleModal(this.page.getByTestId('edit-rule-modal'));
}
/**
@@ -65,108 +39,4 @@ export class RulesPage {
async searchFor(text: string) {
await this.searchBox.fill(text);
}
async _fillRuleFields(data: RuleEntry) {
if (data.conditionsOp) {
await this.page
.getByTestId('conditions-op')
.getByRole('button')
.first()
.click();
await this.page
.getByRole('button', { exact: true, name: data.conditionsOp })
.click();
}
if (data.conditions) {
await this._fillEditorFields(
data.conditions,
this.page.getByTestId('condition-list'),
true,
);
}
if (data.actions) {
await this._fillEditorFields(
data.actions,
this.page.getByTestId('action-list'),
);
}
if (data.splits) {
let idx = data.actions?.length ?? 0;
for (const splitActions of data.splits) {
await this.page.getByTestId('add-split-transactions').click();
await this._fillEditorFields(
splitActions,
this.page.getByTestId('action-list').nth(idx),
);
idx++;
}
}
}
async _fillEditorFields(
data: Array<ConditionsEntry | ActionsEntry | SplitsEntry>,
rootElement: Locator,
fieldFirst = false,
) {
for (const [idx, entry] of data.entries()) {
const { field, op, value } = entry;
const row = rootElement.getByTestId('editor-row').nth(idx);
if (!(await row.isVisible())) {
await rootElement.getByRole('button', { name: 'Add entry' }).click();
}
if (op && !fieldFirst) {
await row.getByTestId('op-select').getByRole('button').first().click();
await this.page
.getByRole('button', { name: op, exact: true })
.first()
.waitFor({ state: 'visible' });
await this.page
.getByRole('button', { name: op, exact: true })
.first()
.click({ force: true });
}
if (field) {
await row
.getByTestId('field-select')
.getByRole('button')
.first()
.click();
await this.page
.getByRole('button', { name: field, exact: true })
.first()
.waitFor({ state: 'visible' });
await this.page
.getByRole('button', { name: field, exact: true })
.first()
.click({ force: true });
}
if (op && fieldFirst) {
await row.getByTestId('op-select').getByRole('button').first().click();
await this.page
.getByRole('button', { name: op, exact: true })
.first()
.waitFor({ state: 'visible' });
await this.page
.getByRole('button', { name: op, exact: true })
.first()
.click({ force: true });
}
if (value) {
await row.getByRole('textbox').fill(value);
await this.page.keyboard.press('Enter');
}
}
}
}

View File

@@ -0,0 +1,78 @@
import { type Page, type Locator } from '@playwright/test';
type ScheduleEntry = {
scheduleName?: string;
payee?: string;
account?: string;
amount?: number;
};
export class ScheduleEditModal {
readonly page: Page;
readonly locator: Locator;
readonly heading: Locator;
readonly scheduleNameInput: Locator;
readonly payeeInput: Locator;
readonly accountInput: Locator;
readonly amountInput: Locator;
readonly addButton: Locator;
readonly saveButton: Locator;
readonly cancelButton: Locator;
constructor(locator: Locator) {
this.locator = locator;
this.page = locator.page();
this.heading = locator.getByRole('heading');
this.scheduleNameInput = locator.getByRole('textbox', {
name: 'Schedule name',
});
this.payeeInput = locator.getByRole('textbox', { name: 'Payee' });
this.accountInput = locator.getByRole('textbox', { name: 'Account' });
this.amountInput = locator.getByLabel('Amount');
this.addButton = locator.getByRole('button', { name: 'Add' });
this.saveButton = locator.getByRole('button', { name: 'Save' });
this.cancelButton = locator.getByRole('button', { name: 'Cancel' });
}
async fill(data: ScheduleEntry) {
// Using pressSequentially on autocomplete fields here to simulate user typing.
// When using .fill(...), playwright just "pastes" the entire word onto the input
// and for some reason this breaks the autocomplete highlighting logic
// e.g. "Create payee" option is not being highlighted.
if (data.scheduleName) {
await this.scheduleNameInput.fill(data.scheduleName);
}
if (data.payee) {
await this.payeeInput.pressSequentially(data.payee);
await this.page.keyboard.press('Enter');
}
if (data.account) {
await this.accountInput.pressSequentially(data.account);
await this.page.keyboard.press('Enter');
}
if (data.amount) {
await this.amountInput.fill(String(data.amount));
}
}
async save() {
await this.saveButton.click();
}
async add() {
await this.addButton.click();
}
async cancel() {
await this.cancelButton.click();
}
async close() {
await this.heading.getByRole('button', { name: 'Close' }).click();
}
}

View File

@@ -1,10 +1,6 @@
import { type Locator, type Page } from '@playwright/test';
type ScheduleEntry = {
payee?: string;
account?: string;
amount?: number;
};
import { ScheduleEditModal } from './schedule-edit-modal';
export class SchedulesPage {
readonly page: Page;
@@ -21,17 +17,12 @@ export class SchedulesPage {
}
/**
* Add a new schedule
* Open the schedule edit modal.
*/
async addNewSchedule(data: ScheduleEntry) {
async addNewSchedule() {
await this.addNewScheduleButton.click();
await this._fillScheduleFields(data);
await this.page
.getByTestId('schedule-edit-modal')
.getByRole('button', { name: 'Add' })
.click();
return new ScheduleEditModal(this.page.getByTestId('schedule-edit-modal'));
}
/**
@@ -83,26 +74,4 @@ export class SchedulesPage {
await actions.getByRole('button').click();
await this.page.getByRole('button', { name: actionName }).click();
}
async _fillScheduleFields(data: ScheduleEntry) {
if (data.payee) {
await this.page.getByRole('textbox', { name: 'Payee' }).fill(data.payee);
await this.page.keyboard.press('Enter');
}
if (data.account) {
await this.page
.getByRole('textbox', { name: 'Account' })
.fill(data.account);
await this.page.keyboard.press('Enter');
}
if (data.amount) {
await this.page.getByLabel('Amount').fill(String(data.amount));
// For some readon, the input field does not trigger the change event on tests
// but it works on the browser. We can revisit this once migration to
// react aria components is complete.
await this.page.keyboard.press('Enter');
}
}
}

View File

@@ -62,7 +62,7 @@ test.describe('Mobile Payees', () => {
await expect(page).toMatchThemeScreenshots();
});
test('clicking on a payee opens rule creation form', async () => {
test('clicking on a payee opens payee edit page', async () => {
await payeesPage.waitForLoadingToComplete();
const payeeCount = await payeesPage.getPayeeCount();
@@ -70,8 +70,16 @@ test.describe('Mobile Payees', () => {
await payeesPage.clickPayee(0);
// Should navigate to rules page for creating a new rule
await expect(page).toHaveURL(/\/rules/);
// Should navigate to payee edit page
await expect(page).toHaveURL(/\/payees\/.+/);
// Check that the edit page elements are visible
await expect(
page.getByRole('heading', { name: 'Edit Payee' }),
).toBeVisible();
await expect(page.getByPlaceholder('Payee name')).toBeVisible();
await expect(page.getByRole('button', { name: 'Save' })).toBeVisible();
await expect(page).toMatchThemeScreenshots();
});

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 93 KiB

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 119 KiB

After

Width:  |  Height:  |  Size: 116 KiB

Some files were not shown because too many files have changed in this diff Show More