Skip to content

Commit aee8243

Browse files
committed
Mention license in README + Add STRIP markers for the parts no to publish to Docker Hub
1 parent 53fbf83 commit aee8243

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,49 @@ resource contract.
7676

7777
Uploading a new OpenSSL source code tarball is not possible.
7878

79+
80+
81+
<!-- START_OF_DOCKERHUB_STRIP -->
82+
83+
## Development
84+
7985
## Build docker image
8086

8187
```
8288
docker_user=gstack
8389
docker build -t "${docker_user}/openssl-source-code-resource" .
8490
docker push ${docker_user}/openssl-source-code-resource
8591
```
92+
93+
### Running the tests
94+
95+
The tests are run by the `test` job of the concourse pipeline. You may run parts
96+
or all of the Bash script defined in `ci/settings.yml`. Pull requests are
97+
welcome for improving this, extracting the Bash script, create some Makefile and
98+
have them run locally with `make test`.
99+
100+
### Contributing
101+
102+
Please make all pull requests to the `master` branch and ensure tests pass
103+
locally.
104+
105+
When submitting a Pull Request or pushing new commits, the Concourse CI/CD
106+
pipeline provides feedback with building the Dockerfile, which implies
107+
running the tests.
108+
109+
<!-- END_OF_DOCKERHUB_STRIP -->
110+
111+
112+
113+
## Author and License
114+
115+
Copyright © 2021-present, Benjamin Gandon, Gstack
116+
117+
Like Concourse, the key-value resource is released under the terms of the
118+
[Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0).
119+
120+
<!--
121+
# Local Variables:
122+
# indent-tabs-mode: nil
123+
# End:
124+
-->

0 commit comments

Comments
 (0)