Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Conversation

piotrpdev
Copy link
Contributor

@piotrpdev piotrpdev commented Jun 19, 2024

Note

This PR is part of the 2024 Electron GSoC [Project] [Proposal].

Linting script for the API History blocks in electron/docs/*.md.

@dsanders11 @erickzhao @VerteDinde

@piotrpdev piotrpdev requested a review from a team as a code owner June 19, 2024 01:36
@piotrpdev piotrpdev added the ✨ enhancement New feature or request label Jun 19, 2024
Copy link
Member

@dsanders11 dsanders11 left a comment

Choose a reason for hiding this comment

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

Did a first pass at review, leaving it for now to allow for discussion on the larger change being requested.

tests/lint-roller-markdown-api-history.spec.ts Outdated Show resolved Hide resolved
bin/lint-markdown-api-history.ts Outdated Show resolved Hide resolved
@piotrpdev piotrpdev requested a review from dsanders11 June 19, 2024 17:13
@piotrpdev piotrpdev mentioned this pull request Jul 9, 2024
2 tasks
Copy link
Member

@dsanders11 dsanders11 left a comment

Choose a reason for hiding this comment

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

Left a few comments but I think we're getting close!

bin/lint-markdown-api-history.ts Outdated Show resolved Hide resolved
bin/lint-markdown-api-history.ts Show resolved Hide resolved
bin/lint-markdown-api-history.ts Outdated Show resolved Hide resolved
bin/lint-markdown-api-history.ts Outdated Show resolved Hide resolved
bin/lint-markdown-api-history.ts Outdated Show resolved Hide resolved
bin/lint-markdown-api-history.ts Show resolved Hide resolved
tests/lint-roller-markdown-api-history.spec.ts Outdated Show resolved Hide resolved
tests/lint-roller-markdown-api-history.spec.ts Outdated Show resolved Hide resolved
@piotrpdev piotrpdev requested a review from dsanders11 July 17, 2024 01:59
Copy link
Member

@dsanders11 dsanders11 left a comment

Choose a reason for hiding this comment

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

Pushed two final commits and gonna merge:

  • Would prefer to retain the .md extension instead of .md.api-history
  • Restored yarn.lock and did yarn install myself to align with our policy on maintainers making lockfile changes. This ended up bumping some versions of things which seems fine.

@piotrpdev
Copy link
Contributor Author

Would prefer to retain the .md extension instead of .md.api-history

I renamed it because using .md breaks lint-roller-markdown-links.spec.ts.

Restored yarn.lock and did yarn install myself to align with our policy on maintainers making lockfile changes. This ended up bumping some versions of things which seems fine.

👍

@dsanders11
Copy link
Member

I renamed it because using .md breaks

I see that now. 😅 Pushed a commit to ignore it in those tests.

Signed-off-by: David Sanders <dsanders11@ucsbalum.com>
Signed-off-by: David Sanders <dsanders11@ucsbalum.com>
Signed-off-by: David Sanders <dsanders11@ucsbalum.com>
@dsanders11 dsanders11 merged commit 3030970 into main Jul 17, 2024
@dsanders11 dsanders11 deleted the feat/api-history branch July 17, 2024 03:51
Copy link

🎉 This PR is included in version 2.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released ✨ enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.