Skip to content

Commit

Permalink
task: 257 - add guidance regarding package updates (#260)
Browse files Browse the repository at this point in the history
  • Loading branch information
tim738745 authored Apr 2, 2024
1 parent 41c0eb5 commit 47c9259
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ The Clean Transportation Data Hub provides an evidence base for the Clean Transp
- To make your `RunPython` "script" cleaner, consider putting the actual queries themselves in separate sql files and reading from those in `RunPython`
- To uncouple metabase from django, simply remove metabase from `settings.INSTALLED_APPS`.

# Updating packages
- From time to time, we may become aware of package updates (mainly the packages in package.json (frontend) and requirements.py (backend)).
- Tools like Dependabot (https://github.com/dependabot) may raise PRs that update these packages.
- If the package that can be updated is a npm package and is a transitive dependency (a dependency of an immediate dependency), we can implement the update using `overrides` (https://docs.npmjs.com/cli/v10/configuring-npm/package-json#overrides).
- When packages get updated, we'll have to confirm that things are still working; ideally, we would have test suites with good coverage that we can run. Otherwise, or in addition to that, some user testing may be needed.
- When an entire image is scanned by some tool, there may be deeper, OS level dependencies that show as being critically out of date/vulnerable; in cases like this, if an updated image is not yet available, there are usually `alpine` versions of images that simply don't include many of these dependencies; whether they will work for our purposes is another question.

# License
The code is a fork from Richard's personal project. Please do not clone, copy or replicate this project unless you're authorized to do so.

Expand Down

0 comments on commit 47c9259

Please sign in to comment.