Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: reference documentation is missing + bump to v0.24.1 #1704

Merged
merged 3 commits into from
Feb 7, 2019
Merged

fix: reference documentation is missing + bump to v0.24.1 #1704

merged 3 commits into from
Feb 7, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Feb 7, 2019

There was a missing newline in the reference.rst.template file
which caused the toc not to include the module docs.

Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

fix: reference documentation is missing
8fba8bc 
there was a missing newline in the reference.rst.template file
which caused the toc not to include the module docs.
@eladb eladb requested review from Doug-AWS and a team as code owners February 7, 2019 15:39
@rix0rrr
Copy link
Contributor

rix0rrr commented Feb 7, 2019

Don't see the version bump in here btw.

@rix0rrr
Copy link
Contributor

rix0rrr commented Feb 7, 2019

So don't merge just yet :)

@eladb
Copy link
Contributor Author

eladb commented Feb 7, 2019

Yes, I am waiting for it to build. No wowries.

Doug-AWS
Doug-AWS approved these changes Feb 7, 2019
View reviewed changes
Copy link
Contributor

@Doug-AWS Doug-AWS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

D@mmit

v0.24.1
3419a1f 
see CHANGELOG
RomainMuller
RomainMuller suggested changes Feb 7, 2019
View reviewed changes
CHANGELOG.md Outdated
@@ -1,3 +1,12 @@
## [0.24.1](https://github.com/awslabs/aws-cdk/compare/v0.24.0...v0.24.1) (2019-02-07)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ BAD HEADING

Copy link
Contributor Author

@eladb eladb Feb 7, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now I get what the problem is: the first heading is ignored by the changelog parser, it's not that it's H1

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep

RomainMuller
RomainMuller reviewed Feb 7, 2019
View reviewed changes
docs/src/reference.rst.template
@@ -16,3 +16,4 @@ Reference

.. toctree::
:maxdepth: 1

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is so sensitive, can we add a comment line to mention the blank line MUST REMAIN?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to do that in a later commit. I want to get this release out ASAP

@eladb eladb merged commit 67fcf6d into master Feb 7, 2019
@eladb eladb deleted the benisrae/v0.24.1 branch February 7, 2019 16:44
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RomainMuller RomainMuller RomainMuller approved these changes

@Doug-AWS Doug-AWS Doug-AWS approved these changes

@rix0rrr rix0rrr rix0rrr approved these changes

@skinny85 skinny85 Awaiting requested review from skinny85

@SoManyHs SoManyHs Awaiting requested review from SoManyHs

Assignees
No one assigned
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@eladb @rix0rrr @RomainMuller @Doug-AWS @NGL321