Skip to content

Commit 73e9db1

Browse files
committed
Add release process instructions
1 parent 7802f83 commit 73e9db1

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,21 @@ Code for in-loop evaluation tasks used by the OLMo training team.
77
```
88
pip install ai2-olmo-eval
99
```
10+
11+
## Release process
12+
13+
### Steps
14+
15+
1. Update the version in `src/olmo_eval/version.py`.
16+
2. Run the release script:
17+
18+
```bash
19+
./src/scripts/release.sh
20+
```
21+
22+
This will commit the changes to the CHANGELOG and `version.py` files and then create a new tag in git
23+
which will trigger a workflow on GitHub Actions that handles the rest.
24+
25+
### Fixing a failed release
26+
27+
If for some reason the GitHub Actions release workflow failed with an error that needs to be fixed, you'll have to delete the tag on GitHub. Once you've pushed a fix you can simply repeat the steps above.

src/scripts/release.sh

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ set -e
44

55
TAG=$(python -c 'from olmo_eval.version import VERSION; print("v" + VERSION)')
66

7-
git pull
7+
git pull > /dev/null
8+
git tag -l | xargs git tag -d > /dev/null
9+
git fetch -t > /dev/null
810

911
# Make sure tag/release doesn't already exist.
1012
STATUS_CODE=$(curl -s -o /dev/null -w "%{http_code}" "https://github.com/allenai/OLMo-in-loop-evals/releases/tag/${TAG}")

0 commit comments

Comments
 (0)