Skip to content

Adding recipes to Idaholab

brianmoose edited this page Dec 2, 2016 · 1 revision

Civet now relies on a separate Git repository to store all recipe information. Recipes are in python ConfigParser format. See INL civet_example_recipes for examples. The general procedure is the following:

  1. Fork github.com:idaholab/civet_recipes

  2. Clone your fork:

    git clone git@github.com:<username>/civet_recipes

  3. Create a feature branch off of devel

    git checkout devel

    git checkout -b feature_branch

  4. Make changes and commit and push back up to Github.

    git commit -a -m"Git commit message"

    git push origin feature_branch

  5. Submit a pull request against idaholab/civet_recipes devel branch. This will initiate testing and make sure your changes are valid. Someone will need to review and merge your pull request before it will be active.

Two of the most important parts of the recipe file are:

  • build_user: The user that this recipe will be attached to. Jobs created from this recipe can only be run with clients that know the build key assigned to this user. For example, if you put your username here then the INL clients will NOT run these recipes and you will have to run your own client.
  • repository: The repository that the Civet server will receive events for. This can be any repository on any supported Git server (GitHub, GitLab, BitBucket) that we can receive events for.
Clone this wiki locally