Skip to content

Commit 4b956d2

Browse files
authored
Update README.md
1 parent 6b7fbf2 commit 4b956d2

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,41 @@ The longitudinal plots are configured in the `plot` section of `bench_runner.tom
122122

123123
**TODO: Describe this in more detail**
124124

125+
#### Purging old data
126+
127+
With a local checkout of your results repository you can perform some maintenance tasks.
128+
129+
Clone your results repository, and then install the correct version of bench_runner into a virtual environment to use the bench_runner command:
130+
131+
```
132+
git clone {YOUR_RESULTS_REPO}
133+
cd {YOUR_RESULTS_REPO}
134+
python -m venv venv
135+
source venv/bin/activate
136+
pip install -r requirements.txt
137+
```
138+
139+
Periodically, you will want to run the `purge` command to remove old results that aren't of a tagged Python release.
140+
141+
```
142+
python -m bench_runner purge
143+
```
144+
145+
To see more options that control what is deleted, run `python -m bench_runner purge --help`.
146+
147+
After purging the results, you will usually want to squash the git history down to a single commit to save space in your repository. **NOTE THAT THIS IS A DESTRUCTIVE OPERATION THAT WILL DELETE OLD DATA.**
148+
149+
```
150+
git checkout --orphan new-main main
151+
git commit -m "Purging old results on ..."
152+
153+
# Overwrite the old master branch reference with the new one
154+
git branch -M new-main main
155+
git push -f origin main
156+
```
157+
158+
### Running
159+
125160
## Developer
126161

127162
To learn how to hack on this project, see the full [developer documentation](DEVELOPER.md).

0 commit comments

Comments
 (0)