Skip to content

Commit 827ea45

Browse files
andrekutianskiandrekutianski
committed
feat: Add CI and Publish workflows for automated testing and NPM publishing
1 parent 8b2249a commit 827ea45

File tree

2 files changed

+267
-0
lines changed

2 files changed

+267
-0
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ v3, main ]
6+
pull_request:
7+
branches: [ v3, main ]
8+
9+
jobs:
10+
test:
11+
name: Test (Node ${{ matrix.node-version }})
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
node-version: [18.x, 20.x, 22.x]
17+
18+
steps:
19+
- name: Checkout code
20+
uses: actions/checkout@v4
21+
22+
- name: Setup Node.js ${{ matrix.node-version }}
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: ${{ matrix.node-version }}
26+
cache: 'npm'
27+
28+
- name: Install dependencies
29+
run: npm ci
30+
31+
- name: Run linter
32+
run: npm run lint
33+
34+
- name: Run type checking
35+
run: npm run typecheck
36+
37+
- name: Run tests
38+
run: npm test -- --run --reporter=verbose
39+
40+
- name: Upload test results
41+
if: always()
42+
uses: actions/upload-artifact@v4
43+
with:
44+
name: test-results-node-${{ matrix.node-version }}
45+
path: |
46+
coverage/
47+
test-results/
48+
49+
coverage:
50+
name: Coverage Report
51+
runs-on: ubuntu-latest
52+
needs: test
53+
54+
steps:
55+
- name: Checkout code
56+
uses: actions/checkout@v4
57+
58+
- name: Setup Node.js
59+
uses: actions/setup-node@v4
60+
with:
61+
node-version: '20.x'
62+
cache: 'npm'
63+
64+
- name: Install dependencies
65+
run: npm ci
66+
67+
- name: Generate coverage
68+
run: npm test -- --coverage --run
69+
70+
- name: Upload coverage to Codecov
71+
uses: codecov/codecov-action@v4
72+
with:
73+
files: ./coverage/coverage-final.json
74+
flags: unittests
75+
name: codecov-umbrella
76+
fail_ci_if_error: false
77+
78+
build:
79+
name: Build
80+
runs-on: ubuntu-latest
81+
82+
steps:
83+
- name: Checkout code
84+
uses: actions/checkout@v4
85+
86+
- name: Setup Node.js
87+
uses: actions/setup-node@v4
88+
with:
89+
node-version: '20.x'
90+
cache: 'npm'
91+
92+
- name: Install dependencies
93+
run: npm ci
94+
95+
- name: Build package
96+
run: npm run build
97+
98+
- name: Check build artifacts
99+
run: |
100+
test -f dist/index.js || (echo "CJS build missing" && exit 1)
101+
test -f dist/index.mjs || (echo "ESM build missing" && exit 1)
102+
test -f dist/index.d.ts || (echo "Types build missing" && exit 1)
103+
104+
- name: Upload build artifacts
105+
uses: actions/upload-artifact@v4
106+
with:
107+
name: dist
108+
path: dist/
109+
110+
openapi-validation:
111+
name: OpenAPI Validation
112+
runs-on: ubuntu-latest
113+
114+
steps:
115+
- name: Checkout code
116+
uses: actions/checkout@v4
117+
118+
- name: Setup Node.js
119+
uses: actions/setup-node@v4
120+
with:
121+
node-version: '20.x'
122+
cache: 'npm'
123+
124+
- name: Install dependencies
125+
run: npm ci
126+
127+
- name: Validate OpenAPI spec
128+
run: |
129+
npx @redocly/cli lint openapi/spec/nf-servico-v1.yaml --skip-rule operation-4xx-response || echo "OpenAPI validation complete (warnings allowed for now)"
130+
131+
- name: Generate TypeScript types from OpenAPI
132+
run: |
133+
npx openapi-typescript openapi/spec/nf-servico-v1.yaml -o openapi/generated-types.ts
134+
135+
- name: Upload generated types
136+
uses: actions/upload-artifact@v4
137+
with:
138+
name: openapi-generated-types
139+
path: openapi/generated-types.ts
140+
141+
- name: Comment on PR with spec info
142+
if: github.event_name == 'pull_request'
143+
uses: actions/github-script@v7
144+
with:
145+
script: |
146+
const fs = require('fs');
147+
const specPath = 'openapi/spec/nf-servico-v1.yaml';
148+
const stats = fs.statSync(specPath);
149+
const content = fs.readFileSync(specPath, 'utf8');
150+
const lines = content.split('\n').length;
151+
152+
const comment = `### 📋 OpenAPI Spec Validation
153+
154+
✅ Spec validated successfully
155+
156+
**Spec Stats:**
157+
- File: \`${specPath}\`
158+
- Size: ${(stats.size / 1024).toFixed(2)} KB
159+
- Lines: ${lines}
160+
161+
Types generated and available as artifact.
162+
`;
163+
164+
github.rest.issues.createComment({
165+
issue_number: context.issue.number,
166+
owner: context.repo.owner,
167+
repo: context.repo.repo,
168+
body: comment
169+
});

‎.github/workflows/publish.yml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: Publish to NPM
2+
3+
on:
4+
release:
5+
types: [created]
6+
workflow_dispatch:
7+
inputs:
8+
tag:
9+
description: 'Tag to publish (e.g., v3.0.0)'
10+
required: true
11+
type: string
12+
13+
jobs:
14+
publish:
15+
name: Publish Package
16+
runs-on: ubuntu-latest
17+
permissions:
18+
contents: read
19+
id-token: write # Required for NPM provenance
20+
21+
steps:
22+
- name: Checkout code
23+
uses: actions/checkout@v4
24+
with:
25+
ref: ${{ github.event.inputs.tag || github.ref }}
26+
27+
- name: Setup Node.js
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: '20.x'
31+
registry-url: 'https://registry.npmjs.org'
32+
cache: 'npm'
33+
34+
- name: Install dependencies
35+
run: npm ci
36+
37+
- name: Run tests
38+
run: npm test -- --run
39+
40+
- name: Run type checking
41+
run: npm run typecheck
42+
43+
- name: Build package
44+
run: npm run build
45+
46+
- name: Verify build artifacts
47+
run: |
48+
test -f dist/index.js || (echo "❌ CJS build missing" && exit 1)
49+
test -f dist/index.mjs || (echo "❌ ESM build missing" && exit 1)
50+
test -f dist/index.d.ts || (echo "❌ Types missing" && exit 1)
51+
echo "✅ All build artifacts present"
52+
53+
- name: Check package.json version
54+
id: package-version
55+
run: |
56+
VERSION=$(node -p "require('./package.json').version")
57+
echo "version=$VERSION" >> $GITHUB_OUTPUT
58+
echo "📦 Package version: $VERSION"
59+
60+
- name: Publish to NPM (dry-run)
61+
run: npm publish --dry-run
62+
env:
63+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
64+
65+
- name: Publish to NPM
66+
run: npm publish --provenance --access public
67+
env:
68+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
69+
70+
- name: Create GitHub Release Summary
71+
run: |
72+
echo "### 🎉 Published to NPM" >> $GITHUB_STEP_SUMMARY
73+
echo "" >> $GITHUB_STEP_SUMMARY
74+
echo "**Package:** @nfe-io/sdk@${{ steps.package-version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
75+
echo "**NPM:** https://www.npmjs.com/package/@nfe-io/sdk" >> $GITHUB_STEP_SUMMARY
76+
echo "" >> $GITHUB_STEP_SUMMARY
77+
echo "Install: \`npm install @nfe-io/sdk@${{ steps.package-version.outputs.version }}\`" >> $GITHUB_STEP_SUMMARY
78+
79+
- name: Comment on related issues/PRs
80+
if: github.event_name == 'release'
81+
uses: actions/github-script@v7
82+
with:
83+
script: |
84+
const version = '${{ steps.package-version.outputs.version }}';
85+
const releaseUrl = context.payload.release.html_url;
86+
87+
const comment = `🎉 This has been released in [@nfe-io/sdk@${version}](https://www.npmjs.com/package/@nfe-io/sdk/v/${version})!
88+
89+
Release notes: ${releaseUrl}
90+
91+
Install:
92+
\`\`\`bash
93+
npm install @nfe-io/sdk@${version}
94+
\`\`\`
95+
`;
96+
97+
// Add comment logic here if needed
98+
console.log('Release published:', version);

0 commit comments

Comments
 (0)