Skip to content

DOC, MAINT: tools script for author list#18

Merged
nray merged 4 commits intomainfrom
treddy_release_author_list
Feb 3, 2026
Merged

DOC, MAINT: tools script for author list#18
nray merged 4 commits intomainfrom
treddy_release_author_list

Conversation

@tylerjereddy
Copy link
Collaborator

Here's a sample of what running the authors script at the moment produces:

python tools/authors.py cd5f6b0732f59..0cfcf3ef443ac

which shows the authors and their commit counts:

Authors
=======

* Navamita Ray (40)
* Tyler Reddy (66) +
* Emma Viani (64) +

    A total of 3 people contributed to this release.
    People with a "+" by their names contributed a patch for the first time.
    This list of names is automatically generated, and may not be fully complete.
    
NOTE: Check this list manually! It is automatically generated and some names
      may be missing.

* Related to release management described in gh-1.

* This patch adds a small script to automatically generate
the list of authors that contributed to a given release
of our project (I've shamelessly borrowed the script from
license-compatible SciPy, where I also do releases...).

* We may expect the CI to fail here temporarily for the
same reason noted at:
#17 (comment)
@tylerjereddy tylerjereddy added this to the 0.1.0 milestone Jan 31, 2026
@tylerjereddy tylerjereddy added documentation Improvements or additions to documentation maintenance labels Jan 31, 2026
# This file is up-to-date if the command git log --format="%aN <%aE>" | sort -u
# does not list the same person multiple times.
#
Emma Viani <eiviani@lanl.gov> eiviani-lanl <eiviani@lanl.gov>
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If we don't add this then the author list will list Emma twice as shown below. That's the point of the .mailmap, to simplify the scenarios where folks contribute from multiple machines or have different aliases, etc.

Authors
=======

* eiviani-lanl (8) +
* Navamita Ray (40)
* Tyler Reddy (66) +
* Emma Viani (56) +

    A total of 4 people contributed to this release.
    People with a "+" by their names contributed a patch for the first time.
    This list of names is automatically generated, and may not be fully complete.
    
NOTE: Check this list manually! It is automatically generated and some names
      may be missing.

* Ignore the `tools/authors.py` script in the `ruff`
configuration because this module is vendored from SciPy.
@tylerjereddy tylerjereddy force-pushed the treddy_release_author_list branch from d8ac3b2 to 0be76cb Compare January 31, 2026 17:17
@tylerjereddy tylerjereddy changed the title WIP, DOC, MAINT: tools script for author list DOC, MAINT: tools script for author list Jan 31, 2026
line-length = 88
extend-exclude = [
"tools/authors.py", # vendored from SciPy
]
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've excluded this module from the linting because it is vendored from another project, which allows the CI to pass here.

If reviewers prefer it linted I can do that too, it may just make re-vendoring more annoying in the future if there are upstream changes.

@tylerjereddy
Copy link
Collaborator Author

I'll probably expect folks to start helping me with simple merge conflicts as well, because there are going to be a lot in the leadup to the release.

@nray nray merged commit 18547a9 into main Feb 3, 2026
18 checks passed
@nray nray deleted the treddy_release_author_list branch February 3, 2026 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants