Crate search_issue_refs

Source
Expand description

Recursively searches local directory for references to issues that are closed.

Requires a Github access token as this program will make queries to the GitHub API where authentication is needed.

See https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

Example usage:

(from the root directory of the Zebra repo)

GITHUB_TOKEN={valid_github_access_token} search-issue-refs

Example output:

Found 3 possible issue refs, checking Github issue statuses..

Found reference to closed issue #4794: ./zebra-rpc/src/methods/get_block_template_rpcs.rs:114:19 https://github.com/ZcashFoundation/zebra/blob/main/zebra-rpc/src/methods/get_block_template_rpcs.rs#L114 https://github.com/ZcashFoundation/zebra/issues/4794

Found reference to closed issue #2379: ./zebra-consensus/src/transaction.rs:717:49 https://github.com/ZcashFoundation/zebra/blob/main/zebra-consensus/src/transaction.rs#L717 https://github.com/ZcashFoundation/zebra/issues/2379

Found reference to closed issue #3027: ./zebra-consensus/src/transaction/check.rs:319:6 https://github.com/ZcashFoundation/zebra/blob/main/zebra-consensus/src/transaction/check.rs#L319 https://github.com/ZcashFoundation/zebra/issues/3027

Found 3 references to closed issues.

Structs§

PossibleIssueRef 🔒

Constants§

GITHUB_TOKEN_ENV_KEY 🔒
VALID_EXTENSIONS 🔒

Functions§

check_file_ext 🔒
crate_mod_path 🔒
github_issue_api_url 🔒
github_issue_url 🔒
github_permalink 🔒
github_ref_api_url 🔒
github_remote_file_ref 🔒
main 🔒
Process entry point for search-issue-refs
search_directory 🔒

Type Aliases§

IssueId 🔒