Skip to content

Commit a8356e6

Browse files
authored
chore: fix grammar and remove duplicates from .gitignore (#30)
1 parent 0060ad7 commit a8356e6

File tree

4 files changed

+5
-7
lines changed

4 files changed

+5
-7
lines changed

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ build/
1313

1414
# Gradle
1515
.gradle
16-
build/
1716
!/tools/build/
1817

1918
# Python
@@ -38,7 +37,6 @@ tests/bin/
3837
.idea
3938
*.class
4039
*.iml
41-
out/
4240

4341
# .zip files must be explicited whitelisted
4442
*.zip

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
# Contributing to Apache OpenWhisk
2222

23-
Anyone can contribute to the OpenWhisk project and we welcome your contributions.
23+
Anyone can contribute to the OpenWhisk project, and we welcome your contributions.
2424

2525
There are multiple ways to contribute: report bugs, improve the docs, and
2626
contribute code, but you must follow these prerequisites and guidelines:
@@ -49,7 +49,7 @@ Please raise any bug reports or enhancement requests on the respective project r
4949
list to see if your issue has already been raised.
5050

5151
A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong.
52-
Provide as much context as possible so we can try to recreate the issue.
52+
Provide as much context as possible, so we can try to recreate the issue.
5353

5454
A good enhancement request comes with an explanation of what you are trying to do and how that enhancement would help you.
5555

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The action is mainly composed by a `main` function that accepts a JSON `serdes V
6464

6565
### Managing dependencies
6666

67-
If your action needs external dependencies, you need to provide a zip file including your source and your cargo file with all your dependencies. The folder structure is the following:
67+
If your action needs external dependencies, you need to provide a zip file including your source, and your cargo file with all your dependencies. The folder structure is the following:
6868
```
6969
|- Cargo.toml
7070
|- src

gradle/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ Project level options that can be used on `distDocker`:
4141

4242
### Test
4343

44-
To run tests one uses the `test` task. OpenWhisk consolidates tests into a single `tests` project. Hence the command to run all tests is `gradle :tests:test`.
44+
To run tests one uses the `test` task. OpenWhisk consolidates tests into a single `tests` project. Hence, the command to run all tests is `gradle :tests:test`.
4545

4646
It is possible to run specific tests using [Gradle testfilters](https://docs.gradle.org/current/userguide/java_plugin.html#test_filtering). For example `gradle :tests:test --tests "your.package.name.TestClass.evenMethodName"`. Wildcard `*` may be used anywhere.
4747

4848
## Build your own `build.gradle`
4949
In Gradle, most of the tasks we use are default tasks provided by plugins in Gradle. The [`scala` Plugin](https://docs.gradle.org/current/userguide/scala_plugin.html) for example includes tasks, that are needed to build Scala projects. Moreover, Gradle is aware of *Applications*. The [`application` Plugin](https://docs.gradle.org/current/userguide/application_plugin.html) provides tasks that are required to distribute a self-contained application. When `application` and `scala` are used in conjunction, they hook into each other and provide the tasks needed to distribute a Scala application. `distTar` for example compiles the Scala code, creates a jar containing the compiled classes and resources and creates a Tarball including that jar and all of its dependencies (defined in the dependencies section of `build.gradle`). It also creates a start-script which correctly sets the classpath for all those dependencies and starts the app.
5050

51-
In OpenWhisk, we want to distribute our application via Docker images. Hence we wrote a "plugin" that creates the task `distDocker`. That task will build an image from the `Dockerfile` that is located next to the `build.gradle` it is called from, for example Controller's `Dockerfile` and `build.gradle` are both located at `core/controller`.
51+
In OpenWhisk, we want to distribute our application via Docker images. Hence, we wrote a "plugin" that creates the task `distDocker`. That task will build an image from the `Dockerfile` that is located next to the `build.gradle` it is called from, for example Controller's `Dockerfile` and `build.gradle` are both located at `core/controller`.
5252

5353
If you want to create a new `build.gradle` for your component, simply put the `Dockerfile` right next to it and include `docker.gradle` by using
5454

0 commit comments

Comments
 (0)