https://github.com/ulhpc/qualif

Set of tools / scripts we use to qualify / validate the sanity of the UL HPC platform
https://github.com/ulhpc/qualif

Last synced: about 2 months ago
JSON representation

Set of tools / scripts we use to qualify / validate the sanity of the UL HPC platform

• Host: GitHub
• URL: https://github.com/ulhpc/qualif
• Owner: ULHPC
• Created: 2014-01-29T10:04:12.000Z (over 12 years ago)
• Default Branch: devel
• Last Pushed: 2016-06-21T10:39:45.000Z (almost 10 years ago)
• Last Synced: 2025-03-06T15:17:15.313Z (over 1 year ago)
• Language: Shell
• Size: 21.5 KB
• Stars: 0
• Watchers: 12
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
` README.md `

Copyright (c) 2014 [Sebastien Varrette](mailto:) [www](http://varrette.gforge.uni.lu)

        Time-stamp: <>

-------------------

# qualif

## Synopsis

## Local repository setup

This repository is hosted on out [GitHub]().

Once cloned, initiate the potential git submodules etc. by running:

    $> cd qualif

    $> make setup

## Pre-requisites

### Git

You should become familiar (if not yet) with [Git](http://git-scm.com/).

Consider these resources:

* [Git book](http://book.git-scm.com/index.html)

* [Github:help](http://help.github.com/mac-set-up-git/)

* [Git reference](http://gitref.org/)

At least, you shall configure the following exported variables within your favorite shell (adapt accordingly):

    # Bash configuration

    # Set your git user info

    export GIT_AUTHOR_NAME=' '

    export GIT_AUTHOR_EMAIL=''

    export GIT_COMMITTER_NAME="${GIT_AUTHOR_NAME}"

    export GIT_COMMITTER_EMAIL="${GIT_AUTHOR_EMAIL}"

You can also use the following commands:

    $> git config --global user.name "Your Name Comes Here"

    $> git config --global user.email you@yourdomain.example.com

    # configure colors

    $> git config --global color.diff auto

    $> git config --global color.status auto

    $> git config --global color.branch auto

### git-flow

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

* `devel`: the main branch where the latest developments interviene. This is

  the *default* branch you get when you clone the repo

# Advanced information

## Releasing mechanism

The operation consisting of releasing a new version of this repository is automated by a set of tasks within the `Makefile`.

In this context, a version number have the following format:

      ..-b

where:

* `< major >` corresponds to the major version number

* `< minor >` corresponds to the minor version number

* `< patch >` corresponds to the patching version number

* `< build >` states the build number _i.e._ the total number of commits within the `devel` branch.

Example: `1.0.0-b28`

The current version number is stored in the 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`.

Probably after that, the first things to do is to change within the main LaTeX document the version number and commit this change.

Then, to make the release effective, just run:

      $> 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.