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

chore: Update docs for building Zebra #8315

Merged
merged 3 commits into from
Feb 23, 2024
Merged

chore: Update docs for building Zebra #8315

merged 3 commits into from
Feb 23, 2024

Conversation

upbqdn
Copy link
Member

@upbqdn upbqdn commented Feb 22, 2024 •
edited by arya2
Loading

Motivation

Address #7993 (comment) before #7993.

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
  • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?

Solution

  • Refer to the upcoming Zebra 1.6 instead of 1.5 for shielded scanning.
  • Mention that building Zebra now requires protoc no older than v3.12.

Reviewer Checklist

Check before approving the PR:

  • Does the PR scope match the ticket?
  • Are there enough tests to make sure it works? Do the tests cover the PR motivation?
  • Are all the PR blockers dealt with?
    PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

@upbqdn upbqdn added A-docs Area: Documentation A-blockchain-scanner Area: Blockchain scanner of shielded transactions P-Critical 🚑 labels Feb 22, 2024
@upbqdn upbqdn self-assigned this Feb 22, 2024
@upbqdn upbqdn requested a review from a team as a code owner February 22, 2024 12:58
@upbqdn upbqdn mentioned this pull request Feb 22, 2024
Closed
17 tasks
@upbqdn
Remove pkg-config from build deps in README
aaa0783 
I tried compiling Zebra with `--all-features` on a Linux machine without
`pkg-config` or `pkfgconf` (which is an alternative to `pkg-config`),
and it worked.
@upbqdn
Add protoc to build deps in README
7594ccf
@upbqdn upbqdn force-pushed the update-scan-build-instructions branch from 53bfec6 to 7594ccf Compare February 23, 2024 11:29
@upbqdn upbqdn requested a review from arya2 February 23, 2024 11:31
@upbqdn upbqdn changed the title change(scan): Update docs for building Zebra with the scanner enabled change(scan): Update docs for building Zebra Feb 23, 2024
@upbqdn upbqdn changed the title change(scan): Update docs for building Zebra chore: Update docs for building Zebra Feb 23, 2024
arya2
arya2 approved these changes Feb 23, 2024
View reviewed changes
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

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

Thank you!

mergify bot added a commit that referenced this pull request Feb 23, 2024
@mergify
Merge of #8315
f239665
@mergify mergify bot mentioned this pull request Feb 23, 2024
Closed
@mergify mergify bot merged commit c2cfde0 into main Feb 23, 2024
98 checks passed
@mergify mergify bot deleted the update-scan-build-instructions branch February 23, 2024 16:49
@mpguerra mpguerra linked an issue Feb 26, 2024 that may be closed by this pull request
Publish next Zebra release: 1.6.0 #7993
Closed
17 tasks
idky137 pushed a commit to idky137/zebra that referenced this pull request Feb 28, 2024
@upbqdn @idky137
chore: Update docs for building Zebra (ZcashFoundation#8315)
a72fbae 
* Update build instructions with scanning enabled

* Remove `pkg-config` from build deps in README

I tried compiling Zebra with `--all-features` on a Linux machine without
`pkg-config` or `pkfgconf` (which is an alternative to `pkg-config`),
and it worked.

* Add `protoc` to build deps in README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oxarbitrage oxarbitrage oxarbitrage left review comments

@arya2 arya2 arya2 approved these changes

Assignees

@upbqdn upbqdn

Labels
A-blockchain-scanner Area: Blockchain scanner of shielded transactions A-docs Area: Documentation P-Critical 🚑
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Publish next Zebra release: 1.6.0
3 participants
@upbqdn @arya2 @oxarbitrage