Skip to content

GitLab

Commits (9)
Hide whitespace changes
Inline Side-by-side
.falkor/config 0 → 100644
View file @ c37a8cd8
# config
# /!\ DO NOT EDIT THIS FILE: it has been automatically generated
---
:project:
:name: slurm-spank-energy-reporting
:type:
- :none
:by: SoHPC
:author: Matteo Stringher
:mail: stringher.matteo@gmail.com
:summary: Slurm SPANK plugin for enhancing energy monitoring within a SLURM cluster
(in particular for nodes featuring GPU accelerators).
:description: Slurm SPANK plugin for enhancing energy monitoring within a SLURM
cluster (in particular for nodes featuring GPU accelerators).
:forge: :gitlab
:source: https://gitlab.uni.lu/sohpc/slurm-spank-energy-reporting
:project_page: https://gitlab.uni.lu/sohpc/slurm-spank-energy-reporting
:origin: ssh://git@gitlab.uni.lu:8022/sohpc/public/slurm-spank-energy-reporting.git
:license: none
:issues_url: https://gitlab.uni.lu/sohpc/slurm-spank-energy-reporting/issues
:tags: []
:gitflow:
:branches:
:master: production
:develop: master
.gitmodules 0 → 100644
View file @ c37a8cd8
[submodule ".submodules/Makefiles"]
path = .submodules/Makefiles
url = https://github.com/Falkor/Makefiles.git
branch = devel
Makefiles @ 0005900d
Subproject commit 0005900d7ec1a9ba9126be9f626be4f35896a4f6
Makefile 0 → 100644
View file @ c37a8cd8
####################################################################################
# Makefile (configuration file for GNU make - see http://www.gnu.org/software/make/)
# Time-stamp: <Fri 2018-11-30 00:30 svarrette>
# __ __ _ __ _ _
# | \/ | __ _| | _____ / _(_) | ___
# | |\/| |/ _` | |/ / _ \ |_| | |/ _ \
# | | | | (_| | < __/ _| | | __/
# |_| |_|\__,_|_|\_\___|_| |_|_|\___|
#
# Copyright (c) 2012 Sebastien Varrette <Sebastien.Varrette@uni.lu>
# . http://varrette.gforge.uni.lu
#
####################################################################################
#
############################## Variables Declarations ##############################
SHELL = /bin/bash
UNAME = $(shell uname)
# Some directories
SUPER_DIR = $(shell basename `pwd`)
# Git stuff management
HAS_GITFLOW = $(shell git flow version 2>/dev/null || [ $$? -eq 0 ])
LAST_TAG_COMMIT = $(shell git rev-list --tags --max-count=1)
LAST_TAG = $(shell git describe --tags $(LAST_TAG_COMMIT) )
TAG_PREFIX = "v"
# GITFLOW_BR_MASTER = $(shell git config --get gitflow.branch.master)
# GITFLOW_BR_DEVELOP = $(shell git config --get gitflow.branch.develop)
GITFLOW_BR_MASTER=production
GITFLOW_BR_DEVELOP=master
CURRENT_BRANCH = $(shell git rev-parse --abbrev-ref HEAD)
GIT_BRANCHES = $(shell git for-each-ref --format='%(refname:short)' refs/heads/ | xargs echo)
GIT_REMOTES = $(shell git remote | xargs echo )
GIT_ROOTDIR = $(shell git rev-parse --show-toplevel)
GIT_HOOKSDIR = .git/hooks
SRC_HOOKSDIR = config/hooks
#SRC_HOOKSDIR_TO_ROOTDIR = $(shell git -C "$(GIT_ROOTDIR)/$(SRC_HOOKSDIR)" rev-parse --show-cdup)
SRC_PRECOMMIT_HOOK = $(wildcard $(SRC_HOOKSDIR)/pre-commit*.sh)
GIT_DIRTY = $(shell git diff --shortstat 2> /dev/null | tail -n1 )
# Git subtrees repositories
# Format: '<url>[|<branch>]' - don't forget the quotes. if branch is ignored, 'master' is used
#GIT_SUBTREE_REPOS = 'https://github.com/ULHPC/easybuild-framework.git|develop' \
'https://github.com/hpcugent/easybuild-wiki.git'
GITSTATS = ./.submodules/gitstats/gitstats
GITSTATS_DIR = gitstats
# Branches to update on 'make up'
GIT_BRANCHES_TO_UPDATE = $(GITFLOW_BR_DEVELOP) $(GITFLOW_BR_MASTER)
ifeq (,$(wildcard .bumpversion.cfg))
VERSION = $(shell [ -f VERSION ] && head VERSION || echo '0.0.1')
else
VERSION = $(shell bumpversion --dry-run --allow-dirty --list minor | grep current_version | cut -d '=' -f 2)
endif
# OR try to guess directly from the last git tag
#VERSION = $(shell git describe --tags $(LAST_TAG_COMMIT) | sed "s/^$(TAG_PREFIX)//")
MAJOR = $(shell echo $(VERSION) | sed "s/^\([0-9]*\).*/\1/")
MINOR = $(shell echo $(VERSION) | sed "s/[0-9]*\.\([0-9]*\).*/\1/")
PATCH = $(shell echo $(VERSION) | sed "s/[0-9]*\.[0-9]*\.\([0-9]*\).*/\1/")
# total number of commits
BUILD = $(shell git log --oneline | wc -l | sed -e "s/[ \t]*//g")
#REVISION = $(shell git rev-list $(LAST_TAG).. --count)
ifeq (,$(wildcard .bumpversion.cfg))
NEXT_MAJOR_VERSION = $(shell expr $(MAJOR) + 1).0.0-b$(BUILD)
NEXT_MINOR_VERSION = $(MAJOR).$(shell expr $(MINOR) + 1).0-b$(BUILD)
NEXT_PATCH_VERSION = $(MAJOR).$(MINOR).$(shell expr $(PATCH) + 1)-b$(BUILD)
else
NEXT_MAJOR_VERSION = $(shell expr $(MAJOR) + 1).0.0
NEXT_MINOR_VERSION = $(MAJOR).$(shell expr $(MINOR) + 1).0
NEXT_PATCH_VERSION = $(MAJOR).$(MINOR).$(shell expr $(PATCH) + 1)
endif
# Default targets
TARGETS =
# Local configuration - Kept for compatibity reason
LOCAL_MAKEFILE = .Makefile.local
# Makefile custom hooks
MAKEFILE_BEFORE = .Makefile.before
MAKEFILE_AFTER = .Makefile.after
### Main variables
.PHONY: all archive clean fetch help release setup setup_git_hooks start_bump_major start_bump_minor start_bump_patch subtree_setup subtree_up subtree_diff test upgrade versioninfo doc
############################### Now starting rules ################################
# Load local settings, if existing (to override variable eventually)
ifneq (,$(wildcard $(LOCAL_MAKEFILE)))
include $(LOCAL_MAKEFILE)
endif
ifneq (,$(wildcard $(MAKEFILE_BEFORE)))
include $(MAKEFILE_BEFORE)
endif
# Required rule : what's to be done each time
all: $(TARGETS)
# Test values of variables - for debug purposes
info:
@echo "--- Compilation commands --- "
@echo "HAS_GITFLOW -> '$(HAS_GITFLOW)'"
@echo "--- Directories --- "
@echo "SUPER_DIR -> '$(SUPER_DIR)'"
@echo "--- Git stuff ---"
@echo "GIT_ROOTDIR -> '$(GIT_ROOTDIR)'"
@echo "GITFLOW -> '$(GITFLOW)'"
@echo "GITFLOW_BR_MASTER -> '$(GITFLOW_BR_MASTER)'"
@echo "GITFLOW_BR_DEVELOP -> '$(GITFLOW_BR_DEVELOP)'"
@echo "CURRENT_BRANCH -> '$(CURRENT_BRANCH)'"
@echo "GIT_BRANCHES -> '$(GIT_BRANCHES)'"
@echo "GIT_REMOTES -> '$(GIT_REMOTES)'"
@echo "GIT_DIRTY -> '$(GIT_DIRTY)'"
@echo "GIT_SUBTREE_REPOS -> '$(GIT_SUBTREE_REPOS)'"
@echo "GIT_BRANCHES_TO_UPDATE -> '$(GIT_BRANCHES_TO_UPDATE)'"
@echo "GIT_HOOKSDIR -> '$(GIT_HOOKSDIR)'"
@echo "SRC_HOOKSDIR -> '$(SRC_HOOKSDIR)'"
@echo "SRC_HOOKSDIR_TO_ROOTDIR-> '$(SRC_HOOKSDIR_TO_ROOTDIR)'"
@echo "SRC_PRECOMMIT_HOOK -> '$(SRC_PRECOMMIT_HOOK)'"
@echo ""
@echo "Consider running 'make versioninfo' to get info on git versionning variables"
############################### Archiving ################################
archive: clean
tar -C ../ -cvzf ../$(SUPER_DIR)-$(VERSION).tar.gz --exclude ".svn" --exclude ".git" --exclude "*~" --exclude ".DS_Store" $(SUPER_DIR)/
############################### Git Bootstrapping rules ################################
setup:
-git fetch origin
-git branch --track $(GITFLOW_BR_MASTER) origin/$(GITFLOW_BR_MASTER)
git config gitflow.branch.master $(GITFLOW_BR_MASTER)
git config gitflow.branch.develop $(GITFLOW_BR_DEVELOP)
git config gitflow.prefix.feature feature/
git config gitflow.prefix.release release/
git config gitflow.prefix.hotfix hotfix/
git config gitflow.prefix.support support/
git config gitflow.prefix.versiontag $(TAG_PREFIX)
-$(MAKE) update
$(if $(GIT_SUBTREE_REPOS), $(MAKE) subtree_setup)
@if [ -d "$(GIT_ROOTDIR)/$(SRC_HOOKSDIR)" ]; then \
echo "=> setup local git hooks"; \
$(MAKE) setup_git_hooks; \
fi
setup_git_hooks:
@if [ -n "$(SRC_PRECOMMIT_HOOK)" ]; then \
if [ -f "$(GIT_ROOTDIR)/$(SRC_PRECOMMIT_HOOK)" ] && [ ! -f "$(GIT_ROOTDIR)/$(GIT_HOOKSDIR)/pre-commit" ]; then \
echo "=> setup Git pre-commit hook"; \
ln -s ../../$(SRC_PRECOMMIT_HOOK) $(GIT_ROOTDIR)/$(GIT_HOOKSDIR)/pre-commit; \
fi ; \
fi
fetch:
git fetch --all -v
versioninfo:
@echo "Current version: $(VERSION)"
@echo "Last tag: $(LAST_TAG)"
@echo "$(shell git rev-list $(LAST_TAG).. --count) commit(s) since last tag"
@echo "Build: $(BUILD) (total number of commits)"
@echo "next major version: $(NEXT_MAJOR_VERSION)"
@echo "next minor version: $(NEXT_MINOR_VERSION)"
@echo "next patch version: $(NEXT_PATCH_VERSION)"
### Git flow management - this should be factorized
ifeq ($(HAS_GITFLOW),)
start_bump_patch start_bump_minor start_bump_major release:
@echo "Unable to find git-flow on your system. "
@echo "See https://github.com/nvie/gitflow for installation details"
else
define __VERSION_BUMP
start_bump_$1:
$$(if $$(GIT_DIRTY), $$(error "Unable to bump version: Dirty Git repository"))
@echo "Start the '$1' release of the repository from $$(VERSION) to $2"
git pull origin
git flow release start $2
@sleep 1
@if [ -f VERSION ]; then \
echo $2 > VERSION; \
git commit -s -m "$1 bump to version $2" VERSION; \
fi
@if [ -f .bumpversion.cfg ]; then \
echo "=> using 'bumpversion [...] $1'"; \
bumpversion --commit --no-tag $1; \
fi
@echo "=> run 'make release' once you finished the bump"
endef
$(eval $(call __VERSION_BUMP,patch,$(NEXT_PATCH_VERSION)))
$(eval $(call __VERSION_BUMP,minor,$(NEXT_MINOR_VERSION)))
$(eval $(call __VERSION_BUMP,major,$(NEXT_MAJOR_VERSION)))
release: clean
@if [ -f .bumpversion.cfg ]; then \
echo "=> release using 'bumpversion [...] release'"; \
bumpversion --commit --no-tag release; \
fi
git flow release finish -s $(VERSION:%rc=%)
git checkout $(GITFLOW_BR_MASTER)
git push origin
git checkout $(GITFLOW_BR_DEVELOP)
git push origin
git push origin --tags
endif
### Git (submodule|branch) management: pull and upgrade to the latest version
up update:
$(if $(GIT_DIRTY), $(error "Unable to pull latest commits: Dirty Git repository"))
@for br in $(GIT_BRANCHES_TO_UPDATE); do \
echo -e "\n=> Pulling and updating the local branch '$$br'\n"; \
git checkout $$br; \
git pull origin $$br; \
done
git checkout $(CURRENT_BRANCH)
@echo "=> updating (NOT upgrading) git submodule"
git submodule init
git submodule update
### Git submodule upgrade
upgrade: update
git submodule foreach 'git fetch origin; git checkout $$(git rev-parse --abbrev-ref HEAD); git reset --hard origin/$$(git rev-parse --abbrev-ref HEAD); git submodule update --recursive; git clean -dfx'
-@for submoddir in $(shell git submodule status | awk '{ print $$2 }' | xargs echo); do \
git commit -s -m "Upgrading Git submodule '$$submoddir' to the latest version" $$submoddir || true;\
done
### Git subtree management
ifeq ($(GIT_SUBTREE_REPOS),)
subtree_setup subtree_diff subtree_up:
@echo "no repository configured in GIT_SUBTREE_REPOS..."
else
subtree_setup:
@for elem in $(GIT_SUBTREE_REPOS); do \
url=`echo $$elem | cut -d '|' -f 1`; \
repo=`basename $$url .git`; \
if [[ ! "$(GIT_REMOTES)" =~ "$$repo" ]]; then \
echo "=> initializing Git remote '$$repo'"; \
git remote add -f $$repo $$url; \
fi \
done
subtree_diff:
@for elem in $(GIT_SUBTREE_REPOS); do \
url=`echo $$elem | cut -d '|' -f 1`; \
repo=`basename $$url .git`; \
path=`echo $$repo | tr '-' '/'`; \
br=`echo $$elem | cut -d '|' -f 2`; \
[ "$$br" == "$$url" ] && br='master'; \
echo -e "\n============ diff on subtree '$$path' with remote '$$repo/$$br' ===========\n"; \
git diff $${repo}/$$br $(CURRENT_BRANCH):$$path; \
done
subtree_up:
$(if $(GIT_DIRTY), $(error "Unable to pull subtree(s): Dirty Git repository"))
@for elem in $(GIT_SUBTREE_REPOS); do \
url=`echo $$elem | cut -d '|' -f 1`; \
repo=`basename $$url .git`; \
path=`echo $$repo | tr '-' '/'`; \
br=`echo $$elem | cut -d '|' -f 2`; \
[ "$$br" == "$$url" ] && br='master'; \
echo -e "\n===> pulling changes into subtree '$$path' using remote '$$repo/$$br'"; \
echo -e " \__ fetching remote '$$repo'"; \
git fetch $$repo; \
echo -e " \__ pulling changes"; \
git subtree pull --prefix $$path --squash $${repo} $${br}; \
done
endif
# Clean option
clean:
@if [ -d "$(GITSTATS_DIR)" ]; then \
echo "==> removing '$(GITSTATS_DIR)' directory"; \
rm -rf $(GITSTATS_DIR); \
fi
@echo nothing to be cleaned for the moment
# Perform various git statistics
stats:
@if [ ! -d $(GITSTATS_DIR) ]; then mkdir -p $(GITSTATS_DIR); fi
$(GITSTATS) . $(GITSTATS_DIR)/
doc:
@if [ -n "`which mkdocs`" ]; then \
mkdocs serve; \
fi
# # force recompilation
# force :
# @touch $(MAIN_TEX)
# @$(MAKE)
# print help message
help :
@echo '+----------------------------------------------------------------------+'
@echo '| Available Commands |'
@echo '+----------------------------------------------------------------------+'
@echo '| make setup: Initiate git-flow for your local copy of the repository|'
@echo '| make start_bump_{major,minor,patch}: start a new version release with|'
@echo '| git-flow at a given level (major, minor or patch bump) |'
@echo '| make release: Finalize the release using git-flow |'
@echo '+----------------------------------------------------------------------+'
ifneq (,$(wildcard $(MAKEFILE_AFTER)))
include $(MAKEFILE_AFTER)
endif
README.md
View file @ c37a8cd8
-*- mode: markdown; mode: visual-line; fill-column: 80 -*-
![By SoHPC](https://img.shields.io/badge/by-SoHPC-blue.svg) [![gitlab](https://img.shields.io/badge/git-gitlab-lightgray.svg)](https://gitlab.uni.lu/sohpc/slurm-spank-energy-reporting) [![Issues](https://img.shields.io/badge/issues-gitlab-green.svg)](https://gitlab.uni.lu/sohpc/slurm-spank-energy-reporting/issues)
____ _ ____ ____ _ _ _ _ __ ____ _ _
/ ___|| |_ _ _ __ _ __ ___ / ___|| _ \ / \ | \ | | |/ / | _ \| |_ _ __ _(_)_ __
\___ \| | | | | '__| '_ ` _ \ \___ \| |_) / _ \ | \| | ' / | |_) | | | | |/ _` | | '_ \
___) | | |_| | | | | | | | | ___) | __/ ___ \| |\ | . \ | __/| | |_| | (_| | | | | |
|____/|_|\__,_|_| |_| |_| |_| |____/|_| /_/ \_\_| \_|_|\_\ |_| |_|\__,_|\__, |_|_| |_|
|___/
_____ __ __ _ _ _
| ____|_ __ ___ _ __ __ _ _ _ | \/ | ___ _ __ (_) |_ ___ _ __(_)_ __ __ _
| _| | '_ \ / _ \ '__/ _` | | | | | |\/| |/ _ \| '_ \| | __/ _ \| '__| | '_ \ / _` |
| |___| | | | __/ | | (_| | |_| | | | | | (_) | | | | | || (_) | | | | | | | (_| |
|_____|_| |_|\___|_| \__, |\__, | |_| |_|\___/|_| |_|_|\__\___/|_| |_|_| |_|\__, |
|___/ |___/ |___/
Copyright (c) 2019 Matteo Stringher <stringher.matteo@gmail.com>
## Synopsis
[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):
$> mkdir -p ~/git/gitlab.uni.lu/SoHPC/public
$> cd ~/git/gitlab.uni.lu/SoHPC/public
$> git clone ssh://git@gitlab.uni.lu:8022/sohpc/public/slurm-spank-energy-reporting.git
**`/!\ 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)
## Misc Topics
### [Git-flow](https://github.com/petervanderdoes/gitflow-avh)
The Git branching model for this repository follows the guidelines of
[gitflow](http://nvie.com/posts/a-successful-git-branching-model/).
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.
VERSION 0 → 100644
View file @ c37a8cd8
0.0.1-b7