Skip to content

Commit 6d55cf5

Browse files
committed
docs:updated docs for scope change
1 parent 963c235 commit 6d55cf5

File tree

10 files changed

+25
-25
lines changed

10 files changed

+25
-25
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
strategy:
2020
fail-fast: false
2121
matrix:
22-
node: [20, 22, 23, 24]
22+
node: [22, 23, 24]
2323
os: [ubuntu-latest, windows-latest, macos-latest]
2424

2525
steps:

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![CI](https://github.com/arkahna/git-file-fetch/actions/workflows/ci.yml/badge.svg)](https://github.com/arkahna/git-file-fetch/actions/workflows/ci.yml)
44
[![npm version](https://img.shields.io/npm/v/@arkahna-npm/git-file-fetch)](https://www.npmjs.com/package/@arkahna-npm/git-file-fetch)
55
[![license: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE)
6-
[![node >= 20](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](#requirements)
6+
[![node >= 22](https://img.shields.io/badge/node-%3E%3D22-brightgreen.svg)](#requirements)
77

88
A lightweight CLI to fetch individual files from remote Git repositories and track them locally for reproducibility.
99

@@ -58,7 +58,7 @@ node dist/index.js "https://github.com/octokit/core.js.git@main:LICENSE" --dry-r
5858
## Requirements
5959

6060
- **Git** available on your PATH
61-
- **Node.js** >= 20 (supports 20, 22, 23, 24)
61+
- **Node.js** >= 22 (supports 22, 23, 24)
6262

6363
## License
6464

arkahna-git-file-fetch-0.1.0.tgz

-8.47 KB
Binary file not shown.

docs/ci-integration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727

2828
- uses: actions/setup-node@v4
2929
with:
30-
node-version: 20
30+
node-version: 22
3131
cache: npm
3232

3333
- name: Verify external files
@@ -44,7 +44,7 @@ jobs:
4444
4545
```yaml
4646
verify:
47-
image: node:20-alpine
47+
image: node:22-alpine
4848
before_script:
4949
- apk add --no-cache git
5050
script:
@@ -107,7 +107,7 @@ jobs:
107107
- uses: actions/checkout@v4
108108
- uses: actions/setup-node@v4
109109
with:
110-
node-version: 20
110+
node-version: 22
111111
112112
- name: Update external files
113113
run: |
@@ -130,7 +130,7 @@ Test against different environments:
130130
strategy:
131131
matrix:
132132
environment: [staging, production]
133-
node-version: [20, 22, 23, 24]
133+
node-version: [22, 23, 24]
134134
135135
jobs:
136136
test:

docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ jobs:
193193
- uses: actions/checkout@v4
194194
- uses: actions/setup-node@v4
195195
with:
196-
node-version: 20
196+
node-version: 22
197197
- run: |
198198
npx @arkahna/git-file-fetch \
199199
--config deps.json \
@@ -206,7 +206,7 @@ jobs:
206206
207207
```yaml
208208
fetch-deps:
209-
image: node:20
209+
image: node:22
210210
script:
211211
- npx @arkahna/git-file-fetch --config deps.json --out third_party --json
212212
artifacts:

docs/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
Thanks for taking the time to contribute! This project is a small, focused CLI (with a thin Nx executor) that fetches specific files from remote Git repositories and records provenance.
44

55
- **Binary**: `git-file-fetch`
6-
- **Node**: >= 20 (supports 20, 22, 23, 24)
6+
- **Node**: >= 22 (supports 22, 23, 24)
77
- **Packages**: TypeScript, ESLint, Prettier
88

99
## Getting started
1010

1111
- Fork and clone the repo
12-
- Ensure you have Node 20/22/23/24 available and `pnpm` installed
12+
- Ensure you have Node 22/23/24 available and `pnpm` installed
1313
- Install deps:
1414

1515
```bash

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ pnpm run test:smoke
6565
## Requirements
6666

6767
- **Git** available on your PATH
68-
- **Node.js** >= 20 (supports 20, 22, 23, 24)
68+
- **Node.js** >= 22 (supports 22, 23, 24)
6969

7070
## Basic Usage
7171

@@ -116,7 +116,7 @@ jobs:
116116
- uses: actions/checkout@v4
117117
- uses: actions/setup-node@v4
118118
with:
119-
node-version: 20
119+
node-version: 22
120120
- run: npx git-file-fetch "https://github.com/octokit/core.js.git@main:LICENSE" --dry-run --json
121121
```
122122

docs/roadmap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ We're currently in the final stages of preparation before our first npm release.
1717
- [x] **CLI Help**: Clear flags, examples, and exit codes
1818
- [x] **Manifest Policy**: Documented both commit and .gitignore patterns
1919
- [x] **Security Basics**: Token redaction, path traversal prevention, input validation, file size limits
20-
- [x] **CI/CD**: Matrix builds on Ubuntu, macOS, Windows across Node 20/22/23/24
20+
- [x] **CI/CD**: Matrix builds on Ubuntu, macOS, Windows across Node 22/23/24
2121
- [x] **Release Workflow**: Automated npm publish with provenance
2222
- [x] **Smoke Tests**: Validated against public repos on all platforms
2323
- [x] **Error Handling**: Documented non-zero exit codes with stable error identifiers
@@ -166,7 +166,7 @@ We're currently in the final stages of preparation before our first npm release.
166166

167167
- [ ] **Platform Testing**:
168168
- [ ] OS: Linux, macOS, Windows
169-
- [ ] Node: 20, 22, 23, 24
169+
- [ ] Node: 22, 23, 24
170170
- [ ] Providers: GitHub public, GitHub private (token), rate-limited scenario
171171
- [ ] **Feature Testing**:
172172
- [ ] Single file fetch

docs/usage.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## CLI Synopsis
44

55
```bash
6-
@arkahna/git-file-fetch '<repo.git>@<ref>:<path>' [more...] [--dry-run] [--force] [--out <dir>] [--cwd <dir>] [--manifest <path>] [--max-bytes <n>] [--config <file>] [--timeout-ms <n>] [--retries <n>] [--retry-backoff-ms <n>] [--eject] [--json] [--quiet] [--verbose]
6+
@arkahna-npm/git-file-fetch '<repo.git>@<ref>:<path>' [more...] [--dry-run] [--force] [--out <dir>] [--cwd <dir>] [--manifest <path>] [--max-bytes <n>] [--config <file>] [--timeout-ms <n>] [--retries <n>] [--retry-backoff-ms <n>] [--eject] [--json] [--quiet] [--verbose]
77
```
88

99
## Command Line Options
@@ -65,30 +65,30 @@ https://github.com/user/repo.git:src/config.json
6565

6666
```bash
6767
# Fetch a single file
68-
npx @arkahna/git-file-fetch "https://github.com/user/repo.git@main:src/utils/logger.ts"
68+
npx @arkahna-npm/git-file-fetch "https://github.com/user/repo.git@main:src/utils/logger.ts"
6969

7070
# Fetch with specific tag
71-
npx @arkahna/git-file-fetch "https://github.com/user/[email protected]:LICENSE"
71+
npx @arkahna-npm/git-file-fetch "https://github.com/user/[email protected]:LICENSE"
7272

7373
# Eject: copy the file without adding to manifest
74-
npx @arkahna/git-file-fetch "https://github.com/user/repo.git@main:src/utils/logger.ts" --eject
74+
npx @arkahna-npm/git-file-fetch "https://github.com/user/repo.git@main:src/utils/logger.ts" --eject
7575

7676
# Dry run (simulate without writing files)
77-
npx @arkahna/git-file-fetch "https://github.com/user/repo.git@main:src/file.ts" --dry-run
77+
npx @arkahna-npm/git-file-fetch "https://github.com/user/repo.git@main:src/file.ts" --dry-run
7878

7979
# Specify output directory
80-
npx @arkahna/git-file-fetch "https://github.com/user/repo.git@main:tools/script.sh" --out third_party
80+
npx @arkahna-npm/git-file-fetch "https://github.com/user/repo.git@main:tools/script.sh" --out third_party
8181

8282
# Config file with JSON output
83-
npx @arkahna/git-file-fetch --config refs.json --out third_party --json --quiet
83+
npx @arkahna-npm/git-file-fetch --config refs.json --out third_party --json --quiet
8484
```
8585

8686
## Advanced Usage Examples
8787

8888
### Multiple Files in One Run
8989

9090
```bash
91-
npx @arkahna/git-file-fetch \
91+
npx @arkahna-npm/git-file-fetch \
9292
"https://github.com/user/[email protected]:LICENSE" \
9393
"https://github.com/user/another-repo.git@main:src/templates/readme.md"
9494
```
@@ -107,7 +107,7 @@ Create a JSON file with multiple references:
107107
Then use it:
108108

109109
```bash
110-
npx @arkahna/git-file-fetch --config refs.json --out vendor --json
110+
npx @arkahna-npm/git-file-fetch --config refs.json --out vendor --json
111111
```
112112

113113
## Manifest

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"typescript": "^5.9.2"
5353
},
5454
"engines": {
55-
"node": ">=20.0.0 <25.0.0"
55+
"node": ">=22.0.0 <25.0.0"
5656
},
5757
"files": [
5858
"dist",

0 commit comments

Comments
 (0)