Skip to content

Commit

Permalink
Instructions for creating an incremental release
Browse files Browse the repository at this point in the history
  • Loading branch information
myedibleenso committed Sep 5, 2023
1 parent 65dcc9b commit 30ba1d7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/dev/creating-an-incremental-release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Creating a semver release

This document outlines the process for creating a semver-compliant release.

### 1. Update docs/changes.md

1. Remove `(pending)` for subheader
2. Ensure URLs under subheader use the (prior) sprint's start and end dates (see [this following view in the project board](https://github.com/orgs/lum-ai/projects/6/views/12)). Adjust as needed if the release is later than expected.

### 2. Create a pull request with this change

Create a PR with your changes to docs/changes.md

### 3. Push the new tag

Once the PR has been merged, push the new tag:

```bash
# CHANGEME
TAG="v1.9.?"
NEXT_MILESTONE="M10"
URL=https://ml4ai.github.io/skema/changes/#$TAG
git tag -a $TAG -m "Incremental $TAG towards $NEXT_MILESTONE. See $URL"
git push origin --tags
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ nav:
- Building documentation: "dev/docs.md"
- Test coverage reports: "coverage/index.md"
- Building docker images: "dev/docker.md"
- Publishing an incremental release: "dev/creating-an-incremental-release.md"
#- Getting Started: getting-started.md
# - User Guide:
# - Installation: install.md
Expand Down

0 comments on commit 30ba1d7

Please sign in to comment.