chore: skeleton for a build template

### STS ###

.apt_generated

.classpath

.factorypath

.project

.settings

.springBeans

.sts4-cache

### IntelliJ IDEA ###

.idea

*.iws

*.iml

*.ipr

### NetBeans ###

/nbproject/private/

/build/

/nbbuild/

/dist/

/nbdist/

/.nb-gradle/

 No newline at end of file

include:

  - project: 'to-be-continuous/tools/gitlab-ci'

    ref: 'master'

    file: '/templates/validation.yml'

  - project: 'to-be-continuous/kicker'

    ref: 'master'

    file: '/templates/validation.yml'

  - project: 'to-be-continuous/bash'

    ref: '1.0.0'

    file: 'templates/gitlab-ci-bash.yml'

stages:

  - build

  - publish

variables:

  GITLAB_CI_FILES: "templates/gitlab-ci-xxx.yml"

  BASH_SHELLCHECK_FILES: "*.sh"

# extract the Bash script from template (for ShellCheck job)

extract-script:

  stage: .pre

  script:

    - echo "#!/bin/bash" > script.sh

    - sed -n '/BEGSCRIPT/,/ENDSCRIPT/p' "$GITLAB_CI_FILES" | sed 's/^  //' >> script.sh

    - export LC_ALL=C.UTF-8

  artifacts:

    when: always

    name: extracted template script

    expire_in: 1h

    paths:

      - script.sh

release:

  image: node:12

  stage: publish

  before_script:

    - npm install -g semantic-release @semantic-release/gitlab @semantic-release/exec @semantic-release/git

  script:

    - semantic-release

  only:

    refs:

      - master

    variables:

      - $TMPL_RELEASE_ENABLED

plugins: [

  "@semantic-release/commit-analyzer",

  "@semantic-release/release-notes-generator",

  "@semantic-release/gitlab",

  [

    "@semantic-release/exec",

    {

      "prepareCmd": "./bumpversion.sh \"${lastRelease.version}\" \"${nextRelease.version}\" \"${nextRelease.type}\""

    }

  ],

  [

    "@semantic-release/git",

    {

      "assets": ["*.md", "templates/*.yml"]

    }

  ]

]

branches:

  - "master"

tagFormat: "${version}"

 No newline at end of file

# GitLab CI template Skeleton

# GitLab CI template for XXX

This is a skeleton project for starting a new _to be continuous_ template.

This project implements a generic GitLab CI template for [XXX](https://link.to.tool.com/).

You shall fork it when you want to start developing a new template.

It provides several features, usable in different modes (by configuration).

Based on the kind of template (build, analyse, hosting, acceptance, ...), you should start working from one of the available `initial-xxx` branches, that each implement basic stuff.

## Usage

In order to include this template in your project, add the following to your `gitlab-ci.yml`:

```yaml

include:

  - project: 'to-be-continuous/xxx'

    ref: '1.0.0'

    file: '/templates/gitlab-ci-xxx.yml'

```

## Global configuration

The XXX template uses some global configuration used throughout all jobs.

| Name                  | description                            | default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `XXX_IMAGE`           | The Docker image used to run XXX       | `xxx:latest` |

## Jobs

### `xxx-build` job

This job performs **build and tests** at once.

It uses the following variable:

| Name                  | description                              | default value     |

| --------------------- | ---------------------------------------- | ----------------- |

| `XXX_BUILD_ARGS`      | Arguments used by the build job          | `build --with-default-args` |

### SonarQube analysis

If you're using the SonarQube template to analyse your XXX code, here are 2 sample `sonar-project.properties` files.

```properties

# see: https://docs.sonarqube.org/latest/analysis/languages/xxx/

# set your source directory(ies) here (relative to the sonar-project.properties file)

sonar.sources=.

# exclude unwanted directories and files from being analysed

sonar.exclusions=output/**,**/*_test.xxx

# set your tests directory(ies) here (relative to the sonar-project.properties file)

sonar.tests=.

sonar.test.inclusions=**/*_test.xxx

# tests report (TODO)

sonar.xxx.testExecutionReportPaths=reports/sonar_test_report.xml

# coverage report (TODO)

sonar.xxx.coverage.reportPaths=reports/coverage.cov

```

More info:

* [XXX language support](https://docs.sonarqube.org/latest/analysis/languages/xxx/)

* [test coverage & execution parameters](https://docs.sonarqube.org/latest/analysis/coverage/)

* [third-party issues](https://docs.sonarqube.org/latest/analysis/external-issues/)

### `xxx-lint` job

This job performs a [lint](link-to-the-tool) analysis of your code, mapped to the `build` stage.

It uses the following variables:

| Name                  | description                                | default value     |

| --------------------- | ------------------------------------------ | ----------------- |

| `XXX_LINT_IMAGE`      | The Docker image used to run the lint tool | `xxx-lint:latest` |

| `XXX_LINT_ARGS`       | Lint [options and arguments](link-to-the-cli-options) | `--serevity=medium` |

### `xxx-depcheck` job

This job enables a manual [dependency check](link-to-the-tool) analysis of your code, mapped to the `test` stage.

It uses the following variables:

| Name                  | description                                | default value     |

| --------------------- | ------------------------------------------ | ----------------- |

| `XXX_DEPCHECK_IMAGE`  | The Docker image used to run the dependency check tool | `xxx-depcheck:latest` |

| `XXX_DEPCHECK_ARGS`   | Dependency check [options and arguments](link-to-the-cli-options) | _none_ |

### `xxx-publish` job

This job is **disabled by default** and performs a publish of your built binaries.

It uses the following variables:

| Name                  | description                            | default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `XXX_PUBLISH_ENABLED` | Variable to enable the publish job     | _none_ (disabled) |

| `XXX_PUBLISH_ARGS`    | Arguments used by the publish job      | `publish --with-default-args` |

| :lock: `XXX_PUBLISH_LOGIN` | Login to use to publish           | **has to be defined** |

| :lock: `XXX_PUBLISH_PASSWORD` | Password to use to publish     | **has to be defined** |

### Secrets management

Here are some advices about your **secrets** (variables marked with a :lock:):

1. Manage them as [project or group CI/CD variables](https://docs.gitlab.com/ee/ci/variables/#create-a-custom-variable-in-the-ui):

    * [**masked**](https://docs.gitlab.com/ee/ci/variables/#mask-a-custom-variable) to prevent them from being inadvertently

      displayed in your job logs,

    * [**protected**](https://docs.gitlab.com/ee/ci/variables/#protect-a-custom-variable) if you want to secure some secrets

      you don't want everyone in the project to have access to (for instance production secrets).

2. In case a secret contains [characters that prevent it from being masked](https://docs.gitlab.com/ee/ci/variables/#masked-variable-requirements), 

  simply define its value as the [Base64](https://en.wikipedia.org/wiki/Base64) encoded value prefixed with `@b64@`:

  it will then be possible to mask it and the template will automatically decode it prior to using it.

3. Don't forget to escape special characters (ex: `$` -> `$$`).

#!/usr/bin/env bash

function log_info() {

  >&2 echo -e "[\\e[1;94mINFO\\e[0m] $*"

}

function log_warn() {

  >&2 echo -e "[\\e[1;93mWARN\\e[0m] $*"

}

function log_error() {

  >&2 echo -e "[\\e[1;91mERROR\\e[0m] $*"

}

# check number of arguments

if [[ "$#" -le 2 ]]; then

  log_error "Missing arguments"

  log_error "Usage: $0 <current version> <next version>"

  exit 1

fi

curVer=$1

nextVer=$2

relType=$3

if [[ "$curVer" ]]; then

  log_info "Bump version from \\e[33;1m${curVer}\\e[0m to \\e[33;1m${nextVer}\\e[0m (release type: $relType)..."

  # replace in README

  sed -e "s/ref: '$curVer'/ref: '$nextVer'/" README.md > README.md.next

  mv -f README.md.next README.md

  # replace in template and variants

  for tmpl in templates/*.yml

  do

    sed -e "s/\"$curVer\"/\"$nextVer\"/" "$tmpl" > "$tmpl.next"

    mv -f "$tmpl.next" "$tmpl"

  done

else

  log_info "Bump version to \\e[33;1m${nextVer}\\e[0m (release type: $relType): this is the first release (skip)..."

fi