Browse Source

Add git-lfs to be used (upcoming) snapshot images

See additions to dev-docs for rationale. Having this in master should allow us to rebase #1068 and therefore have git-lfs used from day zero.
master
james hadfield 2 years ago
parent
commit
7f9b4877b7
  1. 1
      .gitattributes
  2. 16
      DEV_DOCS.md

1
.gitattributes

@ -0,0 +1 @@
test/**/*.png filter=lfs diff=lfs merge=lfs -text

16
DEV_DOCS.md

@ -36,6 +36,8 @@ Run `npm run lint`. If there are issues run `npm run lint:fix`.
#### For integration tests:
> For integration tests to work, you'll need to have `git-lfs` installed (see below) as it stores the images that the snapshot tests will use.
1. Fetch the datasets with `npm run get-data` and `npm run get-narratives`.
2. Ensure you are **not** currently running the site locally, then run `npm run integration-test:ci`.
@ -44,6 +46,20 @@ Run `npm run lint`. If there are issues run `npm run lint:fix`.
1. Fetch the datasets with `npm run get-data` and `npm run get-narratives`.
2. Ensure you are **not** currently running the site locally, then run `npm run smoke-test:ci`.
## git-lfs
We use [Git Large File Storage](https://github.com/git-lfs/git-lfs) to manage certain assets.
Currently these are limited to images within the `./test` directory (which we use for snapshot integration testing) but this may change in the future.
If you are not using these images, you don't need to have `git-lfs` installed; however **will not be able to run integration tests without it**.
See [here](https://git-lfs.github.com/) for installation instructions.
Helpful commands:
```bash
git lfs status
git lfs ls-files # list LFS tracked tiles
```
## Contributing to Documentation
Nextstrain documentation is available at [nextstrain.github.io/auspice/](https://nextstrain.github.io/auspice/).

Loading…
Cancel
Save