-
Notifications
You must be signed in to change notification settings - Fork 390
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# 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. |