Initial commit

Author: Zack Stevens

.github/workflows/pull_request.yaml

@@ -0,0 +1,20 @@
+name: Validate pull request
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  validate-pr-title:
+    name: Validate PR Title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: crazy-max/ghaction-dump-context@v1
+      - uses: amannn/[email protected]
+        with:
+          types: |
+            fix
+            feat
+            norelease
+          validateSingleCommit: true
+        env:
+          GITHUB_TOKEN: ${{ github.token }}

.github/workflows/release.yaml

@@ -0,0 +1,35 @@
+name: Release
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+    paths:
+      - index.js
+      - package.json
+      - package-lock.json
+jobs:
+  release:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    env:
+      NPM_TOKEN:
+        ${{ secrets.AUTOMATION_NPMJS_TOKEN }}
+    steps:
+      - uses: crazy-max/ghaction-dump-context@v1
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          # this makes the semantic-release git plugin push as the automation user, which allows us to bypass branch protection
+          token: ${{ secrets.DEPLOYER_CI_TOKEN }}
+      - id: semantic-release
+        uses: cycjimmy/semantic-release-action@v2
+        with:
+          extra_plugins: |
+            conventional-changelog-conventionalcommits
+            @semantic-release/changelog
+            @semantic-release/git
+        env:
+          # github.token can't trigger workflows, we want the created release to trigger other workflows, so use the  token
+          GITHUB_TOKEN: ${{ secrets.DEPLOYER_CI_TOKEN }}

.gitignore

@@ -0,0 +1,104 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# 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
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port

.releaserc.json

@@ -0,0 +1,21 @@
+{
+  "branches": [
+    "main"
+  ],
+  "ci": false,
+  "plugins": [
+    ["@semantic-release/commit-analyzer", {
+      "preset":  "conventionalcommits",
+      "releaseRules": [
+        {"scope": "norelease", "release": false}
+      ]
+    }],
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    ["@semantic-release/git", {
+      "message": "semantic-release-bot chore(release): ${nextRelease.version} \n\n${nextRelease.notes}"
+    }],
+    "@semantic-release/github"
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0 (2021-12-20)
+
+
+### Bug Fixes
+
+* Initial release ([#1](https://github.com/Unsupervisedcom/release-config-template/issues/1)) ([540d5cc](https://github.com/Unsupervisedcom/release-config-template/commit/540d5cc29eb46a36720a7a0c9c11795fc3463fca))

README.md

@@ -0,0 +1,8 @@
+# release-config-template
+semantic-release release configuration template repository
+
+# How do I use it?
+1. modify `index.js` to export whatever release config you want, this is the shareable config that other releases will use.
+2. Replace all instances of `release-config-template` with the name of your release config. It should follow the convention `release-config-{your name here}`
+3. PR to main following conventional commits. Make sure your squash message follows conventional commits.
+4. The release workflow should run, and publish your shareable config to npm so you can use it in releases via extends as `@unsupervised/release-config-{your name here}`

index.js

@@ -0,0 +1,24 @@
+module.exports = {
+    "branches": [
+        "main"
+    ],
+    "ci": false,
+    "plugins": [
+        ["@semantic-release/exec", {
+            "prepareCmd": "echo \"success\""
+        }],
+        ["@semantic-release/commit-analyzer", {
+            "preset":  "conventionalcommits",
+            "releaseRules": [
+                {"scope": "norelease", "release": false}
+            ]
+        }],
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/changelog",
+        ["@semantic-release/git", {
+            "assets": ["CHANGELOG.md"],
+            "message": "semantic-release-bot chore(release): ${nextRelease.version} \n\n${nextRelease.notes}"
+        }],
+        "@semantic-release/github"
+    ]
+}