Disclaimer: this is currently mainly targeting ETS release so it uses WPCD resources (SVN repository and existing procedures) at the moment. If the support script is ready to be used, the procedure itself is still being updated, so places and steps are subject to changes.
Prerequisites
1. Checkout the trunk/IMAS of the actor_release SVN repository on GFORGE (the repo itself is shared for both CPO and IDS actor releases).
...
Released actors descriptions and build script can be obtained from https://gforge6.eufus.eu/svn/actor_release/trunk/IMAS
2. Request access to the actor_release project directly on GFORGE if needed: https://gforge6.eufus.eu/gf/project/actor_release, request button on the top right under the activity graph.
3. You will need access to the targeted repository through a mean which do not involve typing interactively a password (or a passphrase): recommended way is to use a ssh-key, and using ssh-agent and ssh-add in case you've set a passphrase for your private key.
Content of the repository
| 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:
...
SOURCES:...
(required) information on Version Control System
where the sources of the project(s) are stored
...
list (sequence) of mappings
...
--skipSources...
VCS:...
REPO:...
-R--checkRevision...
DIR:...
VERSION:...
MODULES:...
(required) information on module environment required
to attempt the build of the libraries
...
sequence of modules, e.g.
[imasenv, fc2k/4.3.0]
...
after purge, list of modules will be loaded, while already
loaded modules will be switched to specified version
...
-M premodule...
--skipModules...
BUILDS:...
--skipBuilds...
ACTORS:...
--skipActorsDocumentation below is generated from the repository's README.md
| View file | ||||
|---|---|---|---|---|
|
...
DIR:
...
COMMENTS:...
Note: all path are given relatively to the working directory (created automatically inside the current directory) or specified with option -D working_dir_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.
Release logs (work-in-progress)
Feature has been added to keep a log of all of the projects that have been installed; This is not yet fully in production, so log file (RELEASE.yaml) is created locally at the moment instead of being installed and updated in Kepler directory.