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

Add tag name in the about dialog for tagged builds #5697

Merged

Conversation

dyfer
Copy link
Member

@dyfer dyfer commented Jan 13, 2022

Purpose and Motivation

Before this PR, the "About" dialog in the IDE of the release (tagged) builds would report Built from branch 'HEAD' [<SHA>]. After this PR, the dialog reads Built from tag '<tag-name>' [<SHA>]. The non-tagged builds display the branch name as they have previously.

Here are the dialogs from builds from this branch and from a temporary tag:
Screen Shot 2022-01-13 at 11 23 25
Screen Shot 2022-01-13 at 11 26 37

For a tagged commit, the beginning of cmake config now looks like this:

$ cmake ..
-- SuperCollider Version: 3.13.0-dev
-- Building from tag Version-3.13.0-testTagName, commit hash is 354b10d266
-- Please specify the build configuration in the next step

API change...?

There is a very slight change to the response in the server API, if we even consider this a change. Previously, for the release builds the response to the /version message would include HEAD as the branch name, while currently it returns the tag name. These fields are marked in the help as informational only, so I don't believe it's an actual issue, but I wanted to point it out for the completeness sake

s.boot;
OSCFunc.trace(true, true);
s.sendMsg(\version);

Response:

OSC Message Received:
	time: 46.35657025
	address: a NetAddr(127.0.0.1, 57110)
	recvPort: 57120
	msg: [ /version.reply, scsynth, 3, 13, .0-dev, Version-3.13.0-testTagName, 354b10d266 ]

Types of changes

  • New feature
  • Breaking change (not really, but...)

To-do list

  • Code is tested
  • All tests are passing
  • Updated documentation
  • This PR is ready for review

@dyfer dyfer force-pushed the topic/add-tag-name-in-about-dialog branch from 354b10d to 84e4279 Compare January 20, 2022 19:07
@dyfer dyfer merged commit f9c1cdb into supercollider:develop Jan 30, 2022
@dyfer dyfer deleted the topic/add-tag-name-in-about-dialog branch January 31, 2022 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants