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 git-lfs to be used for (upcoming) snapshot images #1083

Merged
merged 1 commit into from
Apr 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
test/**/*.png filter=lfs diff=lfs merge=lfs -text
16 changes: 16 additions & 0 deletions DEV_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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/).
Expand Down