Skip to content

Commit

Permalink
Docs/improve documentation format (#516)
Browse files Browse the repository at this point in the history
* docs: improve documenation format

* docs: fix couple typos

* docs: break line

---------

Co-authored-by: Ana Lemos <anapaulalazzarottodelemos@Anas-MacBook-Pro.local>
  • Loading branch information
anapaulalemos and Ana Lemos committed Apr 21, 2023
1 parent 60d664e commit 77cb31f
Showing 1 changed file with 16 additions and 32 deletions.
48 changes: 16 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,25 @@ GitHub Action that automatically creates an issue with an overview of the commit
## Permissions

This action requires the following permissions:

```
permissions:
issues: write
contents: read
```
- `issues: write`
- `contents: read`

💡 `contents:read` is required because the action is using a `actions/checkout@v3` action to download the repository content.

## Usage

Configure this action in your workflows providing the inputs described below in order to get notified in `x` time after the repo has been updated but no release has happened.

It is possible to snooze the notification issue for `x` time by closing it as **not planned**. Once the time has passed a new issue will be created.

## Inputs

| inputs | required | default | description |
|--------------------------|----------|-----------------------|-------------|
| `github-token` | no | `${{ github.token }}` | A github token. |
| `notify-after` | no | | The time after which unreleased commits should be considered stale and should notify for a release.<br />This option accepts various time formats as described by the time conversion library [ms](https://github.com/vercel/ms). |
| `stale-days` | no | `7` | ⚠️ **Deprecated** ⚠️ Number of days of inactivity before a release becomes stale. The value can be a number or a string. |
| `commit-messages-lines` | no | `1` | Limit the number of first `x` lines from commit messages that will be added in the issue description. No truncation when set to `0`. |

## Example

Expand All @@ -37,29 +47,3 @@ jobs:
- name: Notify release
uses: nearform-actions/github-action-notify-release@v1
```

## Usage

Configure this action in your workflows providing the inputs described below in order to get notified in `x` time after the repo has been updated but no release has happened.
It is possible to snooze the notification issue for `x` time by closing it as **not planned**. Once the time has passed a new issue will be created.

### `github-token`

**Optional** A GitHub token.

### `notify-after: '7 days'`

**Optional** The time after which unreleased commits should be considered stale and should notify for a release.
This option accepts various time formats as described by the time conversion library [ms](https://github.com/vercel/ms).
Example: `1 minute`.
Default is `7 days`.

### **Deprecated** `stale-days: 7`

**Optional** The time after which unreleased commits should be considered stale and should notify for a release. The value can be a number or a string.
Example: `1 minute`.
Default is `7` days.

### `commit-messages-lines: 1`

**Optional** Limit the number of first `x` lines from commit messages that will be added in the issue description. No truncation when set to `0`. Default is `1`.

0 comments on commit 77cb31f

Please sign in to comment.