feat: shipjs integration (#954)

Refs: #949

Author: subzero10

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

CHANGELOG.md

@@ -1,11 +1,3 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
 ## [3.0.1] - 2022-03-24
 ### Added
 - Log error to console in development (#865)

README.md

@@ -41,6 +41,7 @@ please [file an issue on GitHub](https://github.com/honeybadger-io/honeybadger-v
 ## Changelog
 
 See https://github.com/honeybadger-io/honeybadger-vue/blob/master/CHANGELOG.md
+Changelog is automatically generated with [our release automation process](#release-automation).
 
 ## Contributing
 
@@ -95,6 +96,17 @@ To perform a release:
 
 3. Verify the published version in Versions tab from [here](https://www.npmjs.com/package/@honeybadger-io/vue).
 
+### Release Automation
+
+We use [Ship.js](https://github.com/algolia/shipjs) to automate releasing.
+
+Ship.js creates a PR once per week when unreleased changes are present. You can also trigger a release PR by saying "@shipjs prepare" in any issue or pull request comment on GitHub.
+
+#### Troubleshooting a failed Ship.js release
+
+If a ship.js release fails, you need to revert the release commit and delete the release branch (e.g `releases/v1.1.0`)
+Then, you can debug the issue by simulating the release process locally (`npm run release -- --dry-run --yes --no-browse`).
+
 ### License
 
 *honeybadger-vue* is MIT licensed. See the [LICENSE](https://raw.github.com/honeybadger-io/honeybadger-vue/master/LICENSE) file in this repository for details.

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };