Skip to content

Commit

Permalink
add release proc
Browse files Browse the repository at this point in the history
  • Loading branch information
AkshitaB committed Dec 10, 2023
1 parent e643f5e commit e801af8
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Release Process

## Steps

1. Update the version in `olmo/version.py`.

2. Run the release script:

```bash
./scripts/release.sh
```
This will automatically update the CHANGELOG, commit the changes to the CHANGELOG and `version.py` (and any other files you might have changed),
and then create a new tag in git which will trigger a workflow on GitHub Actions that handles the rest.
## Fixing a failed release
If for some reason the GitHub Actions release workflow failed with an error that needs to be fixed, you'll have to delete both the tag and corresponding release from GitHub. After you've pushed a fix, delete the tag from your local clone with
```bash
git tag -l | xargs git tag -d && git fetch -t
```

Then repeat the steps above.

0 comments on commit e801af8

Please sign in to comment.