Skip to content

Commit

Permalink
Change pkglint rules with respects to repository URL & author (aws#497)
Browse files Browse the repository at this point in the history
Adds an `organization: true` property to the author so we can appropriately label the
author entry in `pom.xml` files (this is an extension defined/used by `jsii`).

Switch the `repository.url` to the `http` github endpoint, as this allows us to produce a
"standard" URL for use in `pom.xml` files for Maven Central. While this isn't "required"
per se, it makes the package metadata "better" in that they adhere to the Maven Central
best practices (repository URL is a web interface) while keeping the repository URL
something that can be used for read-only source access.
  • Loading branch information
RomainMuller authored Aug 3, 2018
1 parent b622137 commit d8ffedf
Show file tree
Hide file tree
Showing 93 changed files with 271 additions and 181 deletions.
5 changes: 3 additions & 2 deletions examples/cdk-examples-typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
},
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand All @@ -37,7 +38,7 @@
"@aws-cdk/runtime-values": "^0.8.0"
},
"repository": {
"url": "git://github.com/awslabs/aws-cdk",
"url": "https://github.com/awslabs/aws-cdk.git",
"type": "git"
},
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
},
"license": "LicenseRef-LICENSE",
"license": "Apache-2.0",
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/applet-js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
},
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand All @@ -31,7 +32,7 @@
"yamljs": "^0.2.0"
},
"repository": {
"url": "git://github.com/awslabs/aws-cdk",
"url": "https://github.com/awslabs/aws-cdk.git",
"type": "git"
},
"keywords": [
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/assert/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
},
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand All @@ -32,7 +33,7 @@
"source-map-support": "^0.5.6"
},
"repository": {
"url": "git://github.com/awslabs/aws-cdk",
"url": "https://github.com/awslabs/aws-cdk.git",
"type": "git"
},
"keywords": [
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/assets/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -40,7 +40,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-apigateway/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-applicationautoscaling/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-appsync/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-athena/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-autoscaling/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-autoscalingplans/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-batch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-budgets/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-certificatemanager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-cloud9/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-cloudformation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-cloudfront/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -42,7 +42,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-cloudtrail/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -42,7 +42,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-cloudwatch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -43,7 +43,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-codebuild-codepipeline/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -41,7 +41,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-codebuild/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
"url": "https://github.com/awslabs/aws-cdk.git"
},
"scripts": {
"build": "cdk-build",
Expand All @@ -46,7 +46,8 @@
],
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
"url": "https://aws.amazon.com",
"organization": true
},
"license": "Apache-2.0",
"devDependencies": {
Expand Down
Loading

0 comments on commit d8ffedf

Please sign in to comment.