Add intial documentation on dev.eessi.io
#321
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`dev.eessi.io` overview and instructions
Build page from dev branch
boegel
requested changes
Oct 10, 2024
| `dev.eessi.io` is the development repository of EESSI. With it, developers can build and deploy non-production ready versions of their software to a CernVM-FS repository. | ||
| This way, development version can easily be tested on systems where `dev.eessi.io` is available. | ||
|
|
||
| On a system with `dev.eessi.io` mounted access is possible with `module use /cvmfs/dev.eessi.io/versions/2023.06/modules/all`. Then, all that is left is |
There was a problem hiding this comment.
This will change when we use subdirectories for projects
There was a problem hiding this comment.
In fact, we probably (eventually) want a small custom init script for dev.eessi.io which:
- prints a warning (something like "
installations indev.eessi.ioare not for production use, only for testing"); - sets up the environment for
software.eessi.io; - sets up the environment for a specific (set of) projects in
dev.eessi.io;
|
|
||
| ## What is `dev.eessi.io`? | ||
|
|
||
| `dev.eessi.io` is the development repository of EESSI. With it, developers can build and deploy non-production ready versions of their software to a CernVM-FS repository. This way, development version can easily be tested on systems where `dev.eessi.io` is available. |
There was a problem hiding this comment.
This should just point to repositories/dev.eessi.io.md
|
|
||
| ## Adding software | ||
|
|
||
| Using `dev.eessi.io` is similar to using EESSI's production repository `software.eessi.io`. Software builds are triggered by a bot listening to pull requests in GitHub repository (at the moment https://github.com/EESSI/dev.eessi.io). This repository is organised by project, where corresponding easystack files and easyconfig files are placed. |
There was a problem hiding this comment.
We'll probably ends up with separate repos per project, so point to https://github.com/search?q=org%3AEESSI+dev.eessi.io&type=repositories ?
| ### Easystack files and triggering builds | ||
|
|
||
| After the easyconfig file has been created and added to `projectX/easyconfigs`, an easystack file that picks it up | ||
| needs to be in place. This easystack file must follow a naming convention: `software-eb-X.Y.Z-dev.yml`, |
There was a problem hiding this comment.
Make the part about the filename a note that pops out a bit (see https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage)
| software-commit: 2ba17de6096933275abec0550981d9122e4e5f28 # release 4.2.2 | ||
| ``` | ||
|
|
||
| The `ESPResSo-4.2.2-foss-2023a-software-commit.eb` would be the easyconfig file added in the step above. |
There was a problem hiding this comment.
rename to ESPResSo-devel-foss-2023a.eb ?
| Note the option passing the `software-commit` for the development version that should be built. | ||
| For the sake of this example, the chosen commit actually corresponds to the 4.2.2 release. | ||
|
|
||
| To trigger a build, all one needs to do is open a PR with the changes adding the easyconfig and easystack |
|
|
||
| Once a build is complete and the `bot:deploy` label is added, a staging PR can be merged to deploy the | ||
| application to the `dev.eessi.io` cvmfs repository. On a system with `dev.eessi.io` mounted, then all | ||
| that is left is to `module use /cvmfs/dev.eessi.io/versions/2023.06/modules/all` and try out the software! |
There was a problem hiding this comment.
module use needs project subdir
Co-authored-by: Kenneth Hoste <[email protected]>
Co-authored-by: Kenneth Hoste <[email protected]>
Co-authored-by: Kenneth Hoste <[email protected]>
Co-authored-by: Kenneth Hoste <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds information on the
dev.eessi.ioCVMFS repository and basic usage wrt building and deploying software todev.eessi.io.This information will likely change in the future as the repo matures, but this should already provide a brief overview of the basic functionality.