Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 2.39 KB

README.md

File metadata and controls

90 lines (60 loc) · 2.39 KB
Raw

charts-build-scripts

This repository is maintained by @rancher/release-team. It is a crucial part of our release process for the built-in Helm Charts repository.

How to Use charts-build-scripts

Charts Repository Setup

Checkout the Git branch that corresponds to your Staging or Live branch.

Export BRANCH_ROLE as staging, live, or custom. Then run:

curl -s https://raw.githubusercontent.com/rancher/charts-build-scripts/master/init.sh > /dev/null | sh

Building

make

Running

./bin/charts-build-scripts

Validation command

For more information on the validation command, please see docs/validate.md.

Debugging

For more information on how to debug this project, please see docs/debugging.md.

Developing charts-build-scripts

How to Run

go run main.go

How to Run Unit Tests

go test ./...

How to Lint

golangci-lint run ./...

How to Release

Releases are done via a github action that uses goreleaser. In order to release, simply tag the commit that you want the release to be based off of with a tag that is in semver format. For example:

git tag v0.1.9

Then, push that tag to the the rancher/charts-build-scripts repo. Here is an example, assuming that rancher/charts-build-scripts is configured as upstream in your local repo:

git push upstream --tags

Pushing the tag will trigger a github actions workflow that will use the goreleaser action to build binaries for many different combinations of OS and processor architecture. This same goreleaser action will then create a release using these binaries. Release notes will be constructed from commit messages.

License

Copyright (c) 2024 Rancher Labs, 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.