Skip to content

Commit bc90929

Browse files
authored
internal: update frontmatter (#4806)
- refresh README, CONTRIBUTING - remove stale references to graphql conf 2025 and 2026 (we can restore graphql conf 2026 banner when talks are published)
1 parent 1f563b7 commit bc90929

4 files changed

Lines changed: 41 additions & 28 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,42 @@ ensure your pull request matches the style guides, run `npm run prettier`.
7373
- Trailing commas,
7474
- Avd abbr wrds.
7575

76+
## Documentation
77+
78+
The documentation website is published from the `17.x.x` branch. Website source
79+
lives under `website/`, with general guides in `website/pages/docs` and upgrade
80+
guides in `website/pages/upgrade-guides`.
81+
82+
The API reference pages are generated snapshots:
83+
84+
- `website/pages/api-v16` is generated from a v16 source ref.
85+
- `website/pages/api-v17` is generated from a v17 source ref.
86+
87+
Generate API docs from the website package:
88+
89+
```bash
90+
cd website
91+
npm run generate:docs -- 16.x.x 17.x.x
92+
```
93+
94+
The generator creates detached temporary git worktrees for the refs passed on
95+
the command line, infers the major version from each ref's `package.json`, and
96+
writes the corresponding `api-v*` output directory. Generated API docs are not
97+
published automatically at this time; PRs that change website API output must
98+
include the generated files.
99+
100+
Because the generator reads refs through temporary worktrees, it does not read
101+
uncommitted changes from your current checkout. Passing `17.x.x` reads the
102+
committed tip of the `17.x.x` branch, not local changes in a checked-out
103+
worktree. If a PR changes v17 API source comments or exported TypeScript
104+
surfaces, commit those source changes first and generate v17 docs from a ref
105+
that includes them, for example:
106+
107+
```bash
108+
cd website
109+
npm run generate:docs -- 16.x.x HEAD
110+
```
111+
76112
## Review and Merge Process
77113

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

118-
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.
154+
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.
119155

120156
## License
121157

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
[![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)
2-
31
# GraphQL.js
42

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

75
[![npm version](https://badge.fury.io/js/graphql.svg)](https://badge.fury.io/js/graphql)
8-
[![Build Status](https://github.com/graphql/graphql-js/workflows/CI/badge.svg?branch=main)](https://github.com/graphql/graphql-js/actions?query=branch%3Amain)
6+
[![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)
97

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

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

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

142-
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/).
140+
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/).
143141

144142
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.
145143

assets/graphql-conf-2025.png

-488 KB
Binary file not shown.

website/theme.config.tsx

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -213,30 +213,9 @@ const cfg: DocsThemeConfig = {
213213
</>
214214
);
215215
},
216-
banner: {
217-
content: (
218-
<>
219-
🎉{' '}
220-
<NextLink
221-
href="https://graphql.org/conf/2026/"
222-
className="underline after:content-['_→'] after:font-sans"
223-
>
224-
Explore GraphQLConf 2026
225-
</NextLink>{' '}
226-
• May 19-21 • Fremont, CA •{' '}
227-
<NextLink
228-
href="https://graphql.org/conf/2026/schedule/"
229-
className="underline after:content-['_→'] after:font-sans"
230-
>
231-
View the schedule
232-
</NextLink>
233-
</>
234-
),
235-
key: 'graphqlconf-2026',
236-
},
237216
logo: graphQLLogo,
238217
docsRepositoryBase:
239-
'https://github.com/graphql/graphql-js/tree/16.x.x/website',
218+
'https://github.com/graphql/graphql-js/tree/17.x.x/website',
240219
color: {
241220
hue: 319,
242221
},

0 commit comments

Comments
 (0)