Skip to content

Commit

Permalink
Add working Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
guilhem committed May 18, 2020
1 parent 25fc9da commit 92679b6
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# RSS issues action

This action create issues from a syndication feed (RSS or Atom).

## Inputs

### `repo-token`

**Required** the GITHUB_TOKEN secret.

### `feed`

**Required** URL of the rss.

### `prefix`

Prefix added to issues.

### `lastTime`

Limit items date.

### `labels`

"Labels to add, comma separated".

## Outputs

### `issues`

Issues id, comma separated.

## Example

### step

```yaml
uses: guilhem/rss-issues-action
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
feed: "https://cloud.google.com/feeds/kubernetes-engine-release-notes.xml"
```
### complete
```yaml
name: rss

on:
schedule:
- cron: "0 * * * *"

jobs:
gke-release:
runs-on: ubuntu-latest
steps:
- uses: guilhem/[email protected]
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
feed: "https://cloud.google.com/feeds/kubernetes-engine-release-notes.xml"
prefix: "[GKE]"
dry-run: "false"
lastTime: "92h"
labels: "liens/Kubernetes"
```
### Real Usage
- [Create information feed](https://github.com/p7t/actus/issues)

0 comments on commit 92679b6

Please sign in to comment.