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

feat: Rewrite natspec checker in Go #12191

Merged
merged 5 commits into from
Sep 29, 2024
Merged

feat: Rewrite natspec checker in Go #12191

merged 5 commits into from
Sep 29, 2024

Conversation

mslipper
Copy link
Collaborator

Rewrites the semver-natspec-check-no-build Just command in Go to reduce runtime. This PR reduces runtime for this check from ~1m30s to about 3 seconds post-compilation.

@mslipper mslipper requested a review from a team as a code owner September 27, 2024 23:45
@mslipper mslipper requested a review from mbaxter September 27, 2024 23:45
@mslipper mslipper requested a review from mds1 September 27, 2024 23:47
@mslipper mslipper force-pushed the feat/go-natspec-check branch from 396c536 to 18255f4 Compare September 28, 2024 00:00
Rewrites the `semver-natspec-check-no-build` Just command in Go to reduce runtime. This PR reduces runtime for this check from ~1m30s to about 3 seconds post-compilation.
@mslipper mslipper force-pushed the feat/go-natspec-check branch from 18255f4 to 550eb12 Compare September 28, 2024 00:04
@mslipper mslipper requested a review from a team as a code owner September 28, 2024 05:39
Copy link
Member

@clabby clabby left a comment

Choose a reason for hiding this comment

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

LGTM - just 1 more potential issue. Validated locally by adding a fmt.Printf("Wrote out for: %s\n", strings.TrimSuffix(filepath.Base(path), ext)) in the branch on L196 to see duplicate writes to the out map.

@mslipper mslipper added this pull request to the merge queue Sep 29, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 29, 2024
@mslipper mslipper added this pull request to the merge queue Sep 29, 2024
Merged via the queue into develop with commit cd7e9d4 Sep 29, 2024
65 checks passed
@mslipper mslipper deleted the feat/go-natspec-check branch September 29, 2024 01:59
samlaf pushed a commit to samlaf/optimism that referenced this pull request Nov 10, 2024
* feat: Rewrite natspec checker in Go

Rewrites the `semver-natspec-check-no-build` Just command in Go to reduce runtime. This PR reduces runtime for this check from ~1m30s to about 3 seconds post-compilation.

* remove old script

* add unit tests

* rename test

* review updates
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.

2 participants