Skip to content

Commit

Permalink
Merge pull request #368 from Sonia-corporation/feature/outputs-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@C0ZEN
C0ZEN committed Jan 31, 2022
2 parents 5349bec + e6a4a80 commit ac10f62
Show file tree
Hide file tree
Showing 91 changed files with 1,224 additions and 366 deletions.
3 changes: 1 addition & 2 deletions .idea/jsLibraryMappings.xml
View file

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

1 change: 1 addition & 0 deletions .idea/modules.xml
View file

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

5 changes: 3 additions & 2 deletions .idea/stale.iml
View file

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

146 changes: 73 additions & 73 deletions README.md
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions documentation/docs/01-introduction.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,29 @@ This action will loop through your open issues and pull requests, try to ignore

### Issues {#issues}

After 30 days (coming from [issue-days-before-stale](issues/issue-days-before-stale-option)) without any update on the issue, add a label `stale` (coming from [issue-stale-label](issues/issue-stale-label-option)) on the issue to indicate that it is stale.
After 30 days (coming from [issue-days-before-stale](issues/inputs/issue-days-before-stale-input)) without any update on the issue, add a label `stale` (coming from [issue-stale-label](issues/inputs/issue-stale-label-input)) on the issue to indicate that it is stale.
If an update occur after being stale, the `stale` label will be removed and the count will be reset back to 30 days.
Removing the `stale` label manually will also do the trick.
If the `stale` label on the issue is still here for more than 10 days (coming from [issue-days-before-close](issues/issue-days-before-close-option)), the issue will be closed.
If the `stale` label on the issue is still here for more than 10 days (coming from [issue-days-before-close](issues/inputs/issue-days-before-close-input)), the issue will be closed.

### Pull requests {#pull-requests}

After 30 days (coming from [pull-request-days-before-stale](pull-requests/pull-request-days-before-stale-option)) without any update on the pull request, add a label `stale` (coming from [pull-request-stale-label](pull-requests/pull-request-stale-label-option)) on the pull request to indicate that it is stale.
After 30 days (coming from [pull-request-days-before-stale](pull-requests/inputs/pull-request-days-before-stale-input)) without any update on the pull request, add a label `stale` (coming from [pull-request-stale-label](pull-requests/inputs/pull-request-stale-label-input)) on the pull request to indicate that it is stale.
If an update occur after being stale, the `stale` label will be removed and the count will be reset back to 30 days.
Removing the `stale` label manually will also do the trick.
If the `stale` label on the pull request is still here for more than 10 days (coming from [pull-request-days-before-close](pull-requests/pull-request-days-before-close-option)), the pull request will be closed.
If the `stale` label on the pull request is still here for more than 10 days (coming from [pull-request-days-before-close](pull-requests/inputs/pull-request-days-before-close-input)), the pull request will be closed.

## Getting started {#getting-started}

If you didn't yet configure the stale action, we suggest you to start by reading the [getting started documentation](getting-started/workflow-creation).

## Issues {#issues-1}

You can also directly refer to the [issues documentation](issues/all-issues-options).
You can also directly refer to the [issues documentation](issues/inputs/all-issues-inputs).

## Pull requests {#pull-requests-1}

You can also directly refer to the [pull requests documentation](pull-requests/all-pull-requests-options).
You can also directly refer to the [pull requests documentation](pull-requests/inputs/all-pull-requests-inputs).

## Original idea {#original-idea}

Expand Down
6 changes: 3 additions & 3 deletions documentation/docs/02-getting-started/02-workflow-testing.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Before going further into the customization, you may want to try it first.

:::tip

Use the [dry-run](../dry-run-option) mode to avoid altering your repository yet.
Use the [dry-run](../dry-run-input) mode to avoid altering your repository yet.

:::

Expand All @@ -29,14 +29,14 @@ with:
:::tip

You can now check the logs, and especially the [statistics](../statistics) at the end.
You will have a better idea over what to expect when a real run without the [dry-run](../dry-run-option) mode occur.
You will have a better idea over what to expect when a real run without the [dry-run](../dry-run-input) mode occur.

:::

## Customize the behaviour {#customize-the-behaviour}

If the action was successful, you may wish now to configure it at your convenience.
Follow the [next page](../all-options) to have access to all the options.
Follow the [next page](../all-inputs) to have access to all the inputs.

:::info

Expand Down
47 changes: 47 additions & 0 deletions documentation/docs/03-all-inputs.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
id: all-inputs
title: All inputs
tags:
- Common
- Issues
- Pull requests
- Inputs
---

The list of all the inputs.

| Input | Description | Default |
| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------- |
| [github-token](github-token-input) | A GitHub token used to perform the API calls to GitHub through `@actions/github`. Usually `${{ secrets.GITHUB_TOKEN }}`. | `${{ github.token }}` |
| [dry-run](dry-run-input) | A mode where any Data Manipulation Language will be skipped. Useful to debug safely and without risking messing up with your repository. | `false` |
| [issue-stale-label](issues/inputs/issue-stale-label-input) | The label that will be added to the issue when it is stale. | `stale` |
| [issue-ignore-all-labels](issues/inputs/issue-ignore-all-labels-input) | Allow to ignore the processing of issues that contains any labels. | `false` |
| [issue-ignore-any-labels](issues/inputs/issue-ignore-any-labels-input) | Allow to ignore the processing of issues that contains one of those labels (multiline). | |
| [issue-ignore-all-assignees](issues/inputs/issue-ignore-all-assignees-input) | Allow to ignore the processing of issues that contains any assignees. | `false` |
| [issue-ignore-any-assignees](issues/inputs/issue-ignore-any-assignees-input) | Allow to ignore the processing of issues that contains one of those assignees (multiline). | |
| [issue-ignore-all-project-cards](issues/inputs/issue-ignore-all-project-cards-input) | Allow to ignore the processing of issues that contains any project cards. | `false` |
| [issue-ignore-before-creation-date](issues/inputs/issue-ignore-before-creation-date-input) | Allow to ignore the processing of issues that were created before this date ([ISO 8601](https://moment.github.io/luxon/#/parsing?id=iso-8601)). | |
| [issue-days-before-stale](issues/inputs/issue-days-before-stale-input) | The number of days until the issue is considered as stale. | `30` |
| [issue-stale-comment](issues/inputs/issue-stale-comment-input) | The comment that will be sent once the issue is stale (keep empty to not send a comment). | |
| [issue-days-before-close](issues/inputs/issue-days-before-close-input) | The number of days until a stale issue is considered as closed. | `10` |
| [issue-close-comment](issues/inputs/issue-close-comment-input) | The comment that will be sent once the issue is close (keep empty to not send a comment). | |
| [issue-add-labels-after-stale](issues/inputs/issue-add-labels-after-stale-input) | A list of labels added when the processing stale the issue (multiline). | |
| [issue-add-labels-after-close](issues/inputs/issue-add-labels-after-close-input) | A list of labels added when the processing close the issue (multiline). | |
| [issue-processing](issues/inputs/issue-processing-input) | Allow to process the issues. | `true` |
| [pull-request-stale-label](pull-requests/inputs/pull-request-stale-label-input) | The label that will be added to the pull request when it is stale. | `stale` |
| [pull-request-ignore-all-labels](pull-requests/inputs/pull-request-ignore-all-labels-input) | Allow to ignore the processing of pull requests that contains any labels. | `false` |
| [pull-request-ignore-any-labels](pull-requests/inputs/pull-request-ignore-any-labels-input) | Allow to ignore the processing of pull requests that contains one of those labels (multiline). | |
| [pull-request-ignore-all-assignees](pull-requests/inputs/pull-request-ignore-all-assignees-input) | Allow to ignore the processing of pull requests that contains any assignees. | `false` |
| [pull-request-ignore-any-assignees](pull-requests/inputs/pull-request-ignore-any-assignees-input) | Allow to ignore the processing of pull requests that contains one of those assignees (multiline). | |
| [pull-request-ignore-all-project-cards](pull-requests/inputs/pull-request-ignore-all-project-cards-input) | Allow to ignore the processing of pull requests that contains any project cards. | `false` |
| [pull-request-ignore-before-creation-date](pull-requests/inputs/pull-request-ignore-before-creation-date-input) | Allow to ignore the processing of pull requests that were created before this date ([ISO 8601](https://moment.github.io/luxon/#/parsing?id=iso-8601)). | |
| [pull-request-ignore-draft](pull-requests/inputs/pull-request-ignore-draft-input) | Allow to ignore the processing of pull requests that are drafts. | `false` |
| [pull-request-days-before-stale](pull-requests/inputs/pull-request-days-before-stale-input) | The number of days until the pull request is considered as stale. | `30` |
| [pull-request-stale-comment](pull-requests/inputs/pull-request-stale-comment-input) | The comment that will be sent once the pull request is stale (keep empty to not send a comment). | |
| [pull-request-days-before-close](pull-requests/inputs/pull-request-days-before-close-input) | The number of days until a stale pull request is considered as closed. | `10` |
| [pull-request-close-comment](pull-requests/inputs/pull-request-close-comment-input) | The comment that will be sent once the pull request is close (keep empty to not send a comment). | |
| [pull-request-delete-branch-after-close](pull-requests/inputs/pull-request-delete-branch-after-close-input) | Delete the branch when the processing close the pull request. | `false` |
| [pull-request-add-labels-after-stale](pull-requests/inputs/pull-request-add-labels-after-stale-input) | A list of labels added when the processing stale the pull request (multiline). | |
| [pull-request-add-labels-after-close](pull-requests/inputs/pull-request-add-labels-after-close-input) | A list of labels added when the processing close the pull request (multiline). | |
| [pull-request-processing](pull-requests/inputs/pull-request-processing-input) | Allow to process the pull requests. | `true` |
| [pull-request-to-draft-instead-of-stale](pull-requests/inputs/pull-request-to-draft-instead-of-stale-input) | Convert the pull request to a draft pull request instead of handling it as a stale candidate. | `false` |
Loading

0 comments on commit ac10f62

Please sign in to comment.