PUDL Release v2024.10.0

[zaneselvans]

Additional release process documentation.

Release Checklist

Beta Give feedback

1. Set a release date & notify team
2. Update our CITATION.cff file with the new release date and current Catalyst membership.
3. Update our .zenodo.json file with current Catalyst membership.
4. Close out release notes and repo metadata for v2024.10.0 #3916
   docs metadata release +3
   
5. Push v2024.10.0 tag (4-digit year, month with no leading zero, and patch version)
6. Verify that the new GitHub (software) release has been published
7. Verify catalystcoop.pudl PyPI (software) release
8. Verify that PUDL repo archive on Zenodo has been updated w/ new version
9. Wait 6-10 hours for a successful build to complete
10. Activate new version on the RTD admin panel and verify that it builds successfully.
11. Verify that stable and the version tag point at same git ref
12. Verify that stable docs on RTD have been updated
13. Verify gs://pudl.catalyst.coop/v2024.10.0 has the new expected data.
14. Verify gs://pudl.catalyst.coop/stable has the new expected data.
15. Verify gs://parquet.catalyst.coop/v2024.10.0 has the new expected data.
16. Verify gs://parquet.catalyst.coop/stable has the new expected data.
17. Verify s3://pudl.catalyst.coop/v2024.10.0 has the new expected data.
18. Verify s3://pudl.catalyst.coop/stable has the new expected data.
19. Verify that draft deposition for this Zenodo archive has the new expected data
20. Update Zenodo description and other metadata based on release notes (see task list below)
21. Manually publish the new Zenodo deposition with the updated metadata
22. Wait 2-12 hours for a bot to create a PR in the PUDL conda-forge feedstock
23. Review the conda-forge PR, updating dependencies and CLI entrypoints if necessary. Our direct dependencies (from pyproject.toml) should be pinned to the actual version appearing in environments/conda-linux-64.lock.yml
24. Update the release documentation to better reflect the actual process for next time
25. Create an Announcement for the release in our GitHub Discussions

Zenodo Metadata Tasks

Beta Give feedback

1. Make sure all Catalyst members are listed in creators (automate!)
2. Update Zenodo deposition description to reflect current release (automate!)
3. Set correct version for Zenodo data release archive (automate!)
4. Set keywords for Zenodo data release archive (automate!)
5. Set language of Zenodo data release archive (automate!)
6. Zenodo PUDL repo archive: update release notes (cut-and-paste from GitHub)

Issues that we ran into

Beta Give feedback

1. Incredibly, this all seems to have gone very smoothly.