Skip to content

Commit

Permalink
Merge pull request #60 from ciaranRoche/OCM-8956-doc
Browse files Browse the repository at this point in the history
OCM-8956 | doc: update contributing guide for releasing common repo
  • Loading branch information
ciaranRoche authored Jun 20, 2024
2 parents 5683337 + 7820dc4 commit 12656d8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 38 deletions.
18 changes: 2 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,23 +69,9 @@ This repository uses GitHub actions which are configured at `./github/workflows`

## Releasing a new OCM-Common Version

Releasing a new version requires submitting an MR for review/merge with an update to the `Version` constant in
[version.go](version.go). Additionally, update the [CHANGES.md](CHANGES.md) file to include the new version and
describe all changes included.
Releases are handled via GitHub action and goreleaser. Simply push a version tag to create a release.

Below is an example CHANGES.md update:

```
## 0.1.39 Jul 3 2023
- Bump github.com/onsi/ginkgo/v2 from 2.8.1 to 2.9.1
- Update CONTRIBUTING.md contribution instructions
- Added new unit test in sample_test.go
```

Submit an MR for review/merge with the CHANGES.md and version.go update.

Finally, create and submit a new tag with the new version following the below example:
Create and submit a new tag with the new version following the below example:

```shell
git checkout main
Expand Down
22 changes: 0 additions & 22 deletions version.go

This file was deleted.

0 comments on commit 12656d8

Please sign in to comment.