feat: initial release

semantic-release · Jan 7, 2018 · c202868 · c202868
1 parent 046a092
commit c202868
Show file tree

Hide file tree

Showing 12 changed files with 732 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,131 @@
+
+# Created by https://www.gitignore.io/api/macos,windows,linux,node
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/macos,windows,linux,node
+
+package-lock.json
+yarn.lock
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,40 @@
+notifications:
+  email: false
+
+language: node_js
+node_js:
+  - 9
+  - 8
+
+services:
+  - docker
+
+addons:
+  apt:
+    packages:
+      # See https://github.com/atom/ci
+      - libsecret-1-dev
+
+# Trigger a push build on master and greenkeeper branches + PRs build on every branches
+# Avoid double build on PRs (See https://github.com/travis-ci/travis-ci/issues/1147)
+branches:
+  only:
+    - master
+    - /^greenkeeper.*$/
+
+install:
+  # Retry install on fail to avoid failing a build on network/disk/external errors
+  - travis_retry npm install
+  # See https://github.com/atom/ci
+  - curl -s -O https://raw.githubusercontent.com/atom/ci/master/build-package.sh
+  - chmod u+x build-package.sh
+  - ./build-package.sh
+  # Add apm to the PATH
+  - export PATH=$PATH:~/atom/usr/bin
+
+script:
+  - npm run test
+
+after_success:
+  - npm run codecov
+  - npm run semantic-release
diff --git a/.yarnrc b/.yarnrc
@@ -0,0 +1 @@
+--install.no-lockfile true
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,2 +1,69 @@
-# gitlab-config
-:fox_face: Semantic-release shareable config for GitLab
+# @semantic-release/gitlab-config
+
+[Semantic-release](https://github.com/semantic-release/semantic-release) shareable config for [GitLab](https://gitlab.com).
+
+[![Travis](https://img.shields.io/travis/semantic-release/gitlab-config.svg)](https://travis-ci.org/semantic-release/gitlab-config)
+[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/gitlab-config.svg)](https://codecov.io/gh/semantic-release/gitlab-config)
+[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/gitlab-config.svg)](https://greenkeeper.io/)
+
+## Usage
+
+### Local installation
+
+```bash
+$ npm install --save-dev semantic-release @semantic-release/gitlab-config
+```
+
+In `package.json`:
+
+```json
+{
+  "release": {
+    "extends": "@semantic-release/gitlab-config"  
+  }
+}
+```
+
+### Global installation
+
+```bash
+$ npm install -g semantic-release @semantic-release/gitlab-config
+$ semantic-release -e @semantic-release/gitlab-config
+```
+
+## Configuration
+
+### GitLab authentication
+
+The GitLab authentication configuration is **required** and can be set via [environment variables](#environment-variables).
+
+See [GitLab authentication](https://github.com/semantic-release/gitlab#gitlab-authentication).
+
+### Npm registry authentication
+
+The npm authentication configuration is **required** and can be set via [environment variables](#environment-variables).
+
+See [Npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication)
+
+### Environment variables
+
+| Variable                     | Description                                                                                                                                 |
+|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| `GL_TOKEN` or `GITLAB_TOKEN` | **Required.** The token used to authenticate with GitLab repository.                                                                        |
+| `NPM_TOKEN`                  | **Required.** Npm token created via [npm token create](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) |
+
+### Additional options
+
+This shareable config uses the [`@semantic-release/npm`](https://github.com/semantic-release/npm) and [`@semantic-release/gitlab`](https://github.com/semantic-release/gitlab) plugins. See the documentation of each plugins for additional options.
+Options can be set in the Semantic-release configuration.
+
+For example to set a custom GitLab URL:
+
+```json
+{
+  "release": {
+    "extends": "@semantic-release/gitlab-config",
+    "gitlabUrl": "https://custom.gitlab.com"
+  }
+}
+```
diff --git a/index.js b/index.js
@@ -0,0 +1,5 @@
+module.exports = {
+  verifyConditions: ['@semantic-release/npm', '@semantic-release/gitlab'],
+  getLastRelease: '@semantic-release/npm',
+  publish: ['@semantic-release/npm', '@semantic-release/gitlab'],
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,108 @@
+{
+  "name": "@semantic-release/gitlab-config",
+  "description": "Semantic-release shareable config for GitLab",
+  "version": "0.0.0-development",
+  "author": "Pierre Vanduynslager (https://github.com/pvdlg)",
+  "bugs": {
+    "url": "https://github.com/semantic-release/gitlab-config/issues"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "contributors": [
+    "Stephan Bönnemann <[email protected]> (http://boennemann.me)",
+    "Gregor Martynus (https://twitter.com/gr2m)"
+  ],
+  "dependencies": {
+    "@semantic-release/gitlab": "^1.0.0",
+    "@semantic-release/npm": "^2.4.0"
+  },
+  "devDependencies": {
+    "ava": "^0.24.0",
+    "codecov": "^3.0.0",
+    "commitizen": "^2.9.6",
+    "cz-conventional-changelog": "^2.0.0",
+    "delay": "^2.0.0",
+    "dockerode": "^2.5.3",
+    "eslint-config-prettier": "^2.3.0",
+    "eslint-plugin-prettier": "^2.3.0",
+    "execa": "^0.8.0",
+    "fs-extra": "^5.0.0",
+    "get-stream": "^3.0.0",
+    "got": "^8.0.1",
+    "mockserver-client": "^5.3.0",
+    "nyc": "^11.1.0",
+    "p-retry": "^1.0.0",
+    "prettier": "~1.9.2",
+    "semantic-release": "^11.1.0",
+    "sinon": "^4.1.2",
+    "strip-ansi": "^4.0.0",
+    "tempy": "^0.2.1",
+    "xo": "^0.18.2"
+  },
+  "engines": {
+    "node": ">=4"
+  },
+  "files": [
+    "index.js"
+  ],
+  "homepage": "https://github.com/semantic-release/gitlab-config#readme",
+  "keywords": [
+    "gitlab",
+    "conventional-changelog",
+    "release",
+    "semantic-release",
+    "semantic-release-config",
+    "version"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "nyc": {
+    "include": [
+      "index.js"
+    ],
+    "reporter": [
+      "json",
+      "text",
+      "html"
+    ],
+    "all": true
+  },
+  "peerDependencies": {
+    "semantic-release": ">=12.0.0"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "singleQuote": true,
+    "bracketSpacing": false,
+    "trailingComma": "es5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/semantic-release/gitlab-config.git"
+  },
+  "scripts": {
+    "cm": "git-cz",
+    "codecov": "codecov -f coverage/coverage-final.json",
+    "lint": "xo",
+    "pretest": "npm run lint",
+    "semantic-release": "semantic-release",
+    "test": "nyc ava -v"
+  },
+  "xo": {
+    "extends": [
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": 2
+    }
+  }
+}