Skip to content

Commit

Permalink
license and readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
craig-day committed Mar 27, 2020
1 parent 6d50298 commit b62df88
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 9 deletions.
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2020, Craig Day
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ in your workflow you need to do the following things:

```yaml
- id: find_digest
uses: zendesk/fetch-build-from-gcb
uses: craig-day/fetch-build-from-gcb@v1
with:
build_url: ${{ github.event.path-to-build-url }}
target_image: my-app
Expand All @@ -44,7 +44,7 @@ in your workflow you need to do the following things:

## Usage

### With a repo mirrored to GCR and GCB webhooks
### With a repo mirrored to GCR and gets `status` GCB webhooks

If your repository is mirrored into GCR and the build information appears on your repository with
a PR status from `docker-images-180022`, then you need to have your workflow response to `status`
Expand All @@ -71,7 +71,7 @@ jobs:
GOOGLE_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
- id: find_digest
uses: zendesk/fetch-build-from-gcb
uses: craig-day/fetch-build-from-gcb@v1
with:
build_url: ${{ github.event.target_url }}
target_image: my-app
Expand All @@ -86,7 +86,7 @@ jobs:
IMAGE_DIGEST: ${{ steps.find_digest.outputs.digest }}
```

### With a repo connected to the GCB app and GCB check runs
### With a repo connected to the GCB app and gets GCB `check_run`s

If your repository is connected to the GCB app and the build information appears on your repository
with a PR status from `Google Cloud Build`, then you need to have your workflow response to
Expand Down Expand Up @@ -116,7 +116,7 @@ jobs:
GOOGLE_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
- id: find_digest
uses: zendesk/fetch-build-from-gcb
uses: craig-day/fetch-build-from-gcb@v1
with:
build_url: ${{ github.event.check_run.details_url }}
target_image: fun-app
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/zendesk/fetch-build-from-gcb.git"
"url": "git+https://github.com/craig-day/fetch-build-from-gcb.git"
},
"author": "Craig Day",
"license": "private",
"license": "BSD-3-Clause",
"bugs": {
"url": "https://github.com/zendesk/fetch-build-from-gcb/issues"
"url": "https://github.com/craig-day/fetch-build-from-gcb/issues"
},
"homepage": "https://github.com/zendesk/fetch-build-from-gcb#readme",
"homepage": "https://github.com/craig-day/fetch-build-from-gcb#readme",
"dependencies": {
"@actions/core": "^1.2.3",
"google-auth-library": "^6.0.0"
Expand Down

0 comments on commit b62df88

Please sign in to comment.