Castellan
Reference · Assayer
The Assayer's settings, files and commands
Every setting with its default, where the Assayer keeps its files, its command line, and its local API.
- Article
- 1804
- Applies to
- Assayer 0.2.4
- Last reviewed
- For
- For developers
Settings#
On its page, under Settings in the title bar. Each shows its value, its default and a line on what it does, with Reset to default. They're kept in %USERPROFILE%\.assayer\settings.json.
| Setting | Default | What it does |
|---|---|---|
| Its jobs | All on | Your branches, A daily health run, Release ready, and the drafts job. See The Assayer's jobs. |
| Test cases you set | None | Each a Project, a Case, a Command (empty: the one it found), and Run it. |
| Test only what a change reaches | On | A branch's unit tests run only the test files its change reaches. |
| Leave a branch alone for | 2 hours | Since its newest commit, before it's tested. 0 to 168; 0: as soon as it's seen. |
| Tell me on this PC | On | A Windows notification when a pull request is ready for you. |
| Looks every | 15 minutes | Between rounds while on duty, 5 to 240. |
| Stop a test run after (Advanced) | 20 minutes | A run that takes longer is stopped, with everything it started, and counts as a failure. 1 to 120. |
Files#
Installed in %USERPROFILE%\.assayer\app, with its data in %USERPROFILE%\.assayer: its settings, its runs and their output, and the throwaway worktrees it tests in. ASSAYER_HOME moves its data folder, and ASSAYER_PORT its page.
Commands#
Run with node $HOME\.assayer\app\src\cli.ts <command>:
| Command | What it does |
|---|---|
run | One round now. |
start | On duty: its rounds run on their schedule, and its page is up. Castellan's Start. |
stop | Off duty: its rounds pause. The page stays up. Castellan's Stop. |
open | Makes sure its page is up, without changing duty. |
shutdown | Ends its page's process. |
status | On duty or not. --json prints what Castellan reads. |
uninstall | Removes it and its sign-in task. --purge removes its data too; --dry-run says what it would do. |
Local API#
At http://assayer.localhost:20909/, answering only this PC:
| Address | What it answers |
|---|---|
GET /api/ping | Its version and duty, with needsYou: the ready pull requests still open. |
GET /api/assay | What's ready, the last runs, the tests and release ready, as JSON. |
POST /api/putback | Puts back the tool versions ticked on one run. Needs the token from its own page. |
While developer features are off, none of this carries its work, and what would start work is refused.
Related articles
Is this page right?
If something on it is wrong or out of date, tell us and we'll fix the page.
Still stuck? Write to support@castellan-software.com and mention article 1804. Every version of Assayer, and what changed in it, is in its release notes.