Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Improve performances of the build script #175

Open
louim wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve performances of the build script #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa62387
Make the history build system only build missing history
louim Nov 1, 2018
2d03191
Run the build script to add missing history
louim Nov 1, 2018
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,16 @@ $ npm start
### Time Travel

Time travel displays past versions of the repo based on merged pull requests.
The build script in `time-travel` folder fetchs each merged pull request's `docs` folder content (except for `docs/time-travel/`) and store them in `docs/time-travel/history`, then writes data to `docs/time-travel/index.json` for later use. Currently this process has to be done manually.
The build script in `time-travel` folder fetchs each merged pull request's `docs` folder content (except for `docs/time-travel/`) and store them in `docs/time-travel/history`, then writes data to `docs/time-travel/index.json` for later use. Currently this process has to be done manually. The script will only build missing PR history. To do a full rebuild of the all PRs pass the environment variable `FULL_REBUILD=true`.

**Note**: Create a `.env` with your github's access token in order to fetch data from Github API.

```shell
# update build
$ npm run build-timetravel

# full history rebuild
$ FULL_REBUILD=true npm run build-timetravel
```

The page for time-travel is intentionally kept separated from `docs/` (not reusing `docs/css/style.css`) so it's easier to maintain.
Expand Down
Loading