Skip to content

Commit 4382064

Browse files
build(deps): bump markdown-it and markdownlint-cli in /tools/linters (#532)
* build(deps): bump markdown-it and markdownlint-cli in /tools/linters Bumps [markdown-it](https://github.com/markdown-it/markdown-it) to 13.0.1 and updates ancestor dependency [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli). These dependencies need to be updated together. Updates `markdown-it` from 10.0.0 to 13.0.1 - [Changelog](https://github.com/markdown-it/markdown-it/blob/master/CHANGELOG.md) - [Commits](markdown-it/markdown-it@10.0.0...13.0.1) Updates `markdownlint-cli` from 0.22.0 to 0.35.0 - [Release notes](https://github.com/igorshubovych/markdownlint-cli/releases) - [Commits](igorshubovych/markdownlint-cli@v0.22.0...v0.35.0) --- updated-dependencies: - dependency-name: markdown-it dependency-type: indirect - dependency-name: markdownlint-cli dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> * Update rules and markdowns --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Rico Hermans <[email protected]>
1 parent a05eb01 commit 4382064

10 files changed

+838
-363
lines changed

.markdownlint.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,14 @@
33
"commands-show-output": false,
44
"fenced-code-language": false,
55
"first-line-h1": false,
6-
"line_length": {
6+
"MD013": {
77
"line_length": 150,
88
"tables": false
99
},
10-
"MD046": "fenced",
10+
"MD034": false,
11+
"MD046": { "style": "fenced" },
12+
"MD049": false,
13+
"MD050": false,
1114
"no-duplicate-heading": {
1215
"siblings_only": true
1316
},

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ future state of the libraries and to discover projects for contribution.
88
[jsii]: https://github.com/aws/jsii
99

1010
**Jump to**: [What is an RFC?](#what-is-an-rfc) |
11-
[When to submit?](#when-to-submit-an-rfc) |
1211
[RFC Process](#rfc-process) |
1312
[RFC Life Cycle](#the-rfc-life-cycle)
1413

@@ -403,7 +402,7 @@ Throughout this process, update the tracking issue:
403402
- Plan approved and merged (label: `status/implementing`)
404403
- Implementation complete (label: `status/done`)
405404

406-
## State Diagram
405+
## The RFC Life Cycle
407406

408407
The following state diagram describes the RFC process:
409408

text/00110-cli-framework-compatibility-strategy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ incompatible change to the _cloud-assembly-schema_ itself. This can, for
134134
example, be the removal of a property.
135135

136136
> See concrete
137-
> [example](#rename-target-property-in-containerImageAssetMetadataEntry).
137+
> [example](#rename-target-property-in-containerimageassetmetadataentry).
138138
139139
The proposed solution for this case is to run API compatibility checks using
140140
`jsii-diff`. We would treat _cloud-assembly-schema_ as a regular `jsii` module
@@ -416,7 +416,7 @@ function, and contains two validations:
416416

417417
1. **Framework cannot be bigger than CLI.**
418418

419-
We have already [described](#step-3-validate-cli--framework) how to handle
419+
We have already [described](#compatibility-validation) how to handle
420420
this validation.
421421

422422
2. **CLI cannot be bigger than Framework.**

text/0079-cdk-2.0.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,6 @@ match the first GA release, and the `latest` distribution tag will start
314314
tracking the versions of CDKv2. A new distribution tag called `latest-1`
315315
will be created to track the latest release of CDK `1.x.y`.
316316

317-
[semantic versioning]: https://semver.org/#spec-item-9
318317
[pom version order]:
319318
https://maven.apache.org/pom.html#Version_Order_Specification
320319
[nuget versioning]:
@@ -396,8 +395,6 @@ branch to be the new `master`. At this point,
396395
- The PR check will be removed from the `master` branch. Let the deprecations on
397396
CDKv2 begin!
398397

399-
[import rewrites]:
400-
https://github.com/aws/aws-cdk/tree/master/packages/%40monocdk-experiment/rewrite-imports
401398
[lambda runtimes]:
402399
https://github.com/aws/aws-cdk/blob/b757d8856216152b03c1ed3ffe2f29719aff8c27/packages/%40aws-cdk/aws-lambda/lib/runtime.ts#L37-L63
403400
[rds oracle versions]:
@@ -516,8 +513,6 @@ used to track adoption of the new version. We will encourage customers to
516513
provide feedback on the upcoming new release using a pinned GitHub issue, and
517514
possibly other means.
518515

519-
[version reporting]: https://docs.aws.amazon.com/cdk/latest/guide/tools.html
520-
521516
## General Availability
522517

523518
After the _Developer Preview_ has been sufficiently vetted, a timeline for
@@ -566,8 +561,6 @@ dataset. Should adoption pick up too slowly, actions will be taken to understand
566561
the causes for slow adoption and identify opportunities to provide additional
567562
tooling to remove roadblocks and facilitate migration.
568563

569-
[version reporting]: https://docs.aws.amazon.com/cdk/latest/guide/tools.html
570-
571564
## Deprecation of v1
572565

573566
Based on the [maintenance policy](#aws-cdk-maintenance-policy), new feature
@@ -761,7 +754,7 @@ All users will perform the following to adopt CDK v2
761754

762755
Users will naturally have to make additional changes when upgrading if they are
763756
relying on deprecated APIs or _old behaviors_ from feature flags that are being
764-
removed. A [migration guide](#migration-guide) will be written with details
757+
removed. A migration guide will be written with details
765758
about each individual feature flag and deprecated API that users may need to
766759
handle differently when upgrading.
767760

text/0107-construct-library-module-lifecycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Each stage in this document describes 3 distinct sets of activities:
4343
- **Exit criteria:** When these criteria are all met, a module can progress into
4444
the next stage. Note that, while all of the criteria here are necessary, they
4545
may not be sufficient. The module still needs to be chosen for maturation
46-
using the [prioritization framework](#Construct-prioritization-framework).
46+
using the [prioritization framework](#construct-prioritization-tenets).
4747

4848
## Stage 0 - CFN Resources
4949

@@ -108,7 +108,7 @@ changes, we will author a Request for Comments (RFC) that outlines our design
108108
and publish it on the roadmap for feedback. We will also use pull requests to
109109
conduct construct reviews. In all cases, relevant RFCs, PRs, bugs, and feature
110110
requests that are in scope are linked in the module’s tracking issue for
111-
visibility. See [Appendix A](#Appendix-A:-GitHub-Artifacts) for an illustration
111+
visibility. See [Appendix A](#appendix-a-github-artifacts) for an illustration
112112
of how these GitHub artifacts are used and related to each other.
113113

114114
### Entry activities
@@ -369,7 +369,7 @@ modules to work on next:
369369
constructs but are still experimental.
370370
- _“Do the most difficult work first”_ - prioritize modules that have a large
371371
and/or complex API surface area that we know will take significant effort.
372-
[Appendix B](#appendix-b:-module-complexity-t-shirt-sizes) proposes
372+
[Appendix B](#appendix-b-module-complexity-t-shirt-sizes) proposes
373373
“T-shirt”sizes for each module in the construct library to identify work that
374374
falls into this category, and module owners are responsible for estimate this
375375
effort.

text/0192-remove-constructs-compat.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -812,7 +812,7 @@ The first two use cases have already been addressed by centralizing the
812812
### 07-NO-SYNTHESIZE
813813

814814
Version 4.x of the `constructs` library does not contain a lifecycle hook for
815-
synthesis as described [above](#the-synthesize-hook-is-no-longer-supported).
815+
synthesis as described [above](#07-no-synthesize-the-synthesize-hook-is-no-longer-supported).
816816

817817
The reason this is not available at the base class is because the abstraction
818818
did not "hold water" as the AWS CDK evolved and new CDKs emerged. In the AWS
@@ -955,11 +955,11 @@ If we consider the various [reasons](#drawbacks) not to take this change, the
955955
main reason would be to simplify the
956956
[migration for users from 1.x to 2.x](#user-migration-effort). The major version
957957
2.x is already required to introduce monolithic packaging, and this change, for
958-
most users, is likely to be trivial (see [above](#breaking-changes)). Therefore,
958+
most users, is likely to be trivial (see above). Therefore,
959959
we believe this is probably not the correct motivation to reject this proposal.
960960

961-
The [repository migration](#repository-migration-efforts) efforts and
962-
[co-existence of 2.x/1.x](#co-existence-of-2x1x) are both one-off costs this
961+
The [repository migration](#cdk-codebase-migration-efforts) efforts and
962+
co-existence of 2.x/1.x are both one-off costs this
963963
proposal suggests ways to reduce the chance for merge conflicts across these
964964
branches.
965965

@@ -1201,6 +1201,3 @@ The original text follows:
12011201
> See
12021202
> [discussion](https://github.com/aws/aws-cdk-rfcs/pull/195/files#r460718960)
12031203
> over the RFC PR.
1204-
1205-
[`constructnode`]:
1206-
https://github.com/hashicorp/terraform-cdk/blob/5becfbc699180adfe920dec794200bbf56dda0a7/packages/cdktf/lib/terraform-element.ts#L21

text/0324-cdk-construct-hub.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,6 @@ detail pages.
258258
------------|----------------------------------------------------------------
259259
`v${major}` | All versions part of this major version stream, and their status
260260

261-
[SemVer]: https://semver.org/spec/v2.0.0.html
262-
263261
In order to ensure consistency of the contents of the `versions.json`
264262
object, its content will always be generated from the live inventory of
265263
objects in S3 (and not incrementally using the update trigger event), and
@@ -280,8 +278,6 @@ detail pages.
280278
This transformation is backed by the `jsii-rosetta` tool, which is part of
281279
the [jsii project][jsii], as well as custom code for generating language specific API references.
282280

283-
[jsii]: https://aws.github.io/jsii
284-
285281
- The **Doc-Gen** functions run asynchronously, and the documentation definition
286282
eventually becomes available. If the object is not available yet,
287283
the web UI should present the user with a message inviting them to come

text/0477-policy-validation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Ensure S3 Buckets are encrypted with a KMS CMK (1 occurrences)
9595
Severity: medium
9696
9797
Occurrences:
98-
98+
9999
- Construct Path: MyStack/MyCustomL3Construct/Bucket
100100
- Stack Template Path: ./cdk.out/MyStack.template.json
101101
- Creation Stack:
@@ -121,7 +121,7 @@ Severity: medium
121121
> Add to construct properties for `cdk-app/MyStack/Bucket`
122122
`encryption: BucketEncryption.KMS`
123123
124-
124+
125125
Validation failed. See above reports for details
126126
```
127127

@@ -474,7 +474,7 @@ CDK at a larger scale.
474474

475475
### What is the technical solution (design) of this feature?
476476

477-
See [Appendix A - High level design](#appendix-a-high-level-design).
477+
See [Appendix A - High level design](#appendix-a---high-level-design).
478478

479479
### Is this a breaking change?
480480

@@ -615,7 +615,7 @@ plugin should conform to.
615615

616616
Zero or more plugins may be added to the CDK application's `App` instance. At
617617
some point during synthesis (
618-
see [Appendix B - Implementation details](#appendix-b-implementation-details)
618+
see [Appendix B - Implementation details](#appendix-b---implementation-details)
619619
for
620620
some possibilities) the framework will pass the generated CloudFormation
621621
template to all the plugins, collect the output

0 commit comments

Comments
 (0)