When nightly builds succeed, write any key release notes updates to a changelog #3744
Labels
docs
Documentation for users and contributors.
nightly-builds
Anything having to do with nightly builds or continuous deployment.
Is your feature request related to a problem? Please describe.
Right now, we only publish our release notes once a quarter. With the adoption of regular nightly build release deadlines, we ought to have a way to communicate the following to our users:
Note that much of this information is in our release notes, but they do not convey and sense of time in relationship to the nightly builds. This information cannot be conveyed through the closure of Github issues, as there is generally a lag of at least one day between PR merges and the data being actually available (see, e.g. #3677). So, ideally, we could communicate how changes in our release notes appear in the nightly builds.
Describe the solution you'd like
build-deploy-pudl.yml
or as a separate job, if the nightly build succeeds, and if the release notes have changed, we process a changelog of the release notes. Any newly added lines to the most recent section of the release notes should get added as bullet points to a centralizedrelease-log.txt
orrelease-log.rst
file, also stored in thebuilds-catalyst-coop
GCS bucket. We may have to remove some of the.rst
formatting as well if we don't use an.rst
fileChallenges
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
The text was updated successfully, but these errors were encountered: