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

Add ADR for storing repo data as JSON blob #21

Merged
merged 2 commits into from
Sep 11, 2024
Merged

Add ADR for storing repo data as JSON blob #21

merged 2 commits into from
Sep 11, 2024

Conversation

richpjames
Copy link
Contributor

No description provided.

Copy link
Contributor

@adamhughes86 adamhughes86 left a comment

Choose a reason for hiding this comment

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

These both are sensible suggestions

Copy link

@shuldt shuldt left a comment

Choose a reason for hiding this comment

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

Looks good, sensible decisions well expressed

- We don't have to add any dependencies.
- Initial deployments will be more simple
- We won't be able to query the data using SQL
- It may be harder to keep the data up to date
Copy link

Choose a reason for hiding this comment

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

Do we want to add a brief note as to why here

Copy link
Contributor

@danlivings-dxw danlivings-dxw left a comment

Choose a reason for hiding this comment

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

It might be worth mentioning that we'll need to configure a container volume to enable data persistence across deployments, but otherwise this makes sense to me.

@richpjames
Copy link
Contributor Author

@danlivings-dxw I was thinking initially we could keep the changes committed alongside the code in order for us to avoid containerisation

@danlivings-dxw
Copy link
Contributor

@richpjames I'm not sure we'd want to commit what is essentially a file-based database to this repository, as that would leak information about private repositories and would introduce a manual step to making sure that Towtruck is displaying up-to-date information.

I'd imagine an okay way to do this would be a folder named something like .towtruck that lives inside the application folder. That way we can add it to .gitignore so we don't accidentally commit its contents, and if we do define a Dockerfile at some point it will be close enough that it won't need a separate volume.

@richpjames richpjames mentioned this pull request Sep 11, 2024
@richpjames
Copy link
Contributor Author

@danlivings-dxw yeah that's a good point. I wasn't aware of the number of private repositories dxw has. In #27 I've added it as a seed step that can be run on demand.

@richpjames richpjames merged commit bed8e2e into main Sep 11, 2024
2 checks passed
@richpjames richpjames deleted the adr-0003 branch September 11, 2024 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants