Skip to content
This repository was archived by the owner on May 2, 2023. It is now read-only.

Commit 4c52ebe

Browse files
Including base info on changelogs
1 parent 0343416 commit 4c52ebe

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ For more information, please read the following blog post:
1919
.
2020
├── LICENSE <-- Repo code license
2121
├── README.md <-- This README file
22+
├── CHANGELOG.md <-- Changelog of current major version
2223
├── all-cfn-versions.json <-- Tracks version history
2324
├── documentation-broken...json <-- Detailed info on BrokenDocLinks
2425
├── documentation-lookup...json <-- All Documentation property errors
@@ -28,7 +29,14 @@ For more information, please read the following blog post:
2829
├── iampolicy.json <-- Copy of AWS IAM policy perms to read s3
2930
├── cfn-resource-list.py <-- Checks for and downloads latest spec files
3031
├── cfn-supported...py <-- Audits supported services and cfn docs
32+
├── cfn-changelogger.py <-- Creates changelogs/*.json changelogs
33+
├── create-changelog.py <-- Creates changelogs/*.md and CHANGELOG.md
3134
└── create-pull-request.py <-- Creates PR if audit files update
35+
└── changelogs
36+
├── v8-changelog.json <-- Machine-readable changelog of v8.*.*
37+
├── v8-changelog.md <-- Human-readable changelog of v8.*.*
38+
├── ...
39+
└── ...
3240
└── specs <-- Region resource spec dir
3341
├── us-east-1
3442
   │ └── CloudFormationResourceSpecification.json
@@ -48,6 +56,8 @@ This repository automatically updates itself over time.
4856
- Lint with flake8
4957
- Look for and update new CFN specs if found
5058
- Audit documentation links and cfn user guide
59+
- Generate changelog source file
60+
- Generate changelog markdown file
5161
- Create pull request if any files were updated
5262

5363
> ***NOTE:*** _The **Install dependencies via Pipenv** step also updates the `aws-cloudformation-user-guide` submodule, if any updates are available._
@@ -75,7 +85,11 @@ The following files may be updated:
7585
- `supported-regions-per-resource.json`
7686
- `documentation-lookup-errors.json`
7787

78-
> ***NOTE:*** __If any files are updated, either the JSON files listed above or the `aws-cloudformation-user-guide` submodule, then the last build step creates a new branch with a PR: **Create pull request if any files were updated**_
88+
> ***NOTE:*** _If any files are updated, either the JSON files listed above or the `aws-cloudformation-user-guide` submodule, then the last build step creates a new branch with a PR: **Create pull request if any files were updated**_
89+
90+
#### Step: Generate changelog source file
91+
92+
#### Step: Generate changelog markdown file
7993

8094
#### Yet to Automate
8195

0 commit comments

Comments
 (0)