Skip to content

Commit dbb9907

Browse files
sapessisapessi
committed
Cleaned up generated readme for all archetypes
1 parent 97b27a6 commit dbb9907

File tree

12 files changed

+53
-53
lines changed
  • aws-serverless-jersey-archetype
  • aws-serverless-spark-archetype
  • aws-serverless-spring-archetype
  • aws-serverless-springboot-archetype
  • aws-serverless-springboot2-archetype
  • aws-serverless-struts2-archetype

12 files changed

+53
-53
lines changed

‎aws-serverless-jersey-archetype/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
<filtering>true</filtering>
3232
<includes>
3333
<include>archetype-resources/pom.xml</include>
34+
<include>archetype-resources/README.md</include>
3435
</includes>
3536
</resource>
3637
<resource>

‎aws-serverless-jersey-archetype/src/main/resources/archetype-resources/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,18 @@
1515
#set($resourceName = "#replaceChar($resourceName, '-')")
1616
#set($resourceName = "#replaceChar($resourceName, '.')")
1717
#set($resourceName = $resourceName.replaceAll("\n", "").trim())
18-
# ${artifactId} serverless API
19-
The ${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
18+
# \${artifactId} serverless API
19+
The \${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
2020

2121
The starter project defines a simple `/ping` resource that can accept `GET` requests with its tests.
2222

2323
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
2424

2525
## Building the project
26-
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible jar file simply by running the maven package command from the projct folder.
27-
26+
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible zip file simply by running the maven package command from the projct folder.
2827
```bash
29-
$ mvn archetype:generate -DartifactId=my-jersey-api -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-jersey-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.sapessi.jersey -Dversion=0.1 -Dinteractive=false
30-
$ cd my-jersey-api
28+
$ mvn archetype:generate -DartifactId=\${artifactId} -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-jersey-archetype -DarchetypeVersion=${project.version} -DgroupId=\${groupId} -Dversion=\${version} -Dinteractive=false
29+
$ cd \${artifactId}
3130
$ mvn clean package
3231

3332
[INFO] ------------------------------------------------------------------------
@@ -100,8 +99,8 @@ $ aws cloudformation describe-stacks --stack-name ServerlessJerseyApi
10099
"Outputs": [
101100
{
102101
"Description": "URL for application",
103-
"ExportName": "${resourceName}Api",
104-
"OutputKey": "${resourceName}Api",
102+
"ExportName": "\${resourceName}Api",
103+
"OutputKey": "\${resourceName}Api",
105104
"OutputValue": "https://xxxxxxx.execute-api.us-west-2.amazonaws.com/Prod/ping"
106105
}
107106
],

‎aws-serverless-spark-archetype/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
<filtering>true</filtering>
3232
<includes>
3333
<include>archetype-resources/pom.xml</include>
34+
<include>archetype-resources/README.md</include>
3435
</includes>
3536
</resource>
3637
<resource>

‎aws-serverless-spark-archetype/src/main/resources/archetype-resources/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,18 @@
1515
#set($resourceName = "#replaceChar($resourceName, '-')")
1616
#set($resourceName = "#replaceChar($resourceName, '.')")
1717
#set($resourceName = $resourceName.replaceAll("\n", "").trim())
18-
# ${artifactId} serverless API
19-
The ${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
18+
# \${artifactId} serverless API
19+
The \${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
2020

2121
The starter project defines a simple `/ping` resource that can accept `GET` requests with its tests.
2222

23-
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
23+
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
2424

2525
## Building the project
26-
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible jar file simply by running the maven package command from the projct folder.
27-
26+
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible zip file simply by running the maven package command from the projct folder.
2827
```bash
29-
$ mvn archetype:generate -DartifactId=my-spark-api -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-spark-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.sapessi.spark -Dversion=0.1 -Dinteractive=false
30-
$ cd my-spark-api
28+
$ mvn archetype:generate -DartifactId=\${artifactId} -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-spark-archetype -DarchetypeVersion=${project.version} -DgroupId=\${groupId} -Dversion=\${version} -Dinteractive=false
29+
$ cd \${artifactId}
3130
$ mvn clean package
3231

3332
[INFO] ------------------------------------------------------------------------
@@ -100,8 +99,8 @@ $ aws cloudformation describe-stacks --stack-name ServerlessSparkApi
10099
"Outputs": [
101100
{
102101
"Description": "URL for application",
103-
"ExportName": "${resourceName}Api",
104-
"OutputKey": "${resourceName}Api",
102+
"ExportName": "\${resourceName}Api",
103+
"OutputKey": "\${resourceName}Api",
105104
"OutputValue": "https://xxxxxxx.execute-api.us-west-2.amazonaws.com/Prod/ping"
106105
}
107106
],

‎aws-serverless-spring-archetype/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
<filtering>true</filtering>
3232
<includes>
3333
<include>archetype-resources/pom.xml</include>
34+
<include>archetype-resources/README.md</include>
3435
</includes>
3536
</resource>
3637
<resource>

‎aws-serverless-spring-archetype/src/main/resources/archetype-resources/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,18 @@
1515
#set($resourceName = "#replaceChar($resourceName, '-')")
1616
#set($resourceName = "#replaceChar($resourceName, '.')")
1717
#set($resourceName = $resourceName.replaceAll("\n", "").trim())
18-
# ${artifactId} serverless API
19-
The ${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
18+
# \${artifactId} serverless API
19+
The \${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
2020

2121
The starter project defines a simple `/ping` resource that can accept `GET` requests with its tests.
2222

23-
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
23+
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
2424

2525
## Building the project
26-
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible jar file simply by running the maven package command from the projct folder.
27-
26+
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible zip file simply by running the maven package command from the projct folder.
2827
```bash
29-
$ mvn archetype:generate -DartifactId=my-spring-api -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-spring-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.sapessi.spring -Dversion=0.1 -Dinteractive=false
30-
$ cd my-spring-api
28+
$ mvn archetype:generate -DartifactId=\${artifactId} -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-spring-archetype -DarchetypeVersion=${project.version} -DgroupId=\${groupId} -Dversion=\${version} -Dinteractive=false
29+
$ cd \${artifactId}
3130
$ mvn clean package
3231

3332
[INFO] ------------------------------------------------------------------------
@@ -100,8 +99,8 @@ $ aws cloudformation describe-stacks --stack-name ServerlessSpringApi
10099
"Outputs": [
101100
{
102101
"Description": "URL for application",
103-
"ExportName": "${resourceName}Api",
104-
"OutputKey": "${resourceName}Api",
102+
"ExportName": "\${resourceName}Api",
103+
"OutputKey": "\${resourceName}Api",
105104
"OutputValue": "https://xxxxxxx.execute-api.us-west-2.amazonaws.com/Prod/ping"
106105
}
107106
],

‎aws-serverless-springboot-archetype/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
<filtering>true</filtering>
3232
<includes>
3333
<include>archetype-resources/pom.xml</include>
34+
<include>archetype-resources/README.md</include>
3435
</includes>
3536
</resource>
3637
<resource>

‎aws-serverless-springboot-archetype/src/main/resources/archetype-resources/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,18 @@
1515
#set($resourceName = "#replaceChar($resourceName, '-')")
1616
#set($resourceName = "#replaceChar($resourceName, '.')")
1717
#set($resourceName = $resourceName.replaceAll("\n", "").trim())
18-
# ${artifactId} serverless API
19-
The ${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
18+
# \${artifactId} serverless API
19+
The \${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
2020

2121
The starter project defines a simple `/ping` resource that can accept `GET` requests with its tests.
2222

23-
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
23+
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
2424

2525
## Building the project
26-
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible jar file simply by running the maven package command from the projct folder.
27-
26+
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible zip file simply by running the maven package command from the projct folder.
2827
```bash
29-
$ mvn archetype:generate -DartifactId=my-spring-api -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-spring-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.sapessi.spring -Dversion=0.1 -Dinteractive=false
30-
$ cd my-spring-api
28+
$ mvn archetype:generate -DartifactId=\${artifactId} -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-springboot-archetype -DarchetypeVersion=${project.version} -DgroupId=\${groupId} -Dversion=\${version} -Dinteractive=false
29+
$ cd \${artifactId}
3130
$ mvn clean package
3231

3332
[INFO] ------------------------------------------------------------------------
@@ -100,8 +99,8 @@ $ aws cloudformation describe-stacks --stack-name ServerlessSpringApi
10099
"Outputs": [
101100
{
102101
"Description": "URL for application",
103-
"ExportName": "${resourceName}Api",
104-
"OutputKey": "${resourceName}Api",
102+
"ExportName": "\${resourceName}Api",
103+
"OutputKey": "\${resourceName}Api",
105104
"OutputValue": "https://xxxxxxx.execute-api.us-west-2.amazonaws.com/Prod/ping"
106105
}
107106
],

‎aws-serverless-springboot2-archetype/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
<filtering>true</filtering>
3232
<includes>
3333
<include>archetype-resources/pom.xml</include>
34+
<include>archetype-resources/README.md</include>
3435
</includes>
3536
</resource>
3637
<resource>

‎aws-serverless-springboot2-archetype/src/main/resources/archetype-resources/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,18 @@
1515
#set($resourceName = "#replaceChar($resourceName, '-')")
1616
#set($resourceName = "#replaceChar($resourceName, '.')")
1717
#set($resourceName = $resourceName.replaceAll("\n", "").trim())
18-
# ${artifactId} serverless API
19-
The ${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
18+
# \${artifactId} serverless API
19+
The \${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
2020

2121
The starter project defines a simple `/ping` resource that can accept `GET` requests with its tests.
2222

23-
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
23+
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
2424

2525
## Building the project
26-
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible jar file simply by running the maven package command from the projct folder.
27-
26+
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible zip file simply by running the maven package command from the projct folder.
2827
```bash
29-
$ mvn archetype:generate -DartifactId=my-spring-api -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-spring-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.sapessi.spring -Dversion=0.1 -Dinteractive=false
30-
$ cd my-spring-api
28+
$ mvn archetype:generate -DartifactId=\${artifactId} -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-springboot2-archetype -DarchetypeVersion=${project.version} -DgroupId=\${groupId} -Dversion=\${version} -Dinteractive=false
29+
$ cd \${artifactId}
3130
$ mvn clean package
3231

3332
[INFO] ------------------------------------------------------------------------
@@ -100,8 +99,8 @@ $ aws cloudformation describe-stacks --stack-name ServerlessSpringApi
10099
"Outputs": [
101100
{
102101
"Description": "URL for application",
103-
"ExportName": "${resourceName}Api",
104-
"OutputKey": "${resourceName}Api",
102+
"ExportName": "\${resourceName}Api",
103+
"OutputKey": "\${resourceName}Api",
105104
"OutputValue": "https://xxxxxxx.execute-api.us-west-2.amazonaws.com/Prod/ping"
106105
}
107106
],

‎aws-serverless-struts2-archetype/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
<filtering>true</filtering>
3232
<includes>
3333
<include>archetype-resources/pom.xml</include>
34+
<include>archetype-resources/README.md</include>
3435
</includes>
3536
</resource>
3637
<resource>

‎aws-serverless-struts2-archetype/src/main/resources/archetype-resources/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,18 @@
1515
#set($resourceName = "#replaceChar($resourceName, '-')")
1616
#set($resourceName = "#replaceChar($resourceName, '.')")
1717
#set($resourceName = $resourceName.replaceAll("\n", "").trim())
18-
# ${artifactId} serverless API
19-
The ${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
18+
# \${artifactId} serverless API
19+
The \${artifactId} project, created with [`aws-serverless-java-container`](https://github.com/awslabs/aws-serverless-java-container).
2020

2121
The starter project defines a simple `/ping` resource that can accept `GET` requests with its tests.
2222

23-
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
23+
The project folder also includes a `sam.yaml` file. You can use this [SAM](https://github.com/awslabs/serverless-application-model) file to deploy the project to AWS Lambda and Amazon API Gateway or test in local with [SAM Local](https://github.com/awslabs/aws-sam-local).
2424

2525
## Building the project
26-
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible jar file simply by running the maven package command from the projct folder.
27-
26+
Using [Maven](https://maven.apache.org/), you can create an AWS Lambda-compatible zip file simply by running the maven package command from the projct folder.
2827
```bash
29-
$ mvn archetype:generate -DartifactId=my-spring-api -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-spring-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.sapessi.spring -Dversion=0.1 -Dinteractive=false
30-
$ cd my-spring-api
28+
$ mvn archetype:generate -DartifactId=\${artifactId} -DarchetypeGroupId=com.amazonaws.serverless.archetypes -DarchetypeArtifactId=aws-serverless-struts2-archetype -DarchetypeVersion=${project.version} -DgroupId=\${groupId} -Dversion=\${version} -Dinteractive=false
29+
$ cd \${artifactId}
3130
$ mvn clean package
3231

3332
[INFO] ------------------------------------------------------------------------
@@ -100,8 +99,8 @@ $ aws cloudformation describe-stacks --stack-name ServerlessSpringApi
10099
"Outputs": [
101100
{
102101
"Description": "URL for application",
103-
"ExportName": "${resourceName}Api",
104-
"OutputKey": "${resourceName}Api",
102+
"ExportName": "\${resourceName}Api",
103+
"OutputKey": "\${resourceName}Api",
105104
"OutputValue": "https://xxxxxxx.execute-api.us-west-2.amazonaws.com/Prod/ping"
106105
}
107106
],

0 commit comments

Comments
 (0)