feat: v0.0.14 release

Signed-off-by: K.B.Dharun Krishna <[email protected]>
tldr-pages · Mar 20, 2024 · e5af812 · e5af812
1 parent c336197
commit e5af812
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 12 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,24 @@
+# This workflow automatically publishes the package to NPM when a new release is created.
+# Before, creating a new release, make sure to update the package version in package.json
+# and add a Granular Access Token (with read and write packages scope)
+# to the repository secrets with the name NPM_TOKEN.
+# Once, the release has been published remove it from the repository secrets.
+
+name: Publish Package to NPM
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,52 +4,66 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com).
 
+## [v0.0.14 - 2024-04-20](https://github.com/tldr-pages/tldr-lint/compare/v0.0.13...v0.0.14)
+
+- Add rule `TLDR110` ([#306]https://github.com/tldr-pages/tldr-lint/pull/306))
+
 ## [v0.0.13 - 2021-10-12](https://github.com/tldr-pages/tldr-lint/compare/v0.0.12...v0.0.13)
 
 ### Changed
+
 - Allow exceptions to rule `TLDR003` ([#104](https://github.com/tldr-pages/tldr-lint/pull/104))
 
 ## [v0.0.12 - 2021-10-04](https://github.com/tldr-pages/tldr-lint/compare/v0.0.11...v0.0.12)
 
 ### Added
+
 - Allow special uppercased characters ([#101](https://github.com/tldr-pages/tldr-lint/pull/101))
 
 ### Changed
+
 - Update to test against Node 16.x ([#90](https://github.com/tldr-pages/tldr-lint/pull/90))
 
 ## [v0.0.11 - 2021-04-14](https://github.com/tldr-pages/tldr-lint/compare/v0.0.10...v0.0.11)
 
 ### Added
+
 - Add CLI flag to ignore specific errors ([#69](https://github.com/tldr-pages/tldr-lint/pull/69))
 
 ### Changed
+
 - Allow words at the beginning of example descriptions to end with "ys" ([#60](https://github.com/tldr-pages/tldr-lint/pull/60))
 - Print out filename above parse errors ([#62](https://github.com/tldr-pages/tldr-lint/pull/62))
 
 ### Fixed
+
 - Fix passing options to CLI ([#59](https://github.com/tldr-pages/tldr-lint/pull/59))
 
 ## [v0.0.10 - 2021-03-01](https://github.com/tldr-pages/tldr-lint/compare/v0.0.9...v0.0.10)
 
 ### Added
+
 - Add rule `TLDR107` ([#34](https://github.com/tldr-pages/tldr-lint/pull/34))
 - Add rule `TLDR108` ([#39](https://github.com/tldr-pages/tldr-lint/pull/39))
 - Add rule `TLDR109` ([#42](https://github.com/tldr-pages/tldr-lint/pull/42))
 
 ### Changed
+
 - Allow pages with `+` character in title ([#33](https://github.com/tldr-pages/tldr-lint/pull/33))
 - Allow pages with `[` chacacter in title ([#44](https://github.com/tldr-pages/tldr-lint/pull/44))
 - Add ESLint for JS linting ([#50](https://github.com/tldr-pages/tldr-lint/pull/50))
 
 ## [v0.0.9 - 2020-12-23](https://github.com/tldr-pages/tldr-lint/compare/v0.0.8...v0.0.9)
 
 ### Added
+
 - Add rule `TLDR016` ([#20](https://github.com/tldr-pages/tldr-lint/pull/20))
 - Add rule `TLDR017` ([#20](https://github.com/tldr-pages/tldr-lint/pull/20))
 - Add rule `TLDR018` ([#22](https://github.com/tldr-pages/tldr-lint/pull/22))
 - Add rule `TLDR019` ([#23](https://github.com/tldr-pages/tldr-lint/pull/23))
 
 ### Changed
+
 - Replace Grunt with npm scripts locally ([#21](https://github.com/tldr-pages/tldr-lint/pull/21))
 - Update CI to always use colour output ([#24](https://github.com/tldr-pages/tldr-lint/pull/24))
 - Remove TODOs from the README into issues ([#27](https://github.com/tldr-pages/tldr-lint/pull/27))
@@ -58,54 +72,65 @@ The format is based on [Keep a Changelog](https://keepachangelog.com).
 ## [v0.0.8 - 2020-10-02](https://github.com/tldr-pages/tldr-lint/compare/v0.0.7...v0.0.8)
 
 ### Added
+
 - Add rule `TLDR014`
 - Add rule `TLDR015`
 - Add rule `TLDR105`
 
 ### Changed
+
 - Only allow one command per example
 - Disallow trailing characters in `TLDR005`
 
 ## [v0.0.7 - 2016-01-19](https://github.com/tldr-pages/tldr-lint/compare/v0.0.6...v0.0.7)
 
 ### Added
+
 - Add rule `TLDR104`
 - Add rule `TLDR106`
 
 ### Changed
+
 - Improve checking on `TLDR103`
 
 ## [v0.0.6 - 2016-01-14](https://github.com/tldr-pages/tldr-lint/compare/v0.0.5...v0.0.6)
 
 ### Added
+
 - Add rule `TLDR101`
 - Add rule `TLDR102`
 - Add rule `TLDR103`
 
 ## [v0.0.5 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.4...v0.0.5)
 
 ### Added
+
 - Add `tldrl` binary, as well as `tldr-lint`
 
 ### Changed
+
 - Allow periods in title, just not at the end
 
 ### Fixed
+
 - Fix example description regex
 
 ## [v0.0.4 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.3...v0.0.4)
 
 ### Added
+
 - Add support for directories
 
 ## [v0.0.3 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.2...v0.0.3)
 
 ### Fixed
+
 - Add exception to `TLDR003`
 
 ## [v0.0.2 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.1...v0.0.2)
 
 ### Added
+
 - Add rule `TLDR002`
 - Add rule `TLDR003`
 - Add rule `TLDR004`
@@ -120,10 +145,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com).
 - Add rule `TLDR013`
 
 ### Fixed
+
 - Fix writing to files with `-o`
 
 ## [v0.0.1 - 2016-01-07](https://github.com/tldr-pages/tldr-lint/commit/4570c2fe189e5fcc0ebd42b4cd4f63ac171ae07e)
 
 ### Added
+
 - Initial release
 - Add rule `TLDR001`
diff --git a/README.md b/README.md
@@ -11,15 +11,15 @@ It can also format your pages for you!
 
 `tldr-lint` and its alias `tldrl` can be installed via `npm`:
 
-```
+```sh
 npm install --global tldr-lint
 ```
 
 ## Usage
 
 It's really simple.
 
-```
+```txt
 Usage: tldr-lint [options] <file|dir>
 
 Options:
@@ -75,11 +75,5 @@ TLDR110     | Command example should not be empty
 [github-actions-url]: https://github.com/tldr-pages/tldr-lint/actions
 [github-actions-image]: https://img.shields.io/github/actions/workflow/status/tldr-pages/tldr-lint/test.yml?branch=main
 
-[dep-url]: https://david-dm.org/tldr-pages/tldr-lint
-[dep-image]: https://img.shields.io/david/tldr-pages/tldr-lint.svg
-
-[dev-dep-url]: https://david-dm.org/tldr-pages/tldr-lint#info=devDependencies
-[dev-dep-image]: https://img.shields.io/david/dev/tldr-pages/tldr-lint.svg
-
 [matrix-url]: https://matrix.to/#/#tldr-pages:matrix.org
 [matrix-image]: https://img.shields.io/matrix/tldr-pages:matrix.org?label=chat+on+matrix
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tldr-lint",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "A linting tool to validate tldr pages",
   "repository": "tldr-pages/tldr-lint",
   "scripts": {
@@ -27,9 +27,11 @@
     "name": "Ruben Vereecken",
     "email": "[email protected]"
   },
-  "maintainers": {
-    "name": "tldr-pages team"
-  },
+  "maintainers": [
+    {
+      "name": "tldr-pages team"
+    }
+  ],
   "engines": {
     "node": ">=18"
   },
@@ -46,6 +48,10 @@
     "jison": "^0.4.18",
     "onchange": "^7.1.0"
   },
+  "funding": {
+    "type": "liberapay",
+    "url": "https://liberapay.com/tldr-pages"
+  },
   "files": [
     "lib/"
   ]