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

Create directory for local only notebooks #3230

Merged
merged 3 commits into from
Jan 12, 2024
Merged

Conversation

bendnorman
Copy link
Member

@bendnorman bendnorman commented Jan 10, 2024

Overview

I have some untracked local notebooks that probably don't belong in git but are still things I'd like to save. This PR creates a new directory called notebooks/local/ that only contains a .gitignore file so folks can stash old notebooks in their pudl directory but not have them tracked in git.

Testing

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

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. Make sure full ETL runs & make pytest-integration-full passes locally
    Options
  2. For major data coverage & analysis changes, run data validation tests
    Options
  3. If updating analyses or data processing functions: make sure to update or write data validation tests
    Options
  4. Update the release notes: reference the PR and related issues.
    Options
  5. Review the PR yourself and call out any questions or issues you have
    Options

Copy link
Member

@zaneselvans zaneselvans left a comment

Choose a reason for hiding this comment

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

This creates the folder, but I don't think it'll do any ignoring. If someone puts their local notebooks or anything else in here they'll still show up as new / changed files in git and will be liable to get committed. Should there be a new local/** entry added to the notebooks/.gitignore? Or maybe a *.ipynb added here?

@bendnorman
Copy link
Member Author

bendnorman commented Jan 11, 2024

Ah yes I screwed that up. I added a README to notebooks/local and added a new local/** entry to the notebooks/.gitignore.

@bendnorman bendnorman marked this pull request as ready for review January 11, 2024 23:17
Copy link

codecov bot commented Jan 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6f15582) 92.6% compared to head (8a2c131) 92.7%.
Report is 12 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##            main   #3230     +/-   ##
=======================================
+ Coverage   92.6%   92.7%   +0.1%     
=======================================
  Files        140     143      +3     
  Lines      12843   12972    +129     
=======================================
+ Hits       11894   12022    +128     
- Misses       949     950      +1     

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

@zaneselvans zaneselvans merged commit 579d0a5 into main Jan 12, 2024
8 of 13 checks passed
@zaneselvans zaneselvans deleted the gitignore-local-notebooks branch January 12, 2024 02:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants