Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,42 @@ ensure your pull request matches the style guides, run `npm run prettier`.
- Trailing commas,
- Avd abbr wrds.

## Documentation

The documentation website is published from the `17.x.x` branch. Website source
lives under `website/`, with general guides in `website/pages/docs` and upgrade
guides in `website/pages/upgrade-guides`.

The API reference pages are generated snapshots:

- `website/pages/api-v16` is generated from a v16 source ref.
- `website/pages/api-v17` is generated from a v17 source ref.

Generate API docs from the website package:

```bash
cd website
npm run generate:docs -- 16.x.x 17.x.x
```

The generator creates detached temporary git worktrees for the refs passed on
the command line, infers the major version from each ref's `package.json`, and
writes the corresponding `api-v*` output directory. Generated API docs are not
published automatically at this time; PRs that change website API output must
include the generated files.

Because the generator reads refs through temporary worktrees, it does not read
uncommitted changes from your current checkout. Passing `17.x.x` reads the
committed tip of the `17.x.x` branch, not local changes in a checked-out
worktree. If a PR changes v17 API source comments or exported TypeScript
surfaces, commit those source changes first and generate v17 docs from a ref
that includes them, for example:

```bash
cd website
npm run generate:docs -- 16.x.x HEAD
```

## Review and Merge Process

- Pull requests are required to pass all tests and checks before they can be merged.
Expand Down Expand Up @@ -115,7 +151,7 @@ npm run release:prepare -- 17.x.x prerelease --preid rc
When `--preid` is provided, the release script uses it as the npm publish tag.
Without a prerelease preid, the publish tag is `latest`.

Push `<my_release_branch>`, open a PR from `<my_release_branch>` to `17.x.x`, wait for CI to pass, merge the PR, and then approve the GitHub Actions release workflow. The workflow currently runs in dry-run mode for testing.
Push `<my_release_branch>`, open a PR from `<my_release_branch>` to `17.x.x`, wait for CI to pass, merge the PR, and then approve the GitHub Actions release workflow.

## License

Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
[![GraphQLConf 2025 Banner: September 08-10, Amsterdam. Hosted by the GraphQL Foundation](./assets/graphql-conf-2025.png)](https://graphql.org/conf/2025/?utm_source=github&utm_medium=graphql_js&utm_campaign=readme)

# GraphQL.js

The JavaScript reference implementation for GraphQL, a query language for APIs created by Facebook.

[![npm version](https://badge.fury.io/js/graphql.svg)](https://badge.fury.io/js/graphql)
[![Build Status](https://github.com/graphql/graphql-js/workflows/CI/badge.svg?branch=main)](https://github.com/graphql/graphql-js/actions?query=branch%3Amain)
[![Build Status](https://github.com/graphql/graphql-js/workflows/CI/badge.svg?branch=17.x.x)](https://github.com/graphql/graphql-js/actions?query=branch%3A17.x.x)

See more complete documentation at https://graphql.org/ and
https://graphql.org/graphql-js/.
Expand Down Expand Up @@ -111,7 +109,7 @@ graphql({ schema, source }).then((result) => {
## Want to ride the bleeding edge?

The `npm` branch in this repository is automatically maintained to be the last
commit to `main` to pass all tests, in the same form found on npm. It is
commit to `17.x.x` to pass all tests, in the same form found on npm. It is
recommended to use builds deployed to npm for many reasons, but if you want to use
the latest not-yet-released version of graphql-js, you can do so by depending
directly on this branch:
Expand Down Expand Up @@ -139,7 +137,7 @@ in files with the `.js` extension and the ESModule build within `.mjs` files.

We actively welcome pull requests. Learn how to [contribute](./.github/CONTRIBUTING.md).

This repository is managed by EasyCLA. Project participants must sign the free ([GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/).
This repository is managed by EasyCLA. Project participants must sign the free [GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/).

To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.

Expand Down
Binary file removed assets/graphql-conf-2025.png
Binary file not shown.
23 changes: 1 addition & 22 deletions website/theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -213,30 +213,9 @@ const cfg: DocsThemeConfig = {
</>
);
},
banner: {
content: (
<>
🎉{' '}
<NextLink
href="https://graphql.org/conf/2026/"
className="underline after:content-['_→'] after:font-sans"
>
Explore GraphQLConf 2026
</NextLink>{' '}
• May 19-21 • Fremont, CA •{' '}
<NextLink
href="https://graphql.org/conf/2026/schedule/"
className="underline after:content-['_→'] after:font-sans"
>
View the schedule
</NextLink>
</>
),
key: 'graphqlconf-2026',
},
logo: graphQLLogo,
docsRepositoryBase:
'https://github.com/graphql/graphql-js/tree/16.x.x/website',
'https://github.com/graphql/graphql-js/tree/17.x.x/website',
color: {
hue: 319,
},
Expand Down
Loading