build configs & semantic release

Author: karamalie

.github/workflows/release.yml

@@ -0,0 +1,61 @@
+name: Release
+
+on:
+  push:
+    branches: [master, beta]
+
+jobs:
+  release:
+    name: Release
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Cache NPM
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-npm
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: 'https://npm.pkg.github.com'
+
+      - name: Install dependencies
+        run: yarn install
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Run linting
+        run: yarn lint
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Build project
+        run: yarn build
+
+      - name: Release
+        run: yarn release
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPMJS_TOKEN }}
+          GIT_COMMIT: ${{ github.sha }}
+          GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
+          GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
+          GIT_COMMITTER_NAME: ${{ secrets.GIT_COMMITTER_NAME }}
+          GIT_COMMITTER_EMAIL: ${{ secrets.GIT_COMMITTER_EMAIL }}

commitlint.config.js

@@ -0,0 +1,6 @@
+  
+/**
+ * Copyright 2020 Design Barn Inc.
+ */
+
+ module.exports = { extends: ['@commitlint/config-conventional'] };

package.json

@@ -4,6 +4,7 @@
   "version": "1.0.1",
   "description": "Lottie player wrapper for Vue.js by LottieFiles",
   "scripts": {
+    "release": "semantic-release",
     "build": "vue-cli-service build --target lib --name @lottiefiles/vue-lottie-player ./src/index.js"
   },
   "main": "dist/@lottiefiles/vue-lottie-player.common.js",
@@ -37,7 +38,24 @@
     "@vue/compiler-sfc": "^3.0.11",
     "rollup": "^2.50.1",
     "rollup-plugin-vue": "^6.0.0",
-    "vue-template-compiler": "^2.6.12"
+    "vue-template-compiler": "^2.6.12",
+    "@semantic-release/changelog": "^5.0.1",
+    "@semantic-release/commit-analyzer": "^8.0.1",
+    "@semantic-release/git": "^9.0.0",
+    "@semantic-release/github": "^7.2.1",
+    "@semantic-release/npm": "^7.1.1",
+    "@semantic-release/release-notes-generator": "^9.0.2",
+    "semantic-release": "^17.4.2",
+    "husky": ">=4",
+    "lint-staged": ">=10",
+    "@commitlint/cli": "^12.1.1",
+    "@commitlint/config-conventional": "^12.1.1"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "lint-staged"
+    }
   },
   "keywords": [
     "vue",

release.config.js

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2020 Design Barn Inc.
+ */
+
+'use strict';
+
+const pkg = require('./package.json');
+
+const CHANGELOG_HEADER = `# Changelog
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), enforced with [semantic-release](https://github.com/semantic-release/semantic-release).
+`;
+
+const SUCCESS_COMMENT = `:tada: This \${issue.pull_request ? 'pull request is included' : 'issue is fixed'} in v\${nextRelease.version}, available on npm: [${pkg.name}@\${nextRelease.version}](https://www.npmjs.com/package/${pkg.name}).`;
+
+/**
+ * See:
+ * https://semantic-release.gitbook.io/semantic-release/
+ * https://github.com/semantic-release/npm
+ * https://github.com/semantic-release/github
+ * https://github.com/semantic-release/git
+ * https://github.com/semantic-release/release-notes-generator
+ * https://github.com/semantic-release/commit-analyzer
+ * https://github.com/semantic-release/changelog
+ */
+module.exports = {
+  branches: ['master', { name: 'beta', prerelease: true }],
+  tagFormat: 'v${version}',
+  ci: true,
+  plugins: [
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        preset: 'conventionalcommits',
+      },
+    ],
+    '@semantic-release/release-notes-generator',
+    [
+      '@semantic-release/changelog',
+      {
+        changelogFile: 'CHANGELOG.md',
+        changelogTitle: CHANGELOG_HEADER,
+      },
+    ],
+    '@semantic-release/git',
+    [
+      '@semantic-release/github',
+      {
+        message: 'chore(release): v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
+        assets: 'dist/*.tgz',
+        successComment: SUCCESS_COMMENT,
+        addReleases: 'bottom',
+      },
+    ],
+    [
+      '@semantic-release/npm',
+      {
+        npmPublish: true,
+        tarballDir: 'dist',
+      },
+    ],
+  ],
+};