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

docs: add a guide for linting and bundling as two separate but chained commands #1385

Merged
merged 5 commits into from
Jan 11, 2024

Conversation

lornajane
Copy link
Contributor

What/Why/How?

Linting, and then only bundling if the lint was successful, is a good practice pattern. This guide explains how it works, and shows how to combine the two commands.

Reference

Related to (but does not fix) #1250

Check yourself

  • Code is linted
  • Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@lornajane lornajane requested a review from a team as a code owner January 8, 2024 17:15
Copy link

changeset-bot bot commented Jan 8, 2024

⚠️ No Changeset found

Latest commit: 1411f20

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Jan 8, 2024

Command Mean [s] Min [s] Max [s] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 1.065 ± 0.030 1.014 1.129 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 1.065 ± 0.016 1.044 1.094 1.00 ± 0.03

Copy link
Contributor

github-actions bot commented Jan 8, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 76.31% 4100/5373
🟡 Branches 66.29% 2183/3293
🟡 Functions 68.42% 663/969
🟡 Lines 76.51% 3847/5028

Test suite run success

671 tests passing in 94 suites.

Report generated by 🧪jest coverage report action from 1411f20

@lornajane lornajane requested a review from a team January 8, 2024 17:17
docs/guides/index.md Outdated Show resolved Hide resolved
@lornajane lornajane force-pushed the docs-lint-and-bundle branch from 9d26d7e to 30ba209 Compare January 10, 2024 12:41
@lornajane lornajane requested a review from HCloward January 10, 2024 13:21
Copy link
Contributor

@HCloward HCloward left a comment

Choose a reason for hiding this comment

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

One minor suggestion, otherwise this looks great to me!

@lornajane lornajane force-pushed the docs-lint-and-bundle branch from 9e52ae5 to 1411f20 Compare January 11, 2024 08:34
@lornajane lornajane merged commit e8ea285 into main Jan 11, 2024
30 checks passed
@lornajane lornajane deleted the docs-lint-and-bundle branch January 11, 2024 08:46
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.

3 participants