Merge pull request #985 from aiyengar2/bump_main_scripts_version

[Live] Bump version to v0.0.4

.gitignore

@@ -1 +1,2 @@
-bin
+bin
+*.DS_Store

Makefile

@@ -1,5 +1,3 @@
-CHARTS_BUILD_SCRIPT_VERSION := fdf0565
-
 pull-scripts:
 	./scripts/pull-scripts
 

README.md

@@ -24,26 +24,39 @@ This repository branch contains a `configuration.yaml` file that is used to spec
 This branch syncs with the generated assets from the following branches:
 - dev-v2.5-alt at https://github.com/rancher/charts.git (only latest assets)
 
-To release a new version of a chart, please open the relevant PRs to one of these branches. Merging should trigger a sync workflow on pushing to these branches.
+To release a new version of a chart, please open the relevant PRs to one of these branches. 
+
+Merging should trigger a sync workflow on pushing to these branches.
+
+### Cutting a Release
+
+In the Live branch, cutting a release requires you to run the `make sync` command.
+
+This command will automatically get the latest charts / resources merged into the the branches you sync with (as indicated in this branch's `configuration.yaml`) and will fail if any of those branches try to modify already released assets.
+
+If the `make sync` command fails, you might have to manually make changes to the contents of the Staging Branch to resolve any issues.
+
+Once you successfully run the `make sync` command, the logs outputted will itemize the releaseCandidateVersions picked out from the Staging branch and make exactly two changes:
+
+1. It will update the `Chart.yaml`'s version for each chart to drop the `-rcXX` from it
+
+2. It will update the `Chart.yaml`'s annotations for each chart to drop the `-rcXX` from it only for some special annotations (note: currently, the only special annotation we track is `catalog.cattle.io/auto-install`).
+
+Once you successfully run the `make release` command, ensure the following is true:
+- The `assets/` and `charts/` directories each only have a single file contained within them: `README.md`
+- The `released/assets/` directory has a .tgz file for each releaseCandidateVersion of a Chart that was created during this release.
+- The `index.yaml` and `released/assets/index.yaml` both are identical and the `index.yaml`'s diff shows only two types of changes: a timestamp update or a modification of an existing URL from `assets/*` to `released/assets/*`.
+
+No other changes are expected.
 
 ### Makefile
 
-#### Package-Level (requires packages/ to exist)
+#### Basic Commands
 
-`make prepare`: Pulls in your charts from upstream and creates a basic `generated-changes/` directory with your dependencies from upstream
-
-`make patch`: Updates your `generated-changes/` to reflect the difference between upstream and the current working directory of your branch. Requires prepare
-
-`make charts`: Runs prepare and then exports your charts to `assets/` and `charts/` and generates or updates your `index.yaml`. Can be used for testing; a Rancher Helm Repository that points to a branch that has these directories with the `index.yaml` should be able to find and deploy working copies of your chart.
-
-`make clean`: Cleans up all the working directories of charts to get your repository ready for a PR
-
-#### Branch-Level (requires either packages/ or assets/ + charts/)
-
-`make pull-scripts`: Pulls in the version of the `charts-build-scripts` indicated in scripts
-
-`make validate`: Validates your current repository branch against all the repository branches indicated in your configuration.yaml
+`make pull-scripts`: Pulls in the version of the `charts-build-scripts` indicated in scripts.
 
 `make sync`: Syncs the assets in your current repository with the merged contents of all of the repository branches indicated in your configuration.yaml
 
-`make update`: Pulls in the latest docs, scripts, etc. from the charts-build-scripts repository
+`make validate`: Validates your current repository branch against all the repository branches indicated in your configuration.yaml
+
+`make docs`: Pulls in the latest docs, scripts, etc. from the charts-build-scripts repository

_config.yml

@@ -0,0 +1 @@
+exclude: [charts]

scripts/pull-scripts

@@ -3,7 +3,7 @@ set -e
 
 cd $(dirname $0)
 
-CHARTS_BUILD_SCRIPT_VERSION=v0.0.3
+source ./version
 
 echo "Pulling in charts-build-scripts version ${CHARTS_BUILD_SCRIPT_VERSION}"
 

scripts/version

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+CHARTS_BUILD_SCRIPT_VERSION=v0.0.4