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

gen-manpages.sh should fail if any binary reports git -dirty #20412

Closed
laanwj opened this issue Nov 18, 2020 · 3 comments
Closed

gen-manpages.sh should fail if any binary reports git -dirty #20412

laanwj opened this issue Nov 18, 2020 · 3 comments
Labels
Build system

Comments

@laanwj
Copy link
Member

laanwj commented Nov 18, 2020 •
edited

Right now it's easy to accidentally check in manpages which contain version specifiers like

Bitcoin Core RPC client version v0.21.0.0-dirty

(for example: run the process two times in a row without committing)

Ideally the script would protect against this. If either the current git tree is dirty, or the binaries report being built from a dirty tree, fail. Maybe only the latter one is relevant, dunno.
@decryp2kanon
Copy link
Contributor

good idea!

@tylerchambers
Copy link
Contributor

working on this, should just be able to get the version output from each of the binaries then bail out if it contains 'dirty'.

@tylerchambers tylerchambers mentioned this issue Nov 23, 2020
Merged
laanwj added a commit that referenced this issue Dec 7, 2020
@laanwj
Merge #20468: build: warn when generating man pages for binaries buil…
f3e1768 
…t from a dirty branch

6690adb Warn when binaries are built from a dirty branch. (Tyler Chambers)

Pull request description:

  - Adjusted `--version` flag behavior in bitcoind and bitcoin-wallet to have the same behavior.
  - Added `--version` flag to bitcoin-tx to match.
  - Added functionality in gen-manpages.sh to error when attempting to generate man pages for binaries built from a dirty branch.

  mitigates problem with  issue #20412

ACKs for top commit:
  laanwj:
    Tested ACK 6690adb

Tree-SHA512: b5ca509f1a57f66808c2bebc4b710ca00c6fec7b5ebd7eef58018e28e716f5f2358e36551b8a4df571bf3204baed565a297aeefb93990e7a99add502b97ee1b8
@laanwj
Copy link
Member Author

laanwj commented Dec 7, 2020

fixed by #20468

@laanwj laanwj closed this as completed Dec 7, 2020
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Build system
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@laanwj @tylerchambers @decryp2kanon