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: restrict bundling with --output but without inline apis #1799

Merged
merged 4 commits into from
Nov 26, 2024

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Nov 12, 2024

What/Why/How?

Trying to clarify the multiple apis bundling behaviour.

Since #1708, we added the output option to the apis section of redocly.yaml.
Now when bundling, it doesn't make sense to store files specified in Redocly config under a file/folder specified as a CLI option. Essentially, this change will restrict using --output command option when there's no inline apis provided in the same command.

Reference

Related: #1776

Testing

Screenshots (optional)

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

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

@tatomyr tatomyr requested a review from a team as a code owner November 12, 2024 12:16
Copy link

changeset-bot bot commented Nov 12, 2024

🦋 Changeset detected

Latest commit: 164ed15

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@redocly/cli Patch
@redocly/openapi-core Patch

Not sure what this means? Click here to learn what changesets are.

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

@tatomyr tatomyr self-assigned this Nov 12, 2024
Copy link
Contributor

github-actions bot commented Nov 12, 2024

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 970.6 ± 11.2 956.3 981.9 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 995.7 ± 27.7 957.3 1041.6 1.03 ± 0.03

Copy link
Contributor

github-actions bot commented Nov 12, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 78.82% 5029/6380
🟡 Branches 67.19% 2050/3051
🟡 Functions 73.35% 831/1133
🟡 Lines 79.12% 4743/5995

Test suite run success

814 tests passing in 121 suites.

Report generated by 🧪jest coverage report action from 164ed15

docs/commands/bundle.md Outdated Show resolved Hide resolved
docs/commands/bundle.md Outdated Show resolved Hide resolved
docs/commands/bundle.md Outdated Show resolved Hide resolved
@tatomyr tatomyr requested a review from a team as a code owner November 12, 2024 15:42
@tatomyr tatomyr changed the title docs: update bundle description chore: restrict bundling with --output but without inline apis Nov 12, 2024
@tatomyr tatomyr force-pushed the docs/update-bundle-description branch from b4fcc07 to 03e6986 Compare November 25, 2024 13:26
@tatomyr tatomyr force-pushed the docs/update-bundle-description branch from 03e6986 to 164ed15 Compare November 26, 2024 10:32
@RomanHotsiy RomanHotsiy merged commit e4e6782 into main Nov 26, 2024
41 checks passed
@RomanHotsiy RomanHotsiy deleted the docs/update-bundle-description branch November 26, 2024 10:53
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