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

Put conda-smithy version in first feedstock commit #388

Merged
merged 2 commits into from
Nov 22, 2016

Conversation

agoodm
Copy link
Member

@agoodm agoodm commented Nov 18, 2016

So I pointed out in #374 that while re-rendered feedstock commits show the version number, the initial commit does not, but we should to help maintainers more easily determine if their feedstock is out of date when no other re-renderings have been done yet.

@@ -110,7 +110,7 @@ def __call__(self, args):
meta = None

feedstock_directory = args.feedstock_directory.format(package=argparse.Namespace(name=meta.name()))
msg = 'Initial commit of the {} feedstock.'.format(meta.name())
msg = 'Initial commit of the {} feedstock rendered with conda-smithy {}'.format(meta.name(), __version__)
Copy link
Member

Choose a reason for hiding this comment

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

Given GitHub and sometimes other git-related tools like to enforce commit message lengths (GitHub IIRC wraps after 72 characters), it might be worthwhile to come up with a more terse commit message so the conda-smithy version stays easily visible.

msg = 'Initial {} feedstock commit with conda-smithy {}'.format(meta.name(), __version__)

While this works for some things like djangorestframework-gis (right at the limit), things like backports.shutil_get_terminal_size will definitely go over.

We might be able to do better still if we just drop the package name entirely as this is often redundant information.

msg = 'Initial feedstock commit with conda-smithy {}.'.format(__version__)

With the current version of conda-smithy, this is 49 characters putting it within some of the more extreme limitations of commit messages.

Copy link
Member

Choose a reason for hiding this comment

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

Any other thoughts on this @pelson ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yikes, nice catch. Will change in just a moment.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks. Normally nits like commit message length are uninteresting to me. However, as we are trying to make the re-rendering version trackable in repos' histories. It seems worth the extra effort to ensure it works well.

@jakirkham
Copy link
Member

Could you please take a look at this nice, simple change, @pelson ?

@pelson pelson merged commit 2b08c69 into conda-forge:master Nov 22, 2016
@pelson
Copy link
Member

pelson commented Nov 22, 2016

👍 thanks @agoodm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants