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

Build: Debian/Ubuntu: Avoid incorrect -dirty version suffix #2802

Merged
merged 1 commit into from
Aug 25, 2022

Conversation

hoffie
Copy link
Member

@hoffie hoffie commented Aug 22, 2022

Short description of changes
The debian build scripts will update config.{guess,sub} and will therefore cause the Jamulus.pro dev version detection to mark the build as dirty. We circumvent that by overriding the responsible debian helper call.

CHANGELOG: Debian/Ubuntu: Fixed displayed version for non-release builds to remove incorrect -dirty suffixes.

Context: Fixes an issue?

Fixes: #2800

Does this change need documentation? What needs to be documented and how?
No.

Status of this Pull Request
Ready.

What is missing until this pull request can be merged?
Reviews.

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I tested my code and it does what I want
  • My code follows the style guide
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I've filled all the content above

@hoffie hoffie added this to the Release 3.9.1 milestone Aug 22, 2022
@hoffie hoffie added this to Triage in Tracking (old) via automation Aug 22, 2022
@ann0see
Copy link
Member

ann0see commented Aug 23, 2022

Did that happen starting from the introduction of the flag?

@hoffie
Copy link
Member Author

hoffie commented Aug 23, 2022

Did that happen starting from the introduction of the flag?

I'd guess so, but it's hard to tell without running new builds with the old code again. Not sure if it's worth it.
37f993a first introduced the -dirty logic via #475 and #883.

@hoffie
Copy link
Member Author

hoffie commented Aug 23, 2022

PR logs look fine: https://github.com/jamulussoftware/jamulus/runs/7982212320?check_suite_focus=true#step:11:80
Project MESSAGE: building version "3.9.0dev-47f507c" (intermediate in git repository)

# dh_update_autotools_config replaces libs/opus/config.{sub,guess}.
# This is unnecessary as we don't build opus via autotools at all
# (we use qmake). In addition, this causes our -dev version generation
# logic to mark Debian builds as -dirty by default.
Copy link
Member

Choose a reason for hiding this comment

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

I'd add a link to this PR here

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm, why do that here? We don't add Github Issue/PR links for other code parts either. If you think that something is missing in the comment, I'm happy to add it. If someone wants to track that back to Github, this should be possible using git blame and git log.

Copy link
Member

@ann0see ann0see Aug 25, 2022

Choose a reason for hiding this comment

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

You describe an issue which is fixed. "In addition ... by default." Therefore I thought it would make sense to link this PR for further information.

You could also change the grammar: ... this causes --> This would have caused...

Which would – at least for me – make the reference to this PR less "needed" in the code itself.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, I've added the would part in the hope that it makes it clearer. The point of the comment is to state that there are two reasons:

  • First, the config.guess replacement behavior is unnecessary, as the file is not used at all.
  • Second (therefore "in addition"), it causes the -dirty behavior.

The debian build scripts will update config.{guess,sub} and will therefore
cause the Jamulus.pro dev version detection to mark the build as dirty.
We circumvent that by overriding the responsible debian helper call.

Fixes: jamulussoftware#2800
@hoffie hoffie moved this from Triage to Waiting on Team in Tracking (old) Aug 25, 2022
Copy link
Member

@ann0see ann0see left a comment

Choose a reason for hiding this comment

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

Thanks, I'm happy now

Tracking (old) automation moved this from Waiting on Team to In Progress Aug 25, 2022
@hoffie hoffie merged commit cc15cad into jamulussoftware:master Aug 25, 2022
Tracking (old) automation moved this from In Progress to Done Aug 25, 2022
@hoffie hoffie deleted the autobuild-fix-debian-dirty branch August 25, 2022 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Build: Debian -dev builds (non-release) show version as -dirty
3 participants