[Slurm SPANK](https://slurm.schedmd.com/spank.html) plugin for enhancing energy monitoring within a [SLURM](https://slurm.schedmd.com/) cluster (in particular for nodes featuring GPU accelerators).
## Installation / Repository Setup
This repository is hosted on [Gitlab @ Uni.lu](https://gitlab.uni.lu/sohpc/slurm-spank-energy-reporting).
* Git interactions with this repository (push, pull etc.) are performed over SSH using the port 8022
* To clone this repository, proceed as follows (adapt accordingly):
**`/!\ IMPORTANT`**: Once cloned, initiate your local copy of the repository by running:
$> cd slurm-spank-energy-reporting
$> make setup
This will initiate the [Git submodules of this repository](.gitmodules) and setup the [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) layout for this repository.
Later on, you can update the local branches of your working copy using
$> make up
If upon this command, you end in what seems to be a _dirty_ state within one of the Git submodule, it means that one of your collaborator **upgrade** and commit the current version of the git submodules (using `make upgrade` -- thus is typically useful to grab commits from any of the tied Github repository). To solve it, just update manually the submodules:
$> git submodule update
## Issues / Feature request
You can submit bug / issues / feature request using the [`SoHPC/slurm-spank-energy-reporting` Project Tracker](https://gitlab.uni.lu/sohpc/slurm-spank-energy-reporting/issues)
In particular, the central repository holds two main branches with an infinite lifetime:
*`production`: the *production-ready* branch
*`master`: the main branch where the latest developments interviene. This is the *default* branch you get when you clone the repository.
Thus you are more than encouraged to install the [git-flow](https://github.com/petervanderdoes/gitflow-avh)(AVH Edition, as the traditional one is no longer supported) extensions following the [installation procedures](https://github.com/petervanderdoes/gitflow-avh/wiki/Installation) to take full advantage of the proposed operations. The associated [bash completion](https://github.com/bobthecow/git-flow-completion) might interest you also.
### Releasing mechanism
The operation consisting of releasing a new version of this repository is automated by a set of tasks within the root `Makefile`.
In this context, a version number have the following format:
<major>.<minor>.<patch>[-b<build>]
where:
*`< major >` corresponds to the major version number
*`< minor >` corresponds to the minor version number
*`< patch >` corresponds to the patching version number
* (eventually) `< build >` states the build number _i.e._ the total number of commits within the `master` branch.
Example: \`1.0.0-b28\`
The current version number is stored in the root file `VERSION`. __/!\ NEVER MAKE ANY MANUAL CHANGES TO THIS FILE__
For more information on the version, run:
$> make versioninfo
If a new version number such be bumped, you simply have to run:
$> make start_bump_{major,minor,patch}
This will start the release process for you using `git-flow`.
Once you have finished to commit your last changes, make the release effective by running:
$> make release
It will finish the release using `git-flow`, create the appropriate tag in the `production` branch and merge all things the way they should be.
