From f432f4c6b99293ab63e3a15d7883ca45001e7483 Mon Sep 17 00:00:00 2001 From: Marty Sweet Date: Sun, 6 May 2018 16:55:57 +0100 Subject: [PATCH 1/2] Add initial release instructions For issues #152 --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 962fb46..b1fe39c 100644 --- a/README.md +++ b/README.md @@ -275,6 +275,37 @@ Each intrinsic function has a signature of `doIntrinsicXYZ(ref, key)` and is cal the resolved value of the function. For example, for Fn::Sub, an input of `"My ${MyInstance}"` would return a string similar to `"My i-0a0a0a0a0a`. +## Release Instructions + +0. For each PR, edit the `CHANGELOG.md` file, adding a fixed, changed or added message to the Unreleased block. +1. Create a milestone in Github for all issues and PRs which will be included in the release, for example, `v1.7.0`. +2. Create a PR for the release (branch `release-VERSION`), moving the contents of the `CHANGELOG.md` to a new version, update the links at the bottom of the file. +3. Ensure the latest CFN Specification is present ([AWS CloudFormation Resource Specification](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-resource-specification.html)) in the aws_resources_specification.json file, update if required. +4. Verify changes and merge into `master` with the title `Update CHANGELOG for VERSION (#PRNUM)`. +5. Go to [Releases](https://github.com/martysweet/cfn-lint/releases) and click "Draft a new release". +6. Enter the tag of the version and the same for the release title, for example, `v1.7.0`. +7. Copy the section of the `CHANGELOG.md` file for the release into the describe section. +8. Click publish release. This will build a publish a package to npm. +9. The unit tests can generally be trusted, however, a quick test will do no harm and might catch something missed. Next, test the release in a clean environment, ensuring the latest version is pulled. + +``` +> docker run -it node /bin/bash +$ npm install -g cfn-lint +$ cat <working.yaml +Resources: + MyBucket: + Type: AWS::S3::Bucket +EOF +$ cfn-lint validate working.yaml +$ cat <failure.yaml +Resources: + MyBucket: + Type: AWS::S3::Buckets +EOF +$ cfn-lint validate failure.yaml +``` + + ## Contributions Please check out the [Contributor's Guide](CONTRIBUTING.md) for more information on how to get started. From 0c2c17f8a2b880f6afeeb18b7c60e03e033e28d8 Mon Sep 17 00:00:00 2001 From: Marty Sweet Date: Sat, 2 Jun 2018 16:24:41 +0100 Subject: [PATCH 2/2] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b3ccd1..ace7df0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Changed +- Merge PR #162, add release instructions to README.md ## [1.7.1] - 2018-05-08 ### Fixed