Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sergeysova committed Jan 31, 2021
1 parent 2d33dfc commit 0c01410
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM node:latest
FROM node:14-alpine

WORKDIR /bot

Expand Down
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

The MIT License (MIT)

Copyright (c) 2020 Sergey Sova

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.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Gist-Write v1

The action to write content to a gist from an input.

See also [gist-read](https://github.com/sergeysova/gist-read-action).

## Usage

See [action.yml](./action.yml)

## Examples

Simple (just write content from input to a file to a gist):

```yaml
steps:
- uses: sergeysova/gist-write-action@v1
with:
gist_id: 7bcddb642d16d291959642fc60feec9b
file_name: example.txt
content: "100"
```
Increment counter (read value from a gist, increment it, write to the gist):
```yaml
steps:
- uses: sergeysova/gist-read-action@v1
id: counter
with:
gist_id: 7bcddb642d16d291959642fc60feec9b
file_name: example.txt

- name: Increment
id: increment
run: |
export COUNTER=${{steps.counter.outputs.content}}
echo "::set-output name=value::$((COUNTER + 1))"
- uses: sergeysova/gist-write-action@v1
with:
gist_id: 7bcddb642d16d291959642fc60feec9b
file_name: example.txt
content: ${{steps.increment.outputs.value}}
```
## License
The scripts and documentation in this project are released under the [MIT License](./LICENSE)
10 changes: 7 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
name: "sergeysova-gist-write"
description: "Action to write data to gist"
name: "Gist Write Action"
author: Sergey Sova
description: "The action to write content to a gist"
inputs:
gist_id:
description: "Gist ID"
required: true
file_name:
description: "File name at the gist to write data at"
description: "Name of the file at the gist to write data at"
required: true
content:
description: "Content to write"
Expand All @@ -16,3 +17,6 @@ outputs:
runs:
using: "docker"
image: "Dockerfile"
branding:
color: blue
icon: upload-cloud

0 comments on commit 0c01410

Please sign in to comment.