From 7820dc41dc27abb33f8989cca668c20519df0f5e Mon Sep 17 00:00:00 2001 From: croche Date: Thu, 20 Jun 2024 13:13:36 +0100 Subject: [PATCH] OCM-8956 | docs: update contributing guide for releasing common repo --- CONTRIBUTING.md | 18 ++---------------- version.go | 22 ---------------------- 2 files changed, 2 insertions(+), 38 deletions(-) delete mode 100644 version.go diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90fca726..fe46e1df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/version.go b/version.go deleted file mode 100644 index 7df8d63a..00000000 --- a/version.go +++ /dev/null @@ -1,22 +0,0 @@ -/* -Copyright (c) 2023 Red Hat, Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -// This file contains the version number of the client. - -package sdk - -const Version = "0.1.0" -