diff --git a/docs-chef-io/README.md b/docs-chef-io/README.md index aca100f3d..bf374f74d 100644 --- a/docs-chef-io/README.md +++ b/docs-chef-io/README.md @@ -120,37 +120,7 @@ Run `make clean_all` to delete the cloned copy of chef/chef-web-docs. ## Publish Release Notes -The process for publishing and announcing release notes for inspec-aws is mostly manual. - -### Edit Pending Release Notes - -Edit the Pending Release Notes file in the [inspec-aws wiki](https://github.com/inspec/inspec-aws/wiki/Pending-Release-Notes). - -We recommend editing this page as new resources are added or changes are made to the inspec-aws resources. - -Have a member of the documentation team review the Pending Release Notes file before they're released. - -### Release the Release Notes - -1. Log in to the chef-cd S3 account using saml2aws. - -2. Run the `publish-release-notes.sh` script in `tools/release-notes`. You can run this from the Makefile with `make publish_release_notes` - - This will push the pending release notes to the S3 chef-cd bucket, reset the Pending Release Notes file, and update the `release-dates.json` file in `assets/release-notes/inspec-aws`. - -3. Push up and merge a branch to `inspec/inspec-aws` with the changes made to the `release-dates.json` file. - -### chef-web-docs - -chef-web-docs is configured to open a PR that will update the inspec-aws content on when a change is committed to the `release-dates.json` file in the inspec-aws repository. This will update the InSpec AWS resource documentation and update release notes for InSpec AWS resources. - -A member fo the documentation team can merge that PR for you as soon as it's made. - -### Chef Discourse - -Copy the release notes to a new announcement in [Chef Release Announcements](https://discourse.chef.io/c/chef-release/9) on Discourse. - -You can find the proper release notes in the Pending Release Notes file history or on +InSpec AWS release notes are published from the [chef-web-docs repository](https://github.com/chef/chef-web-docs/). ## Documentation Feedback diff --git a/docs-chef-io/tools/release-notes/publish-release-notes.sh b/docs-chef-io/tools/release-notes/publish-release-notes.sh deleted file mode 100644 index b044059c2..000000000 --- a/docs-chef-io/tools/release-notes/publish-release-notes.sh +++ /dev/null @@ -1,48 +0,0 @@ -#!/bin/bash - -set -eou pipefail - -PRODUCT=inspec-aws -CURRENTDATE=$(date +"%Y-%m-%d") -DOCS_ASSETS_DIR="assets/release-notes/inspec-aws" - - -git clone "https://github.com/inspec/inspec-aws.wiki.git" - -# Append the date to the array of dates in assets/release-notes/inspec-aws/release-dates.json -DATES_FILE="${DOCS_ASSETS_DIR}/release-dates.json" -DATES=$( cat "$DATES_FILE" | jq --arg DATE "$CURRENTDATE" '. |= .+ [$DATE]' ) -echo $DATES | jq . > "$DATES_FILE" - -pushd ./inspec-aws.wiki - # Publish release notes to S3 - aws s3 cp Pending-Release-Notes.md "s3://chef-automate-artifacts/release-notes/${PRODUCT}/${CURRENTDATE}.md" --acl public-read --content-type "text/plain" --profile chef-cd - - # Reset "Release Notes" wiki page - cat >./Pending-Release-Notes.md <