Skip to content

Commit eaf6800

Browse files
committed
improved packaging and fixed issues with node version check
1 parent f4e213f commit eaf6800

17 files changed

Lines changed: 1777 additions & 77 deletions

.changeset/config.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/config@3.0.4/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [],
6+
"linked": [],
7+
"access": "public",
8+
"baseBranch": "main",
9+
"updateInternalDependencies": "patch",
10+
"ignore": []
11+
}
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Release create-apiops
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
pull-requests: write
12+
13+
jobs:
14+
release:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Setup Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: 22
26+
registry-url: https://registry.npmjs.org
27+
cache: npm
28+
29+
- name: Install dependencies
30+
run: npm ci
31+
32+
- name: Inspect root package contents
33+
run: npm run check:package:contents
34+
35+
- name: Run create-apiops scaffold integration test
36+
run: npm run test:create-apiops
37+
38+
- name: Version and publish create-apiops
39+
uses: changesets/action@v1
40+
with:
41+
version: npx changeset version
42+
commit: "chore(release): version create-apiops"
43+
title: "chore(release): version create-apiops"
44+
createGithubReleases: true
45+
publish: npm publish --workspace packages/create-apiops --access public
46+
env:
47+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
node_modules
2+
.npm-pack-cache/
23

34
# translation cache and temporary translation folder
45
.json-autotranslate-cache
5-
src/data/locales/
6+
src/data/locales/

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The module exposes top-level exports so you can import the data files directly,
2828

2929
```js
3030
import stations from "apiops-cycles-method-data/method/stations.json";
31-
import canvasData from "apiops-cycles-method-data/canvasData";
31+
import canvasData from "apiops-cycles-method-data/canvasData.json";
3232
```
3333

3434
Validate the files locally with:
@@ -46,6 +46,16 @@ Install dependencies once with:
4646
npm install
4747
```
4848

49+
## Create a new APIOps project (CLI)
50+
51+
Once `create-apiops` is published to npm, you can scaffold a new project with:
52+
53+
```bash
54+
npm create apiops@latest
55+
```
56+
57+
This command runs the `create-apiops` initializer package and generates a starter APIOps project template in your current directory.
58+
4959
## Contributing
5060

5161
### Reporting issues or requesting features

0 commit comments

Comments
 (0)