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(github): add check to validate exported types being correct #3561

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ruzell22
Copy link
Contributor

@ruzell22 ruzell22 commented Sep 30, 2024

Commit to be reviewed


ci(github): add check to validate exported types being correct

Primary Changes
---------------
1. Added get-all-tgz-path.ts to get all tgz files path
2. Added run-attw-on-tgz.ts to run attw on each tgz filepath
3. Added are-the-types-wrong as part of the custom-checks mechanism

Fixes: #3140

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Copy link
Contributor

@outSH outSH left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I've left few comments, plese re-request the review once they're resolved :)

.github/workflows/are-the-types-wrong.yaml Outdated Show resolved Hide resolved
.github/workflows/are-the-types-wrong.yaml Outdated Show resolved Hide resolved
tools/custom-checks/get-all-tgz-path.ts Show resolved Hide resolved
tools/custom-checks/get-all-tgz-path.ts Outdated Show resolved Hide resolved
tools/custom-checks/run-attw-on-tgz.ts Outdated Show resolved Hide resolved
tools/custom-checks/run-attw-on-tgz.ts Show resolved Hide resolved
@ruzell22 ruzell22 force-pushed the issue3140 branch 2 times, most recently from ee35c4b to 33cfe5f Compare October 2, 2024 01:51
@ruzell22 ruzell22 requested a review from outSH October 2, 2024 06:30
Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@ruzell22 Please add the check to b e a part of the custom-checks mechanism and then we can delete the standalone github action workflow (which saves on resources)

Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@ruzell22 This is looking closer now, but what I need is that if we run yarn custom-checks then the attw check is executed as part of it. Right now it's a standalone script only (it's good that it can be executed by itself as well but it also needs to be a part of the custom-checks so that in ci.yaml when the custom-checks are executed this also runs)

Copy link
Contributor

@outSH outSH left a comment

Choose a reason for hiding this comment

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

LGTM, thank you

Primary Changes
---------------
1. Added get-all-tgz-path.ts to get all tgz files path
2. Added run-attw-on-tgz.ts to run attw on each tgz filepath
3. Added are-the-types-wrong as part of the custom-checks mechanism

Fixes: hyperledger-cacti#3140

Signed-off-by: ruzell22 <[email protected]>
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.

ci(github): add check to validate exported types being correct
3 participants