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

[Chores] Automated API doc generation and added packages/samples filter #1470

Merged
merged 24 commits into from
May 10, 2023

Conversation

illiakovalenko
Copy link
Contributor

@illiakovalenko illiakovalenko commented May 5, 2023

Description / Motivation

  • Added "generate API docs" pipeline step:
    • Generates API docs only for packages that were affected by the changes in PR
    • Commits and pushes them using '[skip ci]' identifier
    • Will be triggered ONLY for dev|release branches, since doc generation provides many changes by updating hash numbers for all of the files in a specific package, in this case, each PR will include many changed files that will complicate PR for review
  • Introduced lint-samples script that triggers lint step ONLY for the samples that were directly affected by the changes in PR
  • Added lerna --since flag for generate-docs and lint-packages to include ONLY packages that were directly affected by the changes in PR
  • Our internal release-prep script needs to be updated to replace "--since=origin/dev" by "--since=origin/release/x"

Testing Details

  • Unit Test Added
  • Manual Test/Other (Please elaborate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@illiakovalenko illiakovalenko changed the title Feature/503814 [Chores] Automated API doc generation and packages/samples filter for lint step May 5, 2023
@illiakovalenko illiakovalenko changed the title [Chores] Automated API doc generation and packages/samples filter for lint step [Chores] Automated API doc generation and packages/samples filter May 5, 2023
@illiakovalenko illiakovalenko requested a review from a team May 5, 2023 11:09
@illiakovalenko illiakovalenko changed the title [Chores] Automated API doc generation and packages/samples filter [Chores] Automated API doc generation and added packages/samples filter May 5, 2023
Copy link
Contributor

@ambrauer ambrauer left a comment

Choose a reason for hiding this comment

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

Looks great, love the optimization to samples linting. See some comments.

azure-pipelines.yml Show resolved Hide resolved
scripts/lint-samples.js Outdated Show resolved Hide resolved
scripts/lint-samples.js Show resolved Hide resolved
scripts/lint-samples.js Outdated Show resolved Hide resolved
@illiakovalenko illiakovalenko requested a review from ambrauer May 10, 2023 07:42
Copy link
Contributor

@ambrauer ambrauer left a comment

Choose a reason for hiding this comment

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

👍

@ambrauer ambrauer merged commit 0546fca into dev May 10, 2023
@ambrauer ambrauer deleted the feature/503814 branch May 10, 2023 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants