electronjs.org-new/scripts/tasks
Piotr Płaczek 457bd50df0
feat: API History (#594)
* 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

https://github.com/electron/website/pull/594#discussion_r1662921815

* refactor(api-history): move `ApiHistoryTable` styles to module

https://github.com/electron/website/pull/594#discussion_r1665401454

* style(api-history): better var name, fix style lint

https://github.com/electron/website/pull/594#discussion_r1665405557

* 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

https://github.com/electron/website/pull/594#discussion_r1671021901

* feat(api-history): type predicates in transformer

https://github.com/electron/website/pull/594#discussion_r1671021901

* feat(api-history): update to accepted schema

https://github.com/electron/rfcs/pull/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

https://github.com/electron/website/pull/594#discussion_r1678184944

* 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 9481b1caa5.

* 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: c9de2c5f63

* docs(api-history): `ipc-renderer`

Reference: https://github.com/electron/electron/pull/42982#discussion_r1692533981

* 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: https://github.com/electron/website/pull/594#discussion_r1712450684

* 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>
2024-08-12 11:01:41 -07:00
..
add-frontmatter.ts refactor: convert website to TypeScript (#330) 2023-01-16 11:21:30 -08:00
copy-new-content.ts refactor: convert website to TypeScript (#330) 2023-01-16 11:21:30 -08:00
create-sidebar.ts build: upgrade to TypeScript 5.3 (#560) 2024-05-07 12:21:40 -07:00
download-docs.ts chore: remove got dependency in favor of built-in fetch (#609) 2024-08-01 13:04:02 -07:00
how-to-examples.md chore: update discord link 2022-06-15 15:25:38 -04:00
md-fixers.ts build: upgrade to Docusaurus 3 (#563) 2024-05-31 15:10:27 -07:00
preprocess-api-history.ts feat: API History (#594) 2024-08-12 11:01:41 -07:00