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

build(components.d.ts): update types for release #9008

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Conversation

benelan
Copy link
Member

@benelan benelan commented Mar 27, 2024

Summary

The release failed due to the components.d.ts file being outdated, with the following error:

lerna notice cli v7.4.2
lerna info versioning independent
lerna info ci enabled
lerna ERR! EUNCOMMIT Working tree has uncommitted changes, please commit or remove the following changes before continuing:
lerna ERR! EUNCOMMIT  M packages/calcite-components/src/components.d.ts
Error: Process completed with exit code 1.

I will add an actual fix to the CI in a subsequent PR.

@benelan benelan requested a review from a team as a code owner March 27, 2024 01:49
@benelan benelan added skip visual snapshots Pull requests that do not need visual regression testing. low risk Issues with low risk for consideration in low risk milestones labels Mar 27, 2024
@benelan benelan merged commit 2bb1ee2 into main Mar 27, 2024
14 checks passed
@benelan benelan deleted the benelan/update-types branch March 27, 2024 01:50
@github-actions github-actions bot added this to the 2024-04-30 - Apr Release milestone Mar 27, 2024
benelan added a commit that referenced this pull request Mar 30, 2024
**Related Issue:** #9008

## Summary

Commit changes to `components.d.ts` after building for release to
prevent lerna/npm publishing errors due to an unclean working tree. The
commit will be discarded once the workflow run's container is destroyed.

### Background

The `components.d.ts` file is tracked as a temporary workaround for
ionic-team/stencil#3239

To keep the types updated, `components.d.ts` is added to the index in a
pre-commit hook.


https://github.com/Esri/calcite-design-system/blob/2bb1ee24bb317c95e2bef8165c75583fe98ad714/.husky/pre-commit#L7-L13

However, the file can still be outdated if people make changes and don't
rebuild before creating another commit. This is mostly an issue with
small doc updates, like the PR linked above. If that happens, the
release will fail due to an unclean working tree.
benelan added a commit that referenced this pull request Mar 30, 2024
**Related Issue:** #9008

## Summary

Add troubleshooting steps to the release documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
low risk Issues with low risk for consideration in low risk milestones skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants