@hutson/gitlab-config

Standard GitLab configuration as used by projects maintained by Hutson Betts (@hutson).

Configuration package containing files that can be used to configure different aspects of GitLab.

Table of Contents

• Features
• Usage
  • GitLab CI
    • Npm Libraries
    • Docker Images
• Security Disclosure Policy
• Professional Support
• Node Support Policy
• Contributing

Features

• [x] A GitLab CI template for testing, delivering, and deploying, npm packages.
• [x] A GitLab CI template for building, testing, delivering, and deploying, Docker images to GitLab's image registry.

Usage

GitLab CI

Npm Libraries

For testing and deploying npm packages from a GitLab repository.

To extend this Npm library template just include it in your project's .gitlab-ci.yml file using include:

include 'https://gitlab.com/hyper-expanse/open-source/configuration-packages/gitlab-config/raw/master/src/gitlab-ci-common.template.yml'
include 'https://gitlab.com/hyper-expanse/open-source/configuration-packages/gitlab-config/raw/master/src/gitlab-ci-npm-library.template.yml'

Assumptions:

• You list semantic-release-gitlab and npm-publish-git-tag as development dependencies in your package.json file.

Note: The include URL references the master branch. Please consider using a specific commit hash or tag if you are not comfortable depending on the latest template. Ideally you should use a versioned template so that your build is repeatable. At this time, however, I know of no way to automatically keep the URL reference up-to-date.

Docker Images

For building, testing, deliverying, and then deploying, a Docker image on GitLab.

To extend this Docker template just include it in your project's .gitlab-ci.yml file using include:

include 'https://gitlab.com/hyper-expanse/open-source/configuration-packages/gitlab-config/raw/master/src/gitlab-ci-common.template.yml'
include 'https://gitlab.com/hyper-expanse/open-source/configuration-packages/gitlab-config/raw/master/src/gitlab-ci-docker.template.yml'

Note: The include URL references the master branch. Please consider using a specific commit hash or tag if you are not comfortable depending on the latest template. Ideally you should use a versioned template so that your build is repeatable. At this time, however, I know of no way to automatically keep the URL reference up-to-date.

Security Disclosure Policy

To report a security vulnerability in this package, or one of it's dependencies, please use the Tidelift security contact page. Tidelift will coordinate the process to address the vulnerability and disclose the incident to our users.

Professional Support

Professional support for @hutson/gitlab-config is available with a Tidelift Subscription.

Tidelift helps make open source sustainable for maintainers while giving companies assurances about security, maintenance, and licensing for their dependencies.

Node Support Policy

We only support Long-Term Support versions of Node.

We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.

It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.

As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.

We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.

JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.

Contributing

Please read our contributing guide to see how you may contribute to this project.