- Install the follow packages:
git,kubectl,helm,helm-docs. See this tutorial. - [OPTIONAL] Configure authentication on your Github account to use the SSH protocol instead of HTTP. Watch this tutorial to learn how to set up: https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
- Create a fork this repository.
- Clone the forked repository to your local system:
git clone URL_FORKED_REPOSITORY- Add the address for the remote original repository:
git remote -v
git remote add upstream https://github.com/VictoriaMetrics/helm-charts
git remote -v- Create a branch. Example:
git checkout -b BRANCH_NAME- Make sure you are on the correct branch using the following command. The branch in use contains the '*' before the name.
git branch- Make your changes and tests to the new branch.
- Run command
helm-docsto update content ofREADME.mdfile of all charts using theREADME.md.gotmpltemplate. - Commit the changes to the branch.
- Push files to repository remote with command:
git push --set-upstream origin BRANCH_NAME- Create Pull Request (PR) to the
masterbranch. See this tutorial - Update the content with the suggestions of the reviewer (if necessary).
- After your pull request is merged to the
masterbranch, update your local clone:
git checkout master
git pull upstream master- Clean up after your pull request is merged with command:
git branch -d BRANCH_NAME- Then you can update the
masterbranch in your forked repository.
git push origin master- And push the deletion of the feature branch to your GitHub repository with command:
git push --delete origin BRANCH_NAME- To keep your fork in sync with the original repository, use these commands:
git pull upstream master
git push origin masterReference: