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

A script to generate a release announcement message. #19361

Merged
merged 2 commits into from
Jun 22, 2023
Merged

A script to generate a release announcement message. #19361

merged 2 commits into from
Jun 22, 2023

Conversation

benjyw
Copy link
Contributor

@benjyw benjyw commented Jun 22, 2023

A future PR will wire this up to email and Slack.

@benjyw benjyw added the category:internal CI, fixes for not-yet-released features, etc. label Jun 22, 2023
@benjyw
Copy link
Contributor Author

benjyw commented Jun 22, 2023

Currently renders as:

Pants 2.18.0.dev2 is now available!

To upgrade, set pants_version="2.18.0.dev2" in the [GLOBAL] section of your pants.toml.

Thanks to all the contributors to this release:

A. Alonso Dominguez
Benjy Weinberger
Blaž Šnuderl
Bryan Weber
Daniel Goldman
Eric Arellano
Huon Wilson
Jacob Floyd
Joshua Cannon
Lasse Alm
Mike Geeves
Stu Hood
Tobias Nilsson

And a special shoutout to these first-time contributors:

Blaž Šnuderl
Mike Geeves

Welcome to the Pants community! We appreciate your contributions, and look forward to more.

@benjyw
Copy link
Contributor Author

benjyw commented Jun 22, 2023

I took the liberty of changing the phrasing of our current announcement. For example, we currently link to PyPI from force of habit, but we actually don't want to draw attention to the fact that we happen to currently release that way. It might put people in mind of being able to pip-install Pants, which we definitely don't want them to do.

Plugin developers will have read enough to know that Pants is available on PyPI, but there is no need to draw attention to that for the general public.

@benjyw
A script to generate a release announcement message.
fd004cb 
A future PR will wire this up to email and Slack.
@benjyw benjyw force-pushed the benjyw_generate_release_announcement branch from 631e10c to fd004cb Compare June 22, 2023 03:32
benjyw
benjyw commented Jun 22, 2023
View reviewed changes
build-support/bin/contributors.py
else:
update_contributors_md()


def sorted_contributors(range: str) -> list[str]:
Copy link
Contributor Author

@benjyw benjyw Jun 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Moved into common.py

benjyw
benjyw commented Jun 22, 2023
View reviewed changes
src/python/pants_release/common.py
@@ -31,3 +32,17 @@ def elapsed_time() -> tuple[int, int]:
now = time.time()
elapsed_seconds = int(now - _SCRIPT_START_TIME)
return elapsed_seconds // 60, elapsed_seconds % 60


def sorted_contributors(git_range: str) -> list[str]:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved from contributors.py and arg renamed from range to git_range, since range is a Python builtin

huonw
huonw approved these changes Jun 22, 2023
View reviewed changes
src/python/pants_release/generate_release_announcement.py Show resolved Hide resolved
src/python/pants_release/generate_release_announcement.py Outdated Show resolved Hide resolved
src/python/pants_release/generate_release_announcement.py Outdated Show resolved Hide resolved
pants.toml
@@ -49,6 +49,7 @@ plugins = [
pantsd_invalidation_globs.add = [
"!*_test.py",
"!BUILD",
"!src/python/pants_release/**",
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, thanks, having to wait for pantsd to restart for any code change there has been frustrating. I didn't realise it was resolvable!

thejcannon
thejcannon reviewed Jun 22, 2023
View reviewed changes
src/python/pants_release/generate_release_announcement.py
]
)

announcement = softwrap(
Copy link
Member

Choose a reason for hiding this comment

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

Would it make sense to start using Jinja for string templates? I find string templates much more readable and easier to debug.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think so for this change. It's too trivial. And we're trying to reduce deps in the repo, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For a more substantial thing, possibly? But then we'd have to take steps to ensure it doesn't end up used in the pants binary itself? So not sure it's worth the complication.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We could do that with separate resolves I suppose! But anyway, for a followup at best. And I think I'd like to see a more acute need?

Copy link
Member

Choose a reason for hiding this comment

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

We can and should use 3rdparty for our helper scripts. Again, I love 3rdparty 😛 I just think build tools are themselves are special 😄

Copy link
Member

Choose a reason for hiding this comment

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

I also don't think this so so trivial it wouldn't need a template. all the strings and newlines and branching and loops makes my brain just turn off 😂

But that could just be me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can and should use 3rdparty for our helper scripts. Again, I love 3rdparty 😛 I just think build tools are themselves are special 😄

But then how do you prevent people from using it in Pants itself? Now we need more guardrails.

Copy link
Member

Choose a reason for hiding this comment

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

I like avoiding any 3rd party unless justified. Fwiw on guards, we could use the visibility rules introduced to ensure anything under SRC/pants only has access to a specific set of dependencies

Copy link
Member

Choose a reason for hiding this comment

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

Yeah we're currently using a sophisticated build tool with guardrails built in 😉

But also, we have "guardrails" today, they're just made of paper-mache

AlexTereshenkov
AlexTereshenkov approved these changes Jun 22, 2023
View reviewed changes
Copy link
Member

@AlexTereshenkov AlexTereshenkov left a comment

Choose a reason for hiding this comment

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

LGMT!

@benjyw benjyw merged commit b6ec890 into main Jun 22, 2023
@benjyw benjyw deleted the benjyw_generate_release_announcement branch June 22, 2023 15:27
@jsirois jsirois mentioned this pull request Jun 30, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexTereshenkov AlexTereshenkov AlexTereshenkov approved these changes

@thejcannon thejcannon thejcannon left review comments

@huonw huonw huonw approved these changes

@kaos kaos kaos approved these changes

Assignees
No one assigned
Labels
category:internal CI, fixes for not-yet-released features, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@benjyw @kaos @huonw @thejcannon @AlexTereshenkov