Skip to content

Commit

Permalink
Refine README and labels, add LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
ArnaudRinquin committed Feb 12, 2019
1 parent af4a04b commit 884954b
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 29 deletions.
2 changes: 2 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
test
node_modules
21 changes: 10 additions & 11 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
FROM debian:8.11

ENV VERSION 0.6.0
LABEL name="git-crypt-unlock"
LABEL version="1.0.0"
LABEL maintainer="Arnaud Rinquin <[email protected]>"
LABEL com.github.actions.name="GitHub Action to unlock git-crypt secrets"
LABEL com.github.actions.description="Unlock secrets using git-crypt from encoded secret-key"
LABEL com.github.actions.icon="unlock"
LABEL com.github.actions.color="green"

ENV GIT_CRYPT_VERSION 0.6.0

# Dependencies from https://github.com/AGWA/git-crypt/blob/master/INSTALL.md#dependencies
RUN apt-get update && apt-get install -y \
Expand All @@ -21,13 +29,4 @@ ADD entrypoint.sh /entrypoint.sh

ENTRYPOINT ["/entrypoint.sh"]

LABEL \
org.label-schema.name="github-action-git-crypt-unlock" \
org.label-schema.description="Github Action to unlock git-crypt secrets." \
org.label-schema.usage="https://github.com/slite/slite/tools/github-actions/git-crypt-unlock/README.md" \
org.label-schema.vcs-url="https://github.com/slite/slite/tools/github-actions/git-crypt-unlock" \
org.label-schema.docker.schema-version="1.0" \
com.github.actions.name="git-crypt unlock" \
com.github.actions.description="Unlock secrets using git-crypt" \
com.github.actions.icon="unlock" \
com.github.actions.color="green"

19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2019 Slite Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ There are few dependencies

- git-crypt
- docker
- node (for npm script convenience)
- node (for npm script convenience and [gha](https://github.com/tschoffelen/gha) dependency)

Run tests using `npm test`
### Running tests

```
npm install
npm test
```
54 changes: 40 additions & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "github-action-git-crypt-unlock",
"version": "0.0.0",
"version": "1.0.0",
"private": true,
"description": "Github Action to unlock file with git-crypt",
"scripts": {
Expand All @@ -24,4 +24,4 @@
"devDependencies": {
"gha": "^1.1.0"
}
}
}

0 comments on commit 884954b

Please sign in to comment.