Skip to content

Update README.md #2141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 6, 2025
Merged

Update README.md #2141

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb95221
Update README.md
Bashamega Sep 6, 2025
89ec060
Update README.md
Bashamega Sep 6, 2025
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
8 changes: 1 addition & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,6 @@ If you are familiar with Web IDL, you may also want to check whether the upstrea
- `addedTypes.jsonc`: types that should exist but are missing from the spec data.
- `overridingTypes.jsonc`: types that are defined in the spec but have TypeScript-friendly modifications in the json files.
- `removedTypes.jsonc`: types that are defined in the spec but should be removed.
- `patches/*.kdl`: KDL types
- `comments.json`: comment strings to be embedded in the generated .d.ts files.
- `deprecatedMessage.json`: the reason why one type is deprecated.

npm run ts-changelog -- @types/web 0.0.2 0.0.23
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still exists and probably part of the manual job? IDK what people actually do, though.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And should we document how the manual job goes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think no one uses it ... I never used it
Maybe it is only for maintainers, Idk even what it does, I never had to generate a change log.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm honestly not sure it matters

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I looked and I don't think we have used this in recent memory

```

You might need to run `git pull origin main --tags` to run this ^

1. Add the CHANGELOG to the release issue