...
| files | description |
|---|---|
README | short description + few usage examples |
actor_install.py | script that automates the build of IMAS actor(s) |
TEMPLATE.yml | template description of a released project(s)/actor(s) |
*.yml | list of currently released project(s)/actor(s) |
...
Description of a release
Start by taking a look at TEMPLATE.yml, and adapt the different information to your own needs for the targeted project/actors.
This YAML file contains five mandatory sections (mappings) as follow:
| mappingssections | description | content | associated options | |||
|---|---|---|---|---|---|---|
SOURCES: | (required) information on Version Control System | list (sequence) of mappings | description |
--skipSources -R | ||
VCS: | (required) type of Version Control System | |||||
REPO: | (required) URL of the repository, including path to branch/tag | |||||
DIR: | (required) target directory in which to store the this project sources | |||||
VERSION: | (optional) target version of the sources | |||||
MODULES: | (required) information on module environment required | sequence of modules, e.g. | after purge, list of modules will be loaded, while already loaded | -M premodule | ||
BUILDS: | (required) information on how to build the libraries | sequence of build mappings | description |
--skipBuilds | ||
| DIR: | directory from which the build command should be executed | |||||
| CMD: | build command (script, makefile, etc...) | |||||
ACTORS: | (required) information on where FC2K project files are stored | sequence of FC2K mappings | description |
--skipActors | ||
DIR: | directory from which fc2k should be executed | |||||
| XML: | path to FC2K project file for a given actor | |||||
COMMENTS: | (optional) any comments, notes, documentation | |||||
Note: all path are given relatively to the working directory (created automatically inside the current directory) or specified with option -D path
How-to test and publish a release
One the YAML file is written, you can use the actor_install.py script to install it in your Kepler. As explain in the help accessible with option -h / --help, It takes as last argument(s) the YAML file(s).
If no error where discover during all the steps (you can use option -p / --pedantic to stop at first encounter error) you can commit you YAML file to the repository.