Skip to content

chore: prevent api-extractor from publishing tagsForStack #581

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

Merged
merged 2 commits into from
Jun 6, 2025

Conversation

iankhou
Copy link
Contributor

@iankhou iankhou commented Jun 6, 2025

Fixes internal issue that caused a function tagsForStack1 to be published in the AWS CDK Toolkit Library API Reference.

Removes the following entry:
Screenshot 2025-06-06 at 12 13 11


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@iankhou iankhou self-assigned this Jun 6, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team June 6, 2025 16:11
@github-actions github-actions bot added the p2 label Jun 6, 2025
@mrgrain mrgrain changed the title fix: add @internal tag to tagsForStack to prevent api-extractor from publishing it chore: add @internal tag to tagsForStack to prevent api-extractor from publishing it Jun 6, 2025
@iankhou
Copy link
Contributor Author

iankhou commented Jun 6, 2025

Might need a different approach for this.

Getting the following error in the build for aws-cdk (not @aws-cdk, where this change is being made), due to its import of tagsForStack.

👾 build » compile | tsc --build
lib/cli/cdk-toolkit.ts:23:20 - error TS2305: Module '"../api/tags"' has no exported member 'tagsForStack'.

23 import { type Tag, tagsForStack } from '../api/tags';

@mrgrain
Copy link
Contributor

mrgrain commented Jun 6, 2025

Might need a different approach for this.

Getting the following error in the build for aws-cdk (not @aws-cdk, where this change is being made), due to its import of tagsForStack.

👾 build » compile | tsc --build
lib/cli/cdk-toolkit.ts:23:20 - error TS2305: Module '"../api/tags"' has no exported member 'tagsForStack'.

23 import { type Tag, tagsForStack } from '../api/tags';

Let's just move it into a non public file. It's low value. You can also make a hard-copy for the CLI. Again, trivial code.

@iankhou iankhou temporarily deployed to integ-approval June 6, 2025 19:22 — with GitHub Actions Inactive
@iankhou iankhou changed the title chore: add @internal tag to tagsForStack to prevent api-extractor from publishing it chore: prevent api-extractor from publishing tagsForStack Jun 6, 2025
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.01%. Comparing base (e629e30) to head (bd5285c).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #581      +/-   ##
==========================================
- Coverage   79.59%   79.01%   -0.59%     
==========================================
  Files          47       46       -1     
  Lines        7086     7085       -1     
  Branches      793      790       -3     
==========================================
- Hits         5640     5598      -42     
- Misses       1427     1468      +41     
  Partials       19       19              
Flag Coverage Δ
suite.unit 79.01% <100.00%> (-0.59%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@iankhou iankhou added the pr/exempt-integ-test Skips the integ test steps if set. label Jun 6, 2025
@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Jun 6, 2025
Merged via the queue into main with commit 764a12c Jun 6, 2025
30 checks passed
@aws-cdk-automation aws-cdk-automation deleted the iankhou-tagsForStack1-internal branch June 6, 2025 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2 pr/exempt-integ-test Skips the integ test steps if set.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants