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

chore(docs): moved docs/snippets checks to separate step #1274

Merged
merged 1 commit into from
Feb 7, 2023

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Feb 7, 2023

Description of your changes

As described in #1275, now that we have linting for the code examples for the documentation present in docs/snippets, we want to have a dedicated line in the PR checks so that it's easier to identify failures during a PR authoring/review.

This PR updates the workflow that runs linting & tests by adding a separate and dedicated step for the linting of docs/snippets.

How to verify this change

Screenshot 2023-02-07 at 19 31 11

Related issues, RFCs

Issue number: #1275

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Feb 7, 2023
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Feb 7, 2023
@dreamorosi dreamorosi self-assigned this Feb 7, 2023
@dreamorosi dreamorosi linked an issue Feb 7, 2023 that may be closed by this pull request
2 tasks
@dreamorosi dreamorosi added the automation This item relates to automation label Feb 7, 2023
@dreamorosi dreamorosi marked this pull request as ready for review February 7, 2023 18:34
@dreamorosi dreamorosi merged commit 61080da into main Feb 7, 2023
@dreamorosi dreamorosi deleted the chore/docs/snippets_checks branch February 7, 2023 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: extract docs/snippets linting in its own CI step
1 participant