Skip to content
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.

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

[core] Generate list of all exports #2801

Merged
merged 15 commits into from
Oct 28, 2021

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented Oct 7, 2021

Goals

  • Help building the "Breaking changes" section on refacto PRs when we are renaming / removing exports
  • Avoid forgetting to exports variable and types when building new features

Manually creating the list in #2227 (comment) was very time consuming but the result showed some problems like missing selector exports or unwanted exports.

My end goal would be to have a bot automatically displaying the list of the export added / removed on each PR.


Note that I only run the code on the data-grid package to avoid creating a new TypeDoc project for data-grid-pro since all the docs:api:build process is currently based on data-grid. I will benchmark the time it takes to run it on every package we publish.


Result example if we run it on #2793

image

Result example if we run it on #2782

image

image

image

@flaviendelangle flaviendelangle self-assigned this Oct 7, 2021
@flaviendelangle flaviendelangle added the core Infrastructure work going on behind the scenes label Oct 7, 2021
@flaviendelangle flaviendelangle changed the title [core] Generate list of all exports [core] Generate list of all exports - WIP Oct 7, 2021
@flaviendelangle flaviendelangle marked this pull request as ready for review October 21, 2021 08:36
@flaviendelangle flaviendelangle changed the title [core] Generate list of all exports - WIP [core] Generate list of all exports Oct 21, 2021
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 22, 2021
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 25, 2021
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 27, 2021
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant