Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release instructions and CHANGELOG #57

Merged
merged 2 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Changelog
## [0.1.0] - 2024-01-10
### New Features
- Initial release.
58 changes: 58 additions & 0 deletions README.release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Creating a New Release

## Changelog

- [ ] Update the CHANGELOG file in the project root directory.
Use `git log --oneline v0.1.0..HEAD` to get the changes since the last tag.
Pick the most important changes, especially user facing ones.

The following format should be used when adding an entry:

```
## [X.Y.Z] - YYYY-MM-DD
### Breaking Changes
- ...

### New Features
- ...

### Bug Fixes
- ...
```

## Tagging

- [ ] Tag new release in git.
```bash
# Make sure your local git repo is sync with upstream.
# The whole version string should log like `v0.1.0`.
# For the commit message use the following format: `kubevirt-realtime-checkup 0.1.0 release`.
git tag --sign v<version>
git push upstream --tags
```

- [ ] In case there is a need to remove a tag:
```bash
# Remove local tag
git tag -d <tag_name>

# Remove upstream tag
git push --delete upstream <tag_name>
```

## Container Images

- [ ] Verify that the container images with the proper label exist in the registry:
- [kubevirt-realtime-checkup](https://quay.io/repository/kiagnose/kubevirt-realtime-checkup?tab=tags)
- [kubevirt-realtime-checkup-vm](https://quay.io/repository/kiagnose/kubevirt-realtime-checkup-vm?tab=tags)

## GitHub Release

- [ ] Visit [Create a new release](https://github.com/kiagnose/kubevirt-realtime-checkup/releases/new).
- [ ] Make sure you are in `Release` tab.
- [ ] Choose the git tag just pushed.
- [ ] Set title with the following format: `Version 0.1.0 release`.
- [ ] The content should be copied from the `CHANGELOG` file.
- [ ] Add the container images references to the content.
- [ ] Click `Save draft` and seek for review.
- [ ] Click `Publish release` once approved.