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

Improve the osv.dev repo's folder structure #1714

Open
michaelkedar opened this issue Oct 10, 2023 · 2 comments
Open

Improve the osv.dev repo's folder structure #1714

michaelkedar opened this issue Oct 10, 2023 · 2 comments
Labels
backlog Important but currently unprioritized cleanup Code hygiene and cleanup techdebt Technical debt to be paid down

Comments

@michaelkedar
Copy link
Member

The repo is quite messy and it's hard to know where things are.
The current state of things (from my understanding):

folder what
deployment/ Terraform, Cloud Deploy & App Engine config files, a few Cloud Build yamls, old (no longer used?) api-staging and api-test Cloud Run configs
docker/ CI docker files (ci, deployment, terraform), indexer, and worker/importer/exporter code & docker files, worker-base docker files
docs/ Jekyll files, build_swagger.py, tools.go
gcp/api OSV API server files (including files for the local ESP), protobuf files in /v1
gcp/appengine Mostly the backend of the osv.dev website, with the frontend in frontend3. Blog entires. App Engine Cron Handlers (to be removed). Also has the datastore index.yaml
gcp/functions The Cloud Function for publishing PyPI vulnerabilities, unmaintained
osv/ Main Python library, used in basically all Python services. Include ecosystem helpers and Datastore model definitions
tools/ Misc scripts/tools, mostly intended for development (datastore stuff, linting), but also the indexer-api-caller for indexer calling
vulnfeeds/ Go module for (mostly) the NVD CVE conversion, also the Alpine feed converter, and the Debian feed converter in tools/debian (which is written in Python)

It'd be nice to untangle this to have a clearer structure for each component of OSV (especially the docker/ stuff).

@michaelkedar michaelkedar added the cleanup Code hygiene and cleanup label Oct 10, 2023
michaelkedar added a commit that referenced this issue Nov 28, 2023
We still want to clean up the repo per #1714, but document the current
information to help contributors in the meantime.
Copy link

This issue has not had any activity for 60 days and will be automatically closed in two weeks

@github-actions github-actions bot added the stale The issue or PR is stale and pending automated closure label Jul 21, 2024
@andrewpollock andrewpollock added backlog Important but currently unprioritized techdebt Technical debt to be paid down labels Jul 23, 2024
@oliverchang oliverchang removed the backlog Important but currently unprioritized label Jul 29, 2024
@github-actions github-actions bot removed the stale The issue or PR is stale and pending automated closure label Jul 30, 2024
Copy link

This issue has not had any activity for 60 days and will be automatically closed in two weeks

See https://github.com/google/osv.dev/blob/master/CONTRIBUTING.md for how to contribute a PR if you're interested in helping out.

@github-actions github-actions bot added the stale The issue or PR is stale and pending automated closure label Sep 28, 2024
@oliverchang oliverchang added backlog Important but currently unprioritized and removed stale The issue or PR is stale and pending automated closure labels Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Important but currently unprioritized cleanup Code hygiene and cleanup techdebt Technical debt to be paid down
Projects
None yet
Development

No branches or pull requests

3 participants