jdb/strawboss
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarified language in the README around cached project configurations.

Browse Source
This commit is contained in:
Jonathan Bernard 2017-04-25 12:52:33 -05:00
parent ec967ec2bf
commit 81674dfa3f
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -184,16 +184,19 @@ files.
##### Cached configuration files.
The cached project configuration files follow this naming convention:
`configuration.<version>.json`. StrawBoss uses the file modification time to
determine which configuration file is the most recent. These cached versions of
the project configration are only intended to be used in cases where StrawBoss
is not building anything and doesn't check out a copy of the repo. For example,
when a client queries the REST API for the list of steps in a project,
StrawBoss will consult the most recently modified cached copy of the project
configuration rather than cloning the entire repo just to answer this question.
Whenever StrawBoss has a copy of the repo, it should look for the actual
configuration file in that version of the repo instead of consulting the cached
configuration files.
`configuration.<version>.json`. These cached versions of the project
configration are only intended to be used in cases where StrawBoss is not
building anything and doesn't check out a copy of the repo. For example, when a
client queries the REST API for the list of steps in a project, StrawBoss will
consult the most recently modified cached copy of the project configuration
rather than cloning the entire repo just to answer this question. Whenever
StrawBoss has a copy of the repo, it should look for the actual configuration
file in that version of the repo instead of consulting the cached configuration
files. When determining the "most recent" cached copy, StrawBoss uses the
modification time of the files, again to avoid cloning the repo. API access to
project configurations in this manner is intended as a convenience. The actual
project configuration in the project repository should be considered the source
of truth.
##### Step and Version Directories