22<a target =" _blank " href =" https://travis-ci.org/epics-base/ci-scripts " >![ Travis status] [ badge.travis ] </a >
33<a target =" _blank " href =" https://ci.appveyor.com/project/epics-base/ci-scripts " >![ AppVeyor status] [ badge.appveyor ] </a >
44
5- # Continuous Integration Scripts for EPICS Modules
5+ # Continuous Integration for EPICS Modules
66
77The scripts inside this repository are intended to provide a common,
88easy-to-use and flexible way to add Continuous Integration to EPICS
@@ -16,7 +16,7 @@ including a way to specify sets of dependent modules
1616By using the submodule mechanism, your module will always use an
1717explicit commit, i.e. a fixed version of the scripts.
1818This ensures that any further development of the ci-scripts will
19- never break existing use.
19+ never break your existing use.
2020
2121## This Repository
2222
@@ -25,20 +25,23 @@ contains service specific documentation and example configuration files
2525(in the subdirectories), and a small test suite that is used to verify
2626functionality and features of the ci-scripts module itself
2727
28- You are welcome to use the test suite as a reference, but keep in
28+ The example files are your best reference. They are kept up-to-date and
29+ show a fully-featured and a minimal setup.
30+
31+ You are welcome to use the test suite as a secondary reference, but keep in
2932mind that in your main module the path to the scripts has one level more
3033(e.g., ` ./abc ` here would be ` ./.ci/abc ` in your
3134module).
32- Also, a test suite might not show the same quality and documentation levels
33- as an example.
35+ Also, the test suite does not show the same quality and documentation
36+ levels as the example files .
3437
3538## Features
3639
3740 - Compile against different branches or releases of EPICS Base and
3841 additional dependencies (modules like asyn, std, sequencer, etc.).
3942
40- - Define settings files that declare sets of dependencies
41- with their versions and locations.
43+ - Define setup files that declare sets of dependencies with their
44+ versions and locations.
4245
4346 - Define hooks for any dependency.
4447 Hooks are run on the dependency module before it is compiled, so
@@ -119,8 +122,8 @@ for more details.
119122
120123# # Calling the cue.py Script
121124
122- Independent from CI service and platform, the runner
123- script is called from your main configuration as:
125+ Independent from CI service and platform, the runner script is called
126+ from your main configuration as:
124127
125128` python .ci/cue.py < action> `
126129
@@ -326,25 +329,25 @@ them to the environment variable `CHOCO`.
326329
327330## Frequently Asked Questions
328331
329- ** How can I see what the dependency building jobs are actually doing?**
332+ ##### How can I see what the dependency building jobs are actually doing?
330333
331334Set `VV=1` in the configuration line of the job you are interested in.
332335This will make all builds (not just for your module) verbose.
333336
334- ** How do I update my module to use a newer minor release of ci-scripts?**
337+ ##### How do I update my module to use a newer minor release of ci-scripts?
335338
336339Update the submodule in `.ci` first, then change your CI configuration
337340(if needed) and commit both to your module. E.g., to update your Travis
338- setup to release 2.3.5 of ci-scripts:
341+ setup to release 3.0.1 of ci-scripts:
339342```bash
340343cd .ci
341- git pull origin v2.3.5
344+ git pull origin v3.0.1
342345cd -
343346git add .ci
344347 # if needed:
345- edit .travis.yml
348+ edit .travis.yml # and/or .appveyor.yml
346349 git add .travis.yml
347- git commit -m "Update ci-scripts submodule to v2.3.5 "
350+ git commit -m "Update ci-scripts submodule to v3.0.1 "
348351```
349352
350353Check the example configuration files inside ci-scripts (and their
@@ -356,11 +359,17 @@ be advisable to clear the CI caches after updating ci-scripts. E.g.,
356359a change in setting up EPICS Base will not be applied if Base is found
357360in the cache.
358361
359- ** How do I add a dependency module only for a specific job?**
362+ ##### How do I add a dependency module only for a specific job?
360363
361364Add the additional dependency in the main configuration file by setting
362365`ADD_MODULES` for the specific job(s).
363366
367+ ##### Why the name _cue_?
368+
369+ The noun _cue_ is defined as "_a signal (such as a word, phrase, or bit of
370+ stage business) to a performer to begin a specific speech or action_".
371+ (Merriam-Webster)
372+
364373## Release Numbering of this Module
365374
366375The module tries to apply [Semantic Versioning](https://semver.org/).
@@ -374,6 +383,7 @@ is created.
374383
375384Minor release numbers refer to additions and enhancements that do not
376385require the configuration inside an existing user module to be changed.
386+ (Unless for using a new feature.)
377387
378388Again: using the git submodule mechanism to include these scripts means
379389that user modules always work with a fixed, frozen version.
0 commit comments