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

Nightly build quality of life improvements #3287

Merged
merged 3 commits into from
Jan 25, 2024
Merged

Nightly build quality of life improvements #3287

merged 3 commits into from
Jan 25, 2024

Conversation

jdangerx
Copy link
Member

@jdangerx jdangerx commented Jan 24, 2024

  • adding logs to each function to know that we executed them
  • add build-ref to uploaded file name so file downloads are disambiguated
  • send a 'skipped' message to Slack when build was skipped

Overview

Doesn't close any issues - but these are some tiny quality of life improvements that make debugging nightly builds easier:

  • pudl-etl.log now has a prefix to indicate date, hash, and short-ref! no more of this:
    $ ls ~/Downloads/pudl-etl*
    pudl-etl.log
    pudl-etl (1).log
    ...
    pudl-etl (1000).log
  • 'skipped' message in slack when we skip a build
  • slightly more logs

What did you change?

Testing

How did you make sure this worked? How can a reviewer verify this?

I added an early return 1 to all the time-consuming functions & also echo "some message" > $LOGFILE. Then I ran the build via workflow, saw the various messages in the logfile, and saw that the logfile was uploaded with a nice, unambiguous name.

I couldn't verify that the skip logic is working, I think we're good to wait on that until we see a skip occur in the wild.

To-do list

Edit tasklist title
Beta Give feedback Tasklist To-do list, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. Review the PR yourself and call out any questions or issues you have
    Options
  2. Short-circuit all functions, run a build process, and see that LOGFILE stuff works
    Options

- adding logs to each function to know that we executed them
- add build-ref to uploaded file name so file downloads are disambiguated
- send a 'skipped' message to Slack when build was skipped
@zaneselvans zaneselvans added the nightly-builds Anything having to do with nightly builds or continuous deployment. label Jan 25, 2024
@zaneselvans zaneselvans added this to the v2024.01 milestone Jan 25, 2024
@zaneselvans zaneselvans marked this pull request as ready for review January 25, 2024 06:23
Copy link

codecov bot commented Jan 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dc6e16c) 92.7% compared to head (5c6ea43) 92.7%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##            main   #3287     +/-   ##
=======================================
- Coverage   92.7%   92.7%   -0.0%     
=======================================
  Files        145     145             
  Lines      13100   13100             
=======================================
- Hits       12144   12142      -2     
- Misses       956     958      +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jdangerx jdangerx merged commit 079bfd4 into main Jan 25, 2024
19 of 20 checks passed
@jdangerx jdangerx deleted the nightly-build-qol branch January 25, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nightly-builds Anything having to do with nightly builds or continuous deployment.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants