Skip to content

Commit c03881b

Browse files
committed
Introduces @github/models
0 parents  commit c03881b

23 files changed

+7450
-0
lines changed

.github/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# For more information, see [docs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-syntax)
2+
3+
# This repository is maintained by:
4+
* @github/github-models-reviewers

.github/dependabot.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: '/'
5+
schedule:
6+
interval: weekly
7+
open-pull-requests-limit: 99
8+
groups:
9+
all-dependencies:
10+
patterns:
11+
- '*'
12+
- package-ecosystem: github-actions
13+
directory: '/'
14+
schedule:
15+
interval: weekly
16+
open-pull-requests-limit: 99

.github/workflows/publish.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Publish
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
permissions:
8+
contents: read
9+
id-token: write
10+
11+
jobs:
12+
publish-npm:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions/setup-node@v4
17+
with:
18+
node-version: 22
19+
registry-url: https://registry.npmjs.org/
20+
cache: npm
21+
- run: npm ci
22+
- run: npm run test
23+
- run: npm version ${TAG_NAME} --git-tag-version=false
24+
env:
25+
TAG_NAME: ${{ github.event.release.tag_name }}
26+
- run: npm whoami; npm --ignore-scripts publish --provenance
27+
env:
28+
NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/test.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Test
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
test:
12+
name: 'Test Node.js (v${{ matrix.node-version }})'
13+
runs-on: ubuntu-latest
14+
strategy:
15+
matrix:
16+
node-version: [20, 22, 24]
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: ${{ matrix.node-version }}
22+
cache: npm
23+
- run: npm ci
24+
- run: npm run lint
25+
- run: npm run test
26+
- run: npm publish --dry-run
27+
28+
# All "needs" jobs will need to succeed for a pull request to be merged.
29+
results:
30+
if: always()
31+
runs-on: ubuntu-latest
32+
needs: [test]
33+
steps:
34+
- name: Check Results
35+
run: |
36+
outcome='${{ toJSON(needs.*.result) }}'
37+
if [[ $(echo $outcome | jq -e 'all(. == "success")') != "true" ]]; then
38+
echo "Some required steps failed!";
39+
exit 1;
40+
fi

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
node_modules/
2+
dist/
3+
.eslintcache
4+
npm-debug.log
5+
.env
6+
deno.lock
7+
examples/**/package-lock.json

code_of_conduct.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at <opensource@github.com>. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

contributing.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github/models-ai-sdk/fork
4+
[pr]: https://github.com/github/models-ai-sdk/compare
5+
6+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
7+
8+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](./license.txt).
9+
10+
Please note that this project is released with a [Contributor Code of Conduct](.github/code_of_conduct.md). By participating in this project you agree to abide by its terms.
11+
12+
## Prerequisites for running and testing code
13+
14+
These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
15+
16+
1. Install Node.js [through download](https://nodejs.org/download) and ensure it's at least version 24.
17+
18+
## Submitting a pull request
19+
20+
1. [Fork][fork] and clone the repository
21+
1. Make sure the tests pass on your machine: `npm run test`
22+
1. Create a new branch: `git checkout -b my-branch-name`
23+
1. Make your change, add tests, and make sure the tests and linter still pass: `npm run test` and `npm run lint`
24+
1. Push to your fork and [submit a pull request][pr]
25+
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
26+
27+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
28+
29+
- Write tests.
30+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
31+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
32+
33+
## Resources
34+
35+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
36+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
37+
- [GitHub Help](https://help.github.com)

eslint.config.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import githubRecommended from 'eslint-plugin-github/lib/configs/flat/recommended.js'
2+
import githubTypescript from 'eslint-plugin-github/lib/configs/flat/typescript.js'
3+
import simpleImportSort from 'eslint-plugin-simple-import-sort'
4+
5+
export default [
6+
{
7+
ignores: ['dist/**', 'examples/**'],
8+
},
9+
githubRecommended,
10+
...githubTypescript,
11+
{
12+
plugins: {
13+
'simple-import-sort': simpleImportSort,
14+
},
15+
rules: {
16+
'simple-import-sort/imports': 'error',
17+
'simple-import-sort/exports': 'error',
18+
'import/newline-after-import': 'error',
19+
'sort-imports': 'off',
20+
},
21+
},
22+
{
23+
files: ['eslint.config.js'],
24+
rules: {
25+
'import/extensions': 'off',
26+
},
27+
},
28+
]

examples/ai/generate-text.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import {githubModels} from '@github/models'
2+
import {generateText} from 'ai'
3+
import 'dotenv/config'
4+
5+
const result = await generateText({
6+
model: githubModels('openai/gpt-4o'),
7+
prompt: 'I want 100 words on how to inflate a balloon.',
8+
})
9+
10+
console.log('Text:')
11+
console.log(result.text)
12+
console.log()
13+
14+
console.log('Token usage:', result.usage)
15+
console.log('Finish reason:', result.finishReason)

examples/ai/package.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"name": "examples_ai",
3+
"version": "0.0.0",
4+
"private": true,
5+
"type": "module",
6+
"engines": {
7+
"node": ">=24"
8+
},
9+
"dependencies": {
10+
"@github/models": "file:../../",
11+
"ai": "beta",
12+
"dotenv": "^17"
13+
}
14+
}

0 commit comments

Comments
 (0)