Skip to content

Commit a95acbb

Browse files
lukeocodeslukeocodes
committed
chore: repo infrastructure — README, CI, npm publish, dependabot, community files, examples
- Root README with badges, quick start, hook reference - CI workflow (bun, checks out agent sibling) - Combined release-please + npm publish with provenance and file pointer swap - Dependabot for npm + github-actions - Community files: LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, issue/PR templates - .npmrc (save-exact), renovate.json (11-day min release age) - Basic example in examples/basic/ - Removed VadOptions re-export (VAD removed from SDK)
1 parent 85f6d66 commit a95acbb

21 files changed

Lines changed: 550 additions & 29 deletions

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @lukeocodes

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Bug Report
2+
description: Report a bug with @deepgram/react
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
id: summary
7+
attributes:
8+
label: What happened?
9+
description: A clear description of the bug.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: steps
15+
attributes:
16+
label: Steps to reproduce
17+
description: How can we reproduce the issue?
18+
placeholder: |
19+
1. Wrap component in AgentProvider
20+
2. Call useAgentState()
21+
3. ...
22+
23+
- type: textarea
24+
id: expected
25+
attributes:
26+
label: Expected behavior
27+
description: What did you expect to happen?
28+
29+
- type: dropdown
30+
id: package
31+
attributes:
32+
label: Package
33+
options:
34+
- "@deepgram/react"
35+
validations:
36+
required: true
37+
38+
- type: input
39+
id: browser
40+
attributes:
41+
label: Browser
42+
placeholder: "e.g. Chrome 125, Safari 18"
43+
44+
- type: textarea
45+
id: logs
46+
attributes:
47+
label: Relevant log output
48+
render: shell

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Deepgram Discord
4+
url: https://discord.gg/deepgram
5+
about: Ask questions and get help from the community
6+
- name: Deepgram Documentation
7+
url: https://developers.deepgram.com
8+
about: Official Deepgram documentation

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: proposal
7+
attributes:
8+
label: Proposed change
9+
description: What would you like to see added or changed?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: context
15+
attributes:
16+
label: Context
17+
description: Why is this needed? What problem does it solve?
18+
19+
- type: textarea
20+
id: implementation
21+
attributes:
22+
label: Possible implementation
23+
description: Any ideas on how this could be implemented?

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Proposed changes
2+
3+
<!-- Describe the changes and link any related issues -->
4+
5+
## Types of changes
6+
7+
- [ ] Bugfix
8+
- [ ] New feature
9+
- [ ] Breaking change
10+
- [ ] Documentation / tests
11+
12+
## Checklist
13+
14+
- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) guide
15+
- [ ] Code builds cleanly (`bun run build`)
16+
- [ ] Tests pass (`bun run test`)
17+
- [ ] Documentation updated (if applicable)
18+
19+
## Further comments
20+
21+
<!-- Any additional context or screenshots -->

‎.github/SECURITY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security
2+
3+
If you discover a security vulnerability, please email security@deepgram.com instead of opening a public issue.
4+
5+
We will respond within 48 hours and work with you to resolve the issue promptly.

‎.github/dependabot.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "npm"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
groups:
8+
dependencies:
9+
update-types: [patch, minor]
10+
- package-ecosystem: "github-actions"
11+
directory: "/"
12+
schedule:
13+
interval: "weekly"

‎.github/workflows/ci.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/checkout@v4
15+
with:
16+
repository: deepgram/agent
17+
path: ../agent
18+
- uses: oven-sh/setup-bun@v2
19+
with:
20+
bun-version: "1.3.10"
21+
- name: Build @deepgram/agent
22+
run: cd ../agent && bun install && bun run --filter '@deepgram/agent' build
23+
- run: bun install
24+
- name: Typecheck
25+
run: bun run typecheck
26+
- name: Build
27+
run: bun run build
28+
- name: Test
29+
run: bun run test

‎.github/workflows/npm-publish.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: npm Publish
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
permissions:
8+
contents: write
9+
pull-requests: write
10+
id-token: write
11+
12+
jobs:
13+
release-please:
14+
runs-on: ubuntu-latest
15+
outputs:
16+
release_created: ${{ steps.release.outputs['packages/react--release_created'] }}
17+
version: ${{ steps.release.outputs['packages/react--version'] }}
18+
steps:
19+
- uses: googleapis/release-please-action@v4
20+
id: release
21+
with:
22+
token: ${{ secrets.GITHUB_TOKEN }}
23+
config-file: release-please-config.json
24+
manifest-file: .release-please-manifest.json
25+
26+
publish:
27+
needs: release-please
28+
if: needs.release-please.outputs.release_created == 'true'
29+
runs-on: ubuntu-latest
30+
permissions:
31+
contents: read
32+
id-token: write
33+
steps:
34+
- uses: actions/checkout@v4
35+
- uses: actions/checkout@v4
36+
with:
37+
repository: deepgram/agent
38+
path: ../agent
39+
- uses: oven-sh/setup-bun@v2
40+
with:
41+
bun-version: "1.3.10"
42+
- uses: actions/setup-node@v4
43+
with:
44+
node-version: 22
45+
registry-url: https://registry.npmjs.org
46+
- name: Build @deepgram/agent
47+
run: cd ../agent && bun install && bun run --filter '@deepgram/agent' build
48+
- run: bun install
49+
- run: bun run build
50+
- name: Swap file pointers
51+
run: |
52+
SDK_VERSION=$(node -e "console.log(require('../agent/packages/sdk/package.json').version)")
53+
node -e "
54+
const fs = require('fs');
55+
const pkg = JSON.parse(fs.readFileSync('packages/react/package.json', 'utf8'));
56+
pkg.dependencies['@deepgram/agent'] = SDK_VERSION;
57+
fs.writeFileSync('packages/react/package.json', JSON.stringify(pkg, null, 2) + '\n');
58+
"
59+
- run: npm publish --provenance --access public
60+
working-directory: packages/react
61+
env:
62+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.github/workflows/release-please.yml‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)