Opening a pull request¶
To add software to EESSI, you should go through the semi-automatic software installation procedure by:
- 1) Making a pull request to the software-layer repository to (add or) update an easystack file that is used by EasyBuild to install software;
- 2) Instructing the bot to build the software on all supported CPU microarchitectures;
- 3) Instructing the bot to deploy the built software for ingestion into the EESSI repository;
- 4) Merging the pull request once CI indicates that the software has been ingested.
Make sure you are also aware of our contribution policy when adding software to EESSI.
For the remainder of these instructions, we assume that your GitHub account is
Don't forget to replace
koala with the name of your GitHub account in the commands below!
1) Clone the EESSI/software-layer repository:
2) Add your fork as a remote
3) Check out the branch that corresponds to the version of EESSI repository you want to add software to,
The commands above only need to be run once, to prepare your setup for making pull requests.
Creating a pull request¶
1) Make sure that your
2023.06 branch in the checkout of the
EESSI/software-layer repository is up-to-date
2) Create a new branch (use a sensible name, not
example_branch as below), and check it out
3) Determine the correct easystack file to change, and add one or more lines to it that specify which easyconfigs should be installed
4) Stage and commit the changes into your your branch with a sensible message
5) Push your branch to your fork of the software-layer repository
6) Go to the GitHub web interface to open your pull request,
or use the helpful link that should show up in the output of the
git push command.
Make sure you target the correct branch: the one that corresponds to the version of EESSI you want to add
software to (like
If all goes well, one or more bots should almost instantly create a comment in your pull request with an overview of how it is configured - you will need this information when providing build instructions.