Build: Use semantic-release with ESLint preset (#1459)

* All types of releases are automated
* Slightly different commit message convention

Author: sapegin

.travis.yml

@@ -68,9 +68,7 @@ jobs:
 
     - stage: release
       script:
-        - npm install --no-save semantic-release-tamia
-        - >-
-          npx semantic-release --analyze-commits semantic-release-tamia/analyzeCommits --verify-release semantic-release-tamia/verifyRelease --generate-notes semantic-release-tamia/generateNotes
+        - npx semantic-release
 
     - stage: documentation
       script:

docs/Maintenance.md

@@ -9,11 +9,11 @@
 - [Pull requests](#pull-requests)
 - [Releases](#releases)
   - [Patch releases](#patch-releases)
-  - [Minor and major releases](#minor-and-major-releases)
+  - [Minor releases](#minor-releases)
+  - [Major releases](#major-releases)
 - [Changelogs](#changelogs)
   - [What is a good changelog](#what-is-a-good-changelog)
   - [What should be in a changelog](#what-should-be-in-a-changelog)
-  - [Preparing a changelog](#preparing-a-changelog)
 
 <!-- tocstop -->
 
@@ -30,34 +30,68 @@ Help us develop and maintain Styleguidist:
 
 ## Commit message conventions
 
-[Commit message conventions](https://github.com/tamiadev/semantic-release-tamia/blob/master/Convention.md) are based on Angular conventions.
+We use [ESLint commit message conventions](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint).
+
+Each commit looks like this:
+
+```
+Tag: Short description (fixes #1234)
+
+Longer description here if necessary
+```
+
+The `Tag` is one of the following:
+
+- `Fix` — for a bug fix.
+- `Update` — for a backwards-compatible enhancement.
+- `New` — implemented a new feature.
+- `Breaking` — for a backwards—incompatible enhancement or feature.
+- `Docs` — changes to documentation only.
+- `Build` — changes to build process only.
+- `Upgrade` — for a dependency upgrade.
+- `Chore` — for refactoring, adding tests and so on (anything that isn’t user-facing).
+
+If the commit doesn’t completely fix the issue, then use (`refs #1234`) instead of (`fixes #1234`).
+
+Here are some good commit message summary examples:
+
+```
+Build: Update Travis to only test Node 0.10 (refs #734)
+Fix: Semi rule incorrectly flagging extra semicolon (fixes #840)
+Upgrade: Esprima to 1.2, switch to using comment attachment (fixes #730)
+```
 
 ## Pull requests
 
-Maintainers merge pull requests by squashing all commits and editing the commit message if necessary.
+Maintainers merge pull requests by squashing all commits and editing the commit message if necessary using the GitHub user interface.
 
-Use an [appropriate commit type](https://github.com/tamiadev/semantic-release-tamia/blob/master/Convention.md#types). Be especially careful with [breaking changes](https://github.com/tamiadev/semantic-release-tamia/blob/master/Convention.md#breaking-changes).
+Use an appropriate commit type. Be especially careful with breaking changes. See _Commit message conventions_ above for details.
 
 ## Releases
 
-We’re doing [semi-automated releases](http://blog.sapegin.me/all/semantic-release) with semantic-release.
+We’re doing automated releases with semantic-release. We’re using [milestones](https://github.com/styleguidist/react-styleguidist/milestones) to group approved pull requests that should be released together (most useful for major releases).
 
 ### Patch releases
 
-Patch releases are fully automated — any commit of a `Fix` type is published as a patch release as soon as CI passes.
+Any commit of a `Fix` or `Update` types merged into the master branch, is published as a _patch_ release as soon as CI passes.
 
 ![](https://d3vv6lp55qjaqc.cloudfront.net/items/1T3v1z0c3f1I1E3l0B3s/patch-commit.png)
 
-### Minor and major releases
+### Minor releases
 
-We’re using [milestones](https://github.com/styleguidist/react-styleguidist/milestones) to group approved pull requests that should be released together. Minor and major releases require a changelog (see below). Any commit of a `Feat` type will not trigger a release until you commit a changelog. Semantic-release will publish a major release if there are any commits with [breaking changes](https://github.com/tamiadev/semantic-release-tamia/blob/master/Convention.md#breaking-changes).
+Any commit of a `New` type merged into the master branch, is published as a _minor_ release as soon as CI passes.
 
-1.  Merge all pull request from a milestone
-2.  Resolve possible merge conflicts.
-3.  Manually check that Styleguidist still works.
-4.  Prepare and commit a changelog.
-5.  Wait until semantic-release publishes the release.
-6.  Tweet the release!
+### Major releases
+
+Any commit of a `Breaking` type merged into the master branch, is published as a _major_ release as soon as CI passes.
+
+1. Merge all pull requests from a milestone. If a milestone has more than one pull request, they should be merged and released together:
+   1. Create a new branch.
+   2. Merge all pull requests into this new branch (you can change the target branch on the pull request page and merge it using the GitHub user interface).
+   3. Resolve possible merge conflicts.
+2. Wait until semantic-release publishes the release.
+3. Edit the release notes on GitHub (see _Changelogs_ below).
+4. Tweet the release!
 
 ## Changelogs
 
@@ -67,24 +101,11 @@ We’re using [milestones](https://github.com/styleguidist/react-styleguidist/mi
 - Changelog should show new features with code examples or GIFs.
 - Changelog should make all breaking changes clear.
 - Changelog should explain how to migrate to a new version if there are breaking changes.
-- Commit log **is not** a changelog.
+- Commit log **is not** a changelog but can be a base for it.
 
 Here’s a [good example of a changelog](https://github.com/styleguidist/react-styleguidist/releases/tag/v7.1.0). Check out [Keep a Changelog](https://keepachangelog.com/) for more details on good changelogs.
 
 ### What should be in a changelog
 
 - Information about pull request authors:<br> `(#1040 by @rafaesc)`
 - Open Collective link at the very top:<br> `👋 **[Support Styleguidist](https://opencollective.com/styleguidist) on Open Collective** 👋`
-
-### Preparing a changelog
-
-1. Change to the `master` branch.
-2. Generate a changelog draft using [tamia-changelog](https://github.com/tamiadev/tamia-changelog): `npx tamia-changelog`.
-3. Edit `Changelog.md` file.
-4. Commit the changelog: `npx tamia-changelog commit`.
-
-**Note:** do not commit the `Changelog.md` file, the release tool reads the changelog from the commit message. [Read how it works](https://blog.sapegin.me/all/semantic-release/).
-
-**Note:** you may create a pull request for a changelog. Make sure the actual commit in the `master` branch has a `Changelog:` tag for the release tool to see it.
-
-![Commit message with a changelog](https://user-images.githubusercontent.com/70067/66844661-f6f1e600-ef6e-11e9-9d63-dba607d3c94b.png)

release.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+	plugins: [
+		[
+			'@semantic-release/commit-analyzer',
+			{
+				preset: 'eslint',
+			},
+		],
+		[
+			'@semantic-release/release-notes-generator',
+			{
+				preset: 'eslint',
+			},
+		],
+		'@semantic-release/npm',
+		'@semantic-release/github',
+	],
+};