rfc: API History Schema #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erickzhao
reviewed
Jun 18, 2024
Co-authored-by: Erick Zhao <erick@hotmail.ca>
| the experience of a user upgrading major versions of Electron in their project. | ||
| The process should ideally be as effortless as possible. | ||
|
|
||
| ## Unresolved questions |
There was a problem hiding this comment.
One interesting question is how this impacts / can be used in @electron/docs-parser. The module we use to to generate structured docs from markdown.
It's possible that the website we should build the parsing of this schema into that module and then have the website use @electron/docs-parser to do it's actual parsing. But in any case at a minimum that module will need to be updated to parse/ignore/consume the new block as we probably don't want it appearing raw in the typescript docs for instance.
There was a problem hiding this comment.
But in any case at a minimum that module will need to be updated to parse/ignore/consume the new block as we probably don't want it appearing raw in the typescript docs for instance.
Cough, electron/docs-parser#113.
dsanders11
reviewed
Jul 4, 2024
dsanders11
reviewed
Jul 4, 2024
dsanders11
reviewed
Jul 4, 2024
piotrpdev
commented
Jul 4, 2024
dsanders11
approved these changes
Jul 10, 2024
2 tasks
piotrpdev
added a commit
to electron/website
that referenced
this pull request
Jul 12, 2024
dsanders11
added a commit
to electron/website
that referenced
this pull request
Aug 12, 2024
* feat(api-history): basic webpack and remark plugin * feat(api-history): basic table * feat(api-history): minor table styling * refactor(api-history): move regexp to variable * feat(api-history): better regexp * feat(api-history): move plugin to own file * feat(api-history): remove `removed` property * feat(api-history): fetch version using pr * feat(api-history): types for data fetch code * refactor(api-history): more readable row sorting * feat(api-history): changes markdown support * feat(api-history): strip comment tags in pre-build instead of plugin * feat(api-history): `pr-release-versions-plugin` * feat(api-history): use react component instead of handmade AST * fix(api-history): revert accidental dependency * refactor(api-history): get pr releases in transformer, remove plugin * docs(api-history): todo in transformer * docs(api-history): add temp example api history and schema for pr review * fix(api-history): update `yarn.lock` for now * feat(api-history): use example pr versions by default for now #594 (comment) * refactor(api-history): move `ApiHistoryTable` styles to module #594 (comment) * style(api-history): better var name, fix style lint #594 (comment) * feat(api-history): map pre-releases to released stable versions * feat(api-history): better styles, remove pr number * feat(api-history): link table change to breaking-changes * fix(api-history): provide key for table elements * feat(api-history): table semver ranges Co-authored-by: Samuel Attard <sam@electronjs.org> * feat(api-history): better error handling #594 (comment) * feat(api-history): type predicates in transformer #594 (comment) * feat(api-history): update to accepted schema electron/rfcs#6 * docs(api-history): remove old comments * feat(api-history): only pre-process `/docs/api/*.md` containing `<!--` * Update scripts/tasks/preprocess-api-history.ts Co-authored-by: Kevin Cui <158blackhole@gmail.com> * fix(api-history): match api history block consistently * feat(api-history): pre-process more error checking * Update docs/latest/api-history.schema.json Co-authored-by: Erick Zhao <erick@hotmail.ca> * fix(api-history): duplicate dependencies * docs(api-history): remove unnecessary comment * refactor(api-history): move pre-process deps to dev deps * feat(api-history): `isHtml(node)` type guard #594 (comment) * fix(api-history): missing `toLowerCase()` * Update scripts/tasks/preprocess-api-history.ts Co-authored-by: Kevin Cui <158blackhole@gmail.com> * Update scripts/tasks/preprocess-api-history.ts Co-authored-by: Kevin Cui <158blackhole@gmail.com> * Update src/components/ApiHistoryTable.tsx Co-authored-by: Kevin Cui <158blackhole@gmail.com> * revert(api-history): `isHtml(node)` type guard This reverts commit 9481b1c. * feat(api-history): tell user to run `lint-roller` * fix(api-history): stricter change type param * Apply suggestions from code review Co-authored-by: David Sanders <dsanders11@ucsbalum.com> * style(api-history): fix lint * fix(api-history): remove unnecessary null check * style(api-history): fix lint * docs(api-history): stricter schema Reference: electron/electron@c9de2c5 * docs(api-history): `ipc-renderer` Reference: electron/electron#42982 (comment) * docs(api-history): `browser-view` * ci: use GH token with correct permissions * fix(api-history): change semver sign if backport is `x.0.0` Reported-by: David Sanders <dsanders11@ucsbalum.com> * fix(api-history): preprocess warn on missing schema * Update src/components/ApiHistoryTable.tsx Co-authored-by: David Sanders <dsanders11@ucsbalum.com> * refactor(api-history): better semver logic Co-authored-by: David Sanders <dsanders11@ucsbalum.com> Based-on-patch-by: David Sanders <dsanders11@ucsbalum.com> Reference: #594 (comment) * refactor(api-history): remove test `docs/` `git diff feat/api-history origin/main -- docs/latest/api/ | git apply` * refactor(api-history): remove test PR data --------- Co-authored-by: Samuel Attard <sam@electronjs.org> Co-authored-by: Kevin Cui <158blackhole@gmail.com> Co-authored-by: Erick Zhao <erick@hotmail.ca> Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
This RFC is part of the 2024 Electron GSoC [Project] [Proposal].
This RFC aims to introduce a JSON Schema for (YAML) API history blocks in
electron/electrondocumentation. It will be used to enforce and validate the structure and content of these blocks, which will include historical information about changes to the various APIs in Electron.Preview: https://github.com/piotrpdev/rfcs/blob/feat/api-history/text/0004-api-history-schema.md
Related: electron/electron#39877
Implementation: electron/lint-roller@d88115a
@dsanders11 @erickzhao