Skip to content

Commit e5af812

Browse files
committed
feat: v0.0.14 release
Signed-off-by: K.B.Dharun Krishna <[email protected]>
1 parent c336197 commit e5af812

File tree

4 files changed

+63
-12
lines changed

4 files changed

+63
-12
lines changed

.github/workflows/publish.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# This workflow automatically publishes the package to NPM when a new release is created.
2+
# Before, creating a new release, make sure to update the package version in package.json
3+
# and add a Granular Access Token (with read and write packages scope)
4+
# to the repository secrets with the name NPM_TOKEN.
5+
# Once, the release has been published remove it from the repository secrets.
6+
7+
name: Publish Package to NPM
8+
on:
9+
release:
10+
types: [published]
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
# Setup .npmrc file to publish to npm
17+
- uses: actions/setup-node@v4
18+
with:
19+
node-version: '20.x'
20+
registry-url: 'https://registry.npmjs.org'
21+
- run: npm ci
22+
- run: npm publish
23+
env:
24+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,52 +4,66 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com).
66

7+
## [v0.0.14 - 2024-04-20](https://github.com/tldr-pages/tldr-lint/compare/v0.0.13...v0.0.14)
8+
9+
- Add rule `TLDR110` ([#306]https://github.com/tldr-pages/tldr-lint/pull/306))
10+
711
## [v0.0.13 - 2021-10-12](https://github.com/tldr-pages/tldr-lint/compare/v0.0.12...v0.0.13)
812

913
### Changed
14+
1015
- Allow exceptions to rule `TLDR003` ([#104](https://github.com/tldr-pages/tldr-lint/pull/104))
1116

1217
## [v0.0.12 - 2021-10-04](https://github.com/tldr-pages/tldr-lint/compare/v0.0.11...v0.0.12)
1318

1419
### Added
20+
1521
- Allow special uppercased characters ([#101](https://github.com/tldr-pages/tldr-lint/pull/101))
1622

1723
### Changed
24+
1825
- Update to test against Node 16.x ([#90](https://github.com/tldr-pages/tldr-lint/pull/90))
1926

2027
## [v0.0.11 - 2021-04-14](https://github.com/tldr-pages/tldr-lint/compare/v0.0.10...v0.0.11)
2128

2229
### Added
30+
2331
- Add CLI flag to ignore specific errors ([#69](https://github.com/tldr-pages/tldr-lint/pull/69))
2432

2533
### Changed
34+
2635
- Allow words at the beginning of example descriptions to end with "ys" ([#60](https://github.com/tldr-pages/tldr-lint/pull/60))
2736
- Print out filename above parse errors ([#62](https://github.com/tldr-pages/tldr-lint/pull/62))
2837

2938
### Fixed
39+
3040
- Fix passing options to CLI ([#59](https://github.com/tldr-pages/tldr-lint/pull/59))
3141

3242
## [v0.0.10 - 2021-03-01](https://github.com/tldr-pages/tldr-lint/compare/v0.0.9...v0.0.10)
3343

3444
### Added
45+
3546
- Add rule `TLDR107` ([#34](https://github.com/tldr-pages/tldr-lint/pull/34))
3647
- Add rule `TLDR108` ([#39](https://github.com/tldr-pages/tldr-lint/pull/39))
3748
- Add rule `TLDR109` ([#42](https://github.com/tldr-pages/tldr-lint/pull/42))
3849

3950
### Changed
51+
4052
- Allow pages with `+` character in title ([#33](https://github.com/tldr-pages/tldr-lint/pull/33))
4153
- Allow pages with `[` chacacter in title ([#44](https://github.com/tldr-pages/tldr-lint/pull/44))
4254
- Add ESLint for JS linting ([#50](https://github.com/tldr-pages/tldr-lint/pull/50))
4355

4456
## [v0.0.9 - 2020-12-23](https://github.com/tldr-pages/tldr-lint/compare/v0.0.8...v0.0.9)
4557

4658
### Added
59+
4760
- Add rule `TLDR016` ([#20](https://github.com/tldr-pages/tldr-lint/pull/20))
4861
- Add rule `TLDR017` ([#20](https://github.com/tldr-pages/tldr-lint/pull/20))
4962
- Add rule `TLDR018` ([#22](https://github.com/tldr-pages/tldr-lint/pull/22))
5063
- Add rule `TLDR019` ([#23](https://github.com/tldr-pages/tldr-lint/pull/23))
5164

5265
### Changed
66+
5367
- Replace Grunt with npm scripts locally ([#21](https://github.com/tldr-pages/tldr-lint/pull/21))
5468
- Update CI to always use colour output ([#24](https://github.com/tldr-pages/tldr-lint/pull/24))
5569
- 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).
5872
## [v0.0.8 - 2020-10-02](https://github.com/tldr-pages/tldr-lint/compare/v0.0.7...v0.0.8)
5973

6074
### Added
75+
6176
- Add rule `TLDR014`
6277
- Add rule `TLDR015`
6378
- Add rule `TLDR105`
6479

6580
### Changed
81+
6682
- Only allow one command per example
6783
- Disallow trailing characters in `TLDR005`
6884

6985
## [v0.0.7 - 2016-01-19](https://github.com/tldr-pages/tldr-lint/compare/v0.0.6...v0.0.7)
7086

7187
### Added
88+
7289
- Add rule `TLDR104`
7390
- Add rule `TLDR106`
7491

7592
### Changed
93+
7694
- Improve checking on `TLDR103`
7795

7896
## [v0.0.6 - 2016-01-14](https://github.com/tldr-pages/tldr-lint/compare/v0.0.5...v0.0.6)
7997

8098
### Added
99+
81100
- Add rule `TLDR101`
82101
- Add rule `TLDR102`
83102
- Add rule `TLDR103`
84103

85104
## [v0.0.5 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.4...v0.0.5)
86105

87106
### Added
107+
88108
- Add `tldrl` binary, as well as `tldr-lint`
89109

90110
### Changed
111+
91112
- Allow periods in title, just not at the end
92113

93114
### Fixed
115+
94116
- Fix example description regex
95117

96118
## [v0.0.4 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.3...v0.0.4)
97119

98120
### Added
121+
99122
- Add support for directories
100123

101124
## [v0.0.3 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.2...v0.0.3)
102125

103126
### Fixed
127+
104128
- Add exception to `TLDR003`
105129

106130
## [v0.0.2 - 2016-01-13](https://github.com/tldr-pages/tldr-lint/compare/v0.0.1...v0.0.2)
107131

108132
### Added
133+
109134
- Add rule `TLDR002`
110135
- Add rule `TLDR003`
111136
- Add rule `TLDR004`
@@ -120,10 +145,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com).
120145
- Add rule `TLDR013`
121146

122147
### Fixed
148+
123149
- Fix writing to files with `-o`
124150

125151
## [v0.0.1 - 2016-01-07](https://github.com/tldr-pages/tldr-lint/commit/4570c2fe189e5fcc0ebd42b4cd4f63ac171ae07e)
126152

127153
### Added
154+
128155
- Initial release
129156
- Add rule `TLDR001`

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ It can also format your pages for you!
1111

1212
`tldr-lint` and its alias `tldrl` can be installed via `npm`:
1313

14-
```
14+
```sh
1515
npm install --global tldr-lint
1616
```
1717

1818
## Usage
1919

2020
It's really simple.
2121

22-
```
22+
```txt
2323
Usage: tldr-lint [options] <file|dir>
2424
2525
Options:
@@ -75,11 +75,5 @@ TLDR110 | Command example should not be empty
7575
[github-actions-url]: https://github.com/tldr-pages/tldr-lint/actions
7676
[github-actions-image]: https://img.shields.io/github/actions/workflow/status/tldr-pages/tldr-lint/test.yml?branch=main
7777

78-
[dep-url]: https://david-dm.org/tldr-pages/tldr-lint
79-
[dep-image]: https://img.shields.io/david/tldr-pages/tldr-lint.svg
80-
81-
[dev-dep-url]: https://david-dm.org/tldr-pages/tldr-lint#info=devDependencies
82-
[dev-dep-image]: https://img.shields.io/david/dev/tldr-pages/tldr-lint.svg
83-
8478
[matrix-url]: https://matrix.to/#/#tldr-pages:matrix.org
8579
[matrix-image]: https://img.shields.io/matrix/tldr-pages:matrix.org?label=chat+on+matrix

package.json

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "tldr-lint",
3-
"version": "0.0.13",
3+
"version": "0.0.14",
44
"description": "A linting tool to validate tldr pages",
55
"repository": "tldr-pages/tldr-lint",
66
"scripts": {
@@ -27,9 +27,11 @@
2727
"name": "Ruben Vereecken",
2828
"email": "[email protected]"
2929
},
30-
"maintainers": {
31-
"name": "tldr-pages team"
32-
},
30+
"maintainers": [
31+
{
32+
"name": "tldr-pages team"
33+
}
34+
],
3335
"engines": {
3436
"node": ">=18"
3537
},
@@ -46,6 +48,10 @@
4648
"jison": "^0.4.18",
4749
"onchange": "^7.1.0"
4850
},
51+
"funding": {
52+
"type": "liberapay",
53+
"url": "https://liberapay.com/tldr-pages"
54+
},
4955
"files": [
5056
"lib/"
5157
]

0 commit comments

Comments
 (0)