node-lifecycle 1.0.2 โ†’ 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +84 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -10,18 +10,57 @@ Check the lifecycle status (Current, Active LTS, Maintenance, or EOL) of any Nod
10
10
 
11
11
  ## ๐Ÿ“ฆ Installation
12
12
 
13
- Install globally to use the CLI anywhere:
14
-
15
- ```bash
13
+ ### Option 1: Global install (CLI available anywhere)
14
+ ```
16
15
  npm install -g node-lifecycle
17
16
  ```
18
17
 
19
- Or run without installing globally:
18
+ After this, you can run the CLI directly:
19
+
20
+ ```
21
+ node-lifecycle
22
+ ```
23
+
24
+ ### Option 2: Local install (in your project)
25
+
26
+ ```
27
+ npm install --save-dev node-lifecycle
28
+ ```
29
+
30
+ With a local install, binaries live in `node_modules/.bin`.
31
+
32
+ You can run it in one of two ways:
33
+
34
+ Use npx (simple):
20
35
 
21
36
  ```
22
37
  npx node-lifecycle
23
38
  ```
24
39
 
40
+ OR:
41
+
42
+ Add an npm script:
43
+ ```
44
+ "scripts": {
45
+ "check-node": "node-lifecycle"
46
+ }
47
+ ```
48
+
49
+ Then run:
50
+ ```
51
+ npm run check-node
52
+ ```
53
+
54
+ ### Option 3: Run without installing at all
55
+
56
+ ```
57
+ npx node-lifecycle
58
+ ```
59
+
60
+ This will fetch the latest version from npm on demand.
61
+
62
+ ### Option 4: CircleCi Only - See CI Config Below
63
+
25
64
  ## ๐Ÿš€ Usage
26
65
 
27
66
  Check the status of your current Node.js version:
@@ -75,7 +114,46 @@ node-lifecycle --version=18.20.4 --no-fail
75
114
  | `2` | EOL (unless `--no-fail` is used, then `0`) |
76
115
 
77
116
 
78
- ## ๐Ÿงช CI Integration
117
+ ## ๐Ÿงช CI Integration and GitHub Actions
118
+
119
+ ### CircleCI
120
+
121
+ There are two ways to use `node-lifecycle` in CircleCI:
122
+
123
+ **Without installing in your repo (uses npx)**
124
+
125
+ This always fetches the latest published version from npm:
126
+
127
+ ```
128
+ jobs:
129
+ verify:
130
+ docker:
131
+ - image: cimg/node:20.12
132
+ steps:
133
+ - checkout
134
+ - run:
135
+ name: Node lifecycle check
136
+ command: npx node-lifecycle --warn-days=180
137
+ ```
138
+
139
+ **With devDependencies (preferred if already in your repo)**
140
+
141
+ If you already have `node-lifecycle` in devDependencies, `npm ci` will install it and you can run it directly:
142
+
143
+ ```
144
+ jobs:
145
+ verify:
146
+ docker:
147
+ - image: cimg/node:20.12
148
+ steps:
149
+ - checkout
150
+ - run: npm ci
151
+ - run:
152
+ name: Node lifecycle check
153
+ command: node-lifecycle --warn-days=180
154
+ ```
155
+
156
+ ### GitHub Actions
79
157
 
80
158
  Example GitHub Actions job to fail if Node.js is near or past EOL:
81
159
 
@@ -89,6 +167,7 @@ jobs:
89
167
  - run: node-lifecycle
90
168
  ```
91
169
 
170
+
92
171
  ## ๐Ÿ“„ License
93
172
 
94
173
  MIT ยฉ 2025 Kelsey Salguera
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "node-lifecycle",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "description": "CLI tool to check Node.js version lifecycle and EOL status",
5
5
  "type": "module",
6
6
  "bin": {