docs: add badges to readme template

hennikatsoci · Jul 14, 2020 · 4f0b525 · 4f0b525
1 parent 02f4e47
commit 4f0b525
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,21 +3,7 @@
 
 ### Features
 
-* add release notes generator ([518309f](https://github.com/bradennapier/eslint-plus-action/commit/518309fcc7632a768eb1cac5795189c8f306e62c))
-* batched annotations ([#21](https://github.com/bradennapier/eslint-plus-action/issues/21)) ([e1e4b7e](https://github.com/bradennapier/eslint-plus-action/commit/e1e4b7e63adbcf34bd465ce09ef10c908ba573d5)), closes [/developer.github.com/v3/checks/runs/#output-object-1](https://github.com/bradennapier//developer.github.com/v3/checks/runs//issues/output-object-1)
-* beta ([2b5e5aa](https://github.com/bradennapier/eslint-plus-action/commit/2b5e5aa749d17b7521fd63088c2626606ee3f8ad))
-* gitignore README.md ([40f99fb](https://github.com/bradennapier/eslint-plus-action/commit/40f99fb173260b515fd077e26f72859af6a91b84))
-* release changelog and package ([b81c9f1](https://github.com/bradennapier/eslint-plus-action/commit/b81c9f17702054ad52576204efb375bc7cd8e1f1))
-* semantic-release ([#22](https://github.com/bradennapier/eslint-plus-action/issues/22)) ([d69fe57](https://github.com/bradennapier/eslint-plus-action/commit/d69fe5770de906bd30a325342dbfb0da02ed251a)), closes [/developer.github.com/v3/checks/runs/#output-object-1](https://github.com/bradennapier//developer.github.com/v3/checks/runs//issues/output-object-1)
-* use conventionalcommits preset ([b775447](https://github.com/bradennapier/eslint-plus-action/commit/b775447d4dcb8a874380cdb9f937e2edae19106d))
-* use semantic/github ([cf6f88d](https://github.com/bradennapier/eslint-plus-action/commit/cf6f88df0f9b754ab614df1d3517dca5e0ca973f))
+* start of `semantic-release` automation
 
 
 ### Bug Fixes
-
-* bring readme template in workflow ([36f521f](https://github.com/bradennapier/eslint-plus-action/commit/36f521ff409c915b7b608158c7c7f13718b3e370))
-* github release notes ([2d941fd](https://github.com/bradennapier/eslint-plus-action/commit/2d941fd7d6a5adb2d5410156439ecd06cfaa371d))
-* google replace ([3280301](https://github.com/bradennapier/eslint-plus-action/commit/32803018f4ae4d920a5161fc38b1ece81ee0649e))
-* google replace version commit ([5c3e127](https://github.com/bradennapier/eslint-plus-action/commit/5c3e127c259c72e37dc4a96f5ebed022cef8bd13))
-* merge conflict ([75e5353](https://github.com/bradennapier/eslint-plus-action/commit/75e5353e5cb4267aa16d97707d41ab556e6e8ea7))
-* remove tag ([3e59afc](https://github.com/bradennapier/eslint-plus-action/commit/3e59afc57b037800c674ede2061cd3bde36488d2))
diff --git a/docs/README.template.md b/docs/README.template.md
@@ -27,6 +27,9 @@
   <br />
 </div>
 
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+![lint](https://github.com/bradennapier/eslint-plus-action/workflows/lint/badge.svg)
+
 ## Dead Simple
 
 As easy as the following, and even the more advanced features are just a few extra lines.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-action",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "private": true,
   "description": "TypeScript template action",
   "main": "lib/run.js",

diff --git a/release.config.js b/release.config.js
@@ -12,6 +12,7 @@ module.exports = {
         preset: 'conventionalcommits',
       },
     ],
+    // creates CHANGELOG.md
     '@semantic-release/changelog',
     [
       '@google/semantic-release-replace-plugin',
@@ -29,11 +30,20 @@ module.exports = {
       },
     ],
     [
+      // updates the package.json version without publishing to npm
+      '@semantic-release/npm',
+      {
+        npmPublish: false,
+      },
+    ],
+    [
+      // commits the changed files to git
       '@semantic-release/git',
       {
         assets: ['package.json', 'CHANGELOG.md', 'README.md'],
       },
     ],
+    // creates the github release
     '@semantic-release/github',
   ],
 };