Castellan
How-to · Castellan
Your own repositories
List the repositories on this PC that you want the developers' staff to look after, and choose what each may do with them, from Castellan's Settings.
- Article
- 1108
- Applies to
- Castellan 0.16.51
- Last reviewed
- For
- For developers
One list, read by every agent#
Settings > Repositories is the list of your repositories on this PC that the developers' staff look after: your own projects, a fork, a client's code. Every agent reads the same list, so you add a repository once. It's shown once a developer agent is hired.
What a repository on the list gets, with the right staff hired:
- Reeve's rounds: dependency health, upgrades, security alerts and failing tests, and merged branches cleaned up if you allow it. See Reeve's rounds.
- The Assayer's tests of its local branches, with pull requests opened or marked ready for you. The Assayer never merges.
- The Steward: its versions kept, and its ready pull requests merged and its versions released, each only where you say so below. See The Steward.
Add a repository#
- Open Settings > Repositories, and choose Add a repository.
- Fill in the form. Only Name and Checkout are needed; the fields are below.
- Choose Save. The list shows each repository with whether its checkout is on this PC and is a git clone.
Edit on a repository opens the same form again. Remove asks first, then takes it off the list; its clone stays as it is, and nothing in it changes.
The fields
| Field | What it's for |
|---|---|
| Name | What the page calls it: up to 60 characters, one name to a repository. |
| Checkout | The full path of its clone on this PC, such as D:\Code\example. One entry to a clone. |
| Repository | Its repository on GitHub, as owner/name, if it has one. |
| Branch | The branch its work goes to: main unless you say. |
| Tests | The command the Assayer runs its tests with, in its checkout, such as npm test. |
| Version files | The files its version is set in, such as package.json, package-lock.json. Leave it empty and the manor never changes this repository's version. |
| Release | How the Steward releases the version on its branch: tag (a GitHub release of the branch), or a command run in a fresh copy of it. Leave it empty and it's never released. Needs Repository and Version files. |
| Clean up merged branches | Reeve deletes branches already merged into its branch, in this clone, and on GitHub only for repositories you list in Reeve's settings; unmerged ones are only reported. On unless you untick it, once Reeve's project-branches job is turned on. |
| The Steward merges ready pull requests | Your team's pull requests into its branch are merged once their checks pass, in version order. Off, they're only listed. Needs Repository. |
Good to know#
- Nothing merges or releases without your say-so. Merging needs The Steward merges ready pull requests ticked, and releasing needs Release filled in.
- A clone that's gone stays listed, and the page says so, until you remove it or it's back.
- Castellan's own repositories can't be added.
- The list is in every settings backup.
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 1108. Every version of Castellan, and what changed in it, is in its release notes.