Skip to content

Commit

Permalink
Add docs about how to cut a release
Browse files Browse the repository at this point in the history
We now outline our lightweight release process to correctly bump the
version numbers.

Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
  • Loading branch information
saschagrunert committed Feb 28, 2022
1 parent bd1a2ea commit 0b22b41
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ oci-spec = "0.5.4"
```
*Compiler support: requires rustc 1.54+*

If you want to propose or cut a new release, then please follow our
[release process documentation](./release.md).

## Image Format Spec Examples
- Load image manifest from filesystem
```rust no_run
Expand Down Expand Up @@ -123,8 +126,7 @@ let list = RepositoryListBuilder::default()
.repositories(vec!["busybox".to_owned()])
.build().unwrap();
```

# Contributing
This project welcomes your PRs and issues. Should you wish to work on an issue, please claim it first by commenting on the
issue that you want to work on it. This is to prevent duplicated efforts from contributers on the same issue.


15 changes: 15 additions & 0 deletions release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Releasing a new version of oci-spec-rs

A new release of this crate can be proposed by running the version bump script:

```bash
./hack/release x.y.z
```

Push the changes to your fork and draft a new GitHub Pull Request (PR) which
should now contain 2 commits, one which bumps the release version and another
one to turn it _back to dev_.

If the PR got merged, then create a new tag pointing to the first commit of that
PR (named _Bump to x.y.z_). The changelog can be created by using GitHub's
release note creation feature via the user interface.

0 comments on commit 0b22b41

Please sign in to comment.