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

ci: prevent outdated types from blocking release #9011

Merged
merged 2 commits into from
Mar 30, 2024

Conversation

benelan
Copy link
Member

@benelan benelan commented Mar 27, 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.

types_path="packages/calcite-components/src/components.d.ts"
# make sure the types are always up to date
if [ -n "$(git diff --name-only -- "$types_path")" ]; then
echo "Automatically staging changes to \"$types_path\""
git add "$types_path"
fi

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.

@github-actions github-actions bot added the chore Issues with changes that don't modify src or test files. label Mar 27, 2024
@benelan benelan added the skip visual snapshots Pull requests that do not need visual regression testing. label Mar 27, 2024
Copy link
Member

@driskull driskull left a comment

Choose a reason for hiding this comment

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

👍 Nice!

@benelan benelan merged commit d1c9d23 into main Mar 30, 2024
14 checks passed
@benelan benelan deleted the benelan/prevent-outdated-types-blocking-release branch March 30, 2024 06:07
@github-actions github-actions bot added this to the 2024-04-30 - Apr Release milestone Mar 30, 2024
benelan added a commit that referenced this pull request Mar 30, 2024
…ror-troubleshooting

* origin/main:
  ci: prevent outdated types from blocking release (#9011)
  chore: release main (#9023)
  chore: release next
  chore: updates translations. (#9019)
  fix(tab-nav): fix custom element creation error in `components` build output (#9021)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issues with changes that don't modify src or test files. 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