Skip to content
This repository has been archived by the owner on Nov 20, 2023. It is now read-only.

Latest commit

 

History

History
54 lines (36 loc) · 1.92 KB

dev_guide.md

File metadata and controls

54 lines (36 loc) · 1.92 KB
Raw

Development and Contribution to template2helm

We encourage contributions to this project! We follow a fairly standard forking workflow for open source projects. This document provides some information about getting your environment set up.

In general, the requirements to contribute to this project are as follows:

Build Binary

The default target in the makefile will build the project binary in the local directory. From there you can manually test it.

$ make

$ ./template2helm
Template2helm converts an OpenShift Template into a Helm Chart.
      For more info, check out https://github.com/redhat-cop/template2helm

Usage:
  template2helm [command]

Available Commands:
  convert     Given the path to an OpenShift template file, spit out a Helm chart.
  help        Help about any command
  version     Print the version number of template2helm

Flags:
  -h, --help   help for template2helm

Use "template2helm [command] --help" for more information about a command.

Running Tests

There is some automated test coverage in the libraries. You can run all tests with:

$ make test_e2e

Cutting Releases

We use a GitHub Actions workflow to automate creating releases of our project. It triggers by creating and pushing a new tag to the main repo that uses semantic versioning.

# Create a new tag for the release
git tag -a <version> -m "Release <version>"
git push -u upstream <version>

It also requires the creation of a secret called GITHUB_TOKEN in the repo being used to do the releases. The value of this secret should be a GitHub API Token.