Skip to content

Commit ee34eac

Browse files
author
JacksonMaxfield
committed
Add docs for backfilling session context hash
1 parent e0fddc8 commit ee34eac

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Running Extra Scripts
2+
3+
### Background
4+
5+
While we hope for it to be rare, when we ship changes to `cdp-backend` or `cdp-frontend`
6+
require changes to the data or file storage system that we cannot make during a normal
7+
pipeline run, or if you want to manage your data in some way, there is a GitHub Action
8+
that allows the passthrough of any command straight to the running GitHub Action
9+
worker.
10+
11+
## Backfilling Session Context Hash
12+
13+
In our [v3.0.4 release of `cdp-backend`](https://github.com/CouncilDataProject/cdp-backend/releases/tag/v3.0.4)
14+
we added a property to the `Session` collection that stores the `session_context_hash`.
15+
This value is incredibly useful for programmatic work but isn't _needed_ for the
16+
web application. As such, if you don't want to run this script, you don't need to,
17+
but it is easy enough to run.
18+
19+
Open up the [Run Command]({{ cookiecutter.hosting_github_url }}/actions/workflows/run-script.yml)
20+
GitHub Action and click the "Run workflow" button.
21+
22+
Paste in the following: `add_content_hash_to_sessions --google_credentials_file google-creds.json`
23+
24+
Click the "Run workflow" button and the backfill process should kick off.
25+
(If the run doesn't appear, try refreshing the page.)
26+
27+
If something goes wrong, please create a
28+
[GitHub Issue in `cdp-backend`](https://github.com/CouncilDataProject/cdp-backend/issues)

0 commit comments

Comments
 (0)