Skip to content

Commit

Permalink
README: Add vendoring section
Browse files Browse the repository at this point in the history
  • Loading branch information
joverlee521 committed Jul 28, 2023
1 parent 9082700 commit 87ca1ed
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,28 @@

Shared internal tooling for pathogen data ingest. Used by our individual
pathogen repos which produce Nextstrain builds. Expected to be vendored by
each pathogen repo using `git subtree` (or `git subrepo`).
each pathogen repo using `git subtree`.

Some tools may only live here temporarily before finding a permanent home in
`augur curate` or Nextstrain CLI. Others may happily live out their days here.

## Vendoring

Nextstrain maintained pathogen repos will use `git subtree` to vendor ingest scripts.
(See discussion on this decision in https://github.com/nextstrain/ingest/issues/3)

First add the latest ingest scripts to the pathogen repo by running:

```
git subtree add --prefix ingest/vendored https://github.com/nextstrain/ingest HEAD --squash
```

Any future updates of ingest scripts can be pulled in with:

```
git subtree pull --prefix ingest/vendored https://github.com/nextstrain/ingest HEAD --squash
```

## History

Much of this tooling originated in
Expand Down

0 comments on commit 87ca1ed

Please sign in to comment.