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

fix: addresses broken links in preparation for ci link check #869

Merged
merged 6 commits into from
Jan 18, 2024

Conversation

dutterbutter
Copy link
Contributor

@dutterbutter dutterbutter commented Jan 13, 2024

Related PRs:

What ❔

  • Addresses broken links in the repo

Why ❔

  • Should not have dead links in the repo
  • Addressing issues with links prior to zk linkcheck usage in ci

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.

popzxc
popzxc previously approved these changes Jan 14, 2024
Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

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

🔥

github-merge-queue bot pushed a commit that referenced this pull request Jan 15, 2024
…heck` ci usage (#868)

Related PRs:
- #869
- #870

## What ❔
- Adds `zk linkcheck` to zk tool
- Adds required dependencies to make use of `zk linkcheck` in zk env
- Adds `zk linkcheck` docs 
- Updates `spellcheck` dir to be general `checks-config` dir to include
spellcheck and link configuration files
- Fixes issue with `zk spellcheck` exit code
<!-- What are the changes this PR brings about? -->
<!-- Example: This PR adds a PR template to the repo. -->
<!-- (For bigger PRs adding more context is appreciated) -->

## Why ❔
- `zk linkcheck` will ensure no dead links exist in repo and prevent
unnecessary PRs
- Required to install dependencies, similar to `zk spellcheck` 
- Relevant docs to outline `zk linkcheck` usage 

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
- [x] Code has been formatted via `zk fmt` and `zk lint`.
- [x] Spellcheck has been run via `zk spellcheck`.
@Deniallugo Deniallugo added this pull request to the merge queue Jan 18, 2024
Merged via the queue into main with commit a78d03c Jan 18, 2024
17 checks passed
@Deniallugo Deniallugo deleted the db/fix-broken-links branch January 18, 2024 14:30
github-merge-queue bot pushed a commit that referenced this pull request Jan 19, 2024
🤖 I have created a release *beep* *boop*
---


##
[20.0.0](core-v19.2.0...core-v20.0.0)
(2024-01-19)


### ⚠ BREAKING CHANGES

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

### Features

* **api:** Consider State keeper fee model input in the API
([#901](#901))
([3211687](3211687))
* **api:** Make Web3 API server work with pruned data
([#838](#838))
([0b7cd0b](0b7cd0b))
* **vm:** fee model updates + 1.4.1
([#791](#791))
([3564aff](3564aff))


### Bug Fixes

* addresses broken links in preparation for ci link check
([#869](#869))
([a78d03c](a78d03c))
* Incorrect exposing of log indexes
([#896](#896))
([12974fc](12974fc))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
This was referenced Jan 19, 2024
@dutterbutter dutterbutter mentioned this pull request Jan 19, 2024
5 tasks
github-merge-queue bot pushed a commit that referenced this pull request Jan 29, 2024
🤖 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants