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.

Sign up for GitHub

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

Jump to bottom

fix: address issue with spellchecker not checking against prover workspace #855

Merged
merged 2 commits into from
Jan 10, 2024
Merged

fix: address issue with spellchecker not checking against prover workspace #855

merged 2 commits into from
Jan 10, 2024

Conversation

dutterbutter
Copy link
Contributor

What ❔

  • Updates zk spellcheck command to explicitly run cargo-spellcheck in prover/
  • Updates cspell glob pattern to cover all .md files to ensure READMEs are picked up
  • Updates cspell config to exclude node_modules, target and CHANGELOGs .md files

Why ❔

  • Given prover packages are not included in the root Cargo.toml, cargo-spellcheck was ignoring them. Running it explicitly during zk spellcheck ensures these files are also checked against
  • To ensure all READMEs are being checked against cspell changed glob pattern accordingly
  • Given changelogs are auto-generated checking for spelling issues here is not pragmatic

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.
  • Code has been formatted via zk fmt and zk lint.
  • Spellcheck has been run via zk spellcheck.

@montekki montekki added this pull request to the merge queue Jan 10, 2024
Merged via the queue into main with commit 4f55926 Jan 10, 2024
33 checks passed
@montekki montekki deleted the db/use-cspell-for-readmes branch January 10, 2024 22:08
@zksync-era-bot zksync-era-bot mentioned this pull request Jan 10, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Jan 29, 2024
@zksync-era-bot
chore(main): release prover 11.0.0 (#824)
8f55cae 
🤖 I have created a release *beep* *boop*
---


##
[11.0.0](prover-v10.1.0...prover-v11.0.0)
(2024-01-29)


### ⚠ BREAKING CHANGES

* **vm:** fee model updates + 1.4.1
([#791](#791))

### Features

* **api:** Make Web3 API server work with pruned data
([#838](#838))
([0b7cd0b](0b7cd0b))
* consensus component config for main node and external node
([#881](#881))
([1aed8de](1aed8de))
* **en:** Restore state keeper storage from snapshot
([#885](#885))
([a9553b5](a9553b5))
* fee model updates + 1.4.1 stage upgrade
([#897](#897))
([fa48c13](fa48c13))
* protobuf-generated json configs for the main node (BFT-371)
([#458](#458))
([f938314](f938314))
* Remove zkevm_test_harness public reexport from zksync_types
([#929](#929))
([dd1a35e](dd1a35e))
* **state-keeper:** circuits seal criterion
([#729](#729))
([c4a86bb](c4a86bb))
* **vm:** fee model updates + 1.4.1
([#791](#791))
([3564aff](3564aff))


### Bug Fixes

* address issue with spellchecker not checking against prover workspace
([#855](#855))
([4f55926](4f55926))
* addresses broken links in preparation for ci link check
([#869](#869))
([a78d03c](a78d03c))
* **prover:** Update shivini
([#915](#915))
([f141a00](f141a00))
* **witness-generator:** Update era-zkevm_test_harness
([#912](#912))
([c03c2e3](c03c2e3))
* **witness-generator:** Update zkevm_test_harness
([#930](#930))
([16fdcff](16fdcff))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Deniallugo Deniallugo Deniallugo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@dutterbutter @Deniallugo @montekki