diff options
| author | JakobDev <jakobdev@gmx.de> | 2023-03-28 20:22:07 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-28 14:22:07 -0400 |
| commit | f384b13f1cd44be3a87df5553a0099390dacd010 (patch) | |
| tree | 08b2744df3a8792ef2f50e4d559d55e4a349c198 /docs | |
| parent | 5cd1d6c93ba9b8399f826e671b8940eb5294b872 (diff) | |
| download | gitea-f384b13f1cd44be3a87df5553a0099390dacd010.tar.gz gitea-f384b13f1cd44be3a87df5553a0099390dacd010.zip | |
Implement Issue Config (#20956)
Closes #20955
This PR adds the possibility to disable blank Issues, when the Repo has
templates. This can be done by creating the file
`.gitea/issue_config.yaml` with the content `blank_issues_enabled` in
the Repo.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/doc/usage/issue-pull-request-templates.en-us.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/content/doc/usage/issue-pull-request-templates.en-us.md b/docs/content/doc/usage/issue-pull-request-templates.en-us.md index 0cf63625b6..f36037956a 100644 --- a/docs/content/doc/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/doc/usage/issue-pull-request-templates.en-us.md @@ -50,6 +50,17 @@ Possible file names for issue templates: - `.github/issue_template.yaml` - `.github/issue_template.yml` +Possible file names for issue config: + +- `.gitea/ISSUE_TEMPLATE/config.yaml` +- `.gitea/ISSUE_TEMPLATE/config.yml` +- `.gitea/issue_template/config.yaml` +- `.gitea/issue_template/config.yml` +- `.github/ISSUE_TEMPLATE/config.yaml` +- `.github/ISSUE_TEMPLATE/config.yml` +- `.github/issue_template/config.yaml` +- `.github/issue_template/config.yml` + Possible file names for PR templates: - `PULL_REQUEST_TEMPLATE.md` @@ -267,3 +278,30 @@ For each value in the options array, you can set the following keys. |----------|------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|---------|---------| | label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | + +## Syntax for issue config + +This is a example for a issue config file + +```yaml +blank_issues_enabled: true +contact_links: + - name: Gitea + url: https://gitea.io + about: Visit the Gitea Website +``` + +### Possible Options + +| Key | Description | Type | Default | +|----------------------|-------------------------------------------------------------------------------------------------------|--------------------|----------------| +| blank_issues_enabled | If set to false, the User is forced to use a Template | Boolean | true | +| contact_links | Custom Links to show in the Choose Box | Contact Link Array | Empty Array | + +### Contact Link + +| Key | Description | Type | Required | +|----------------------|-------------------------------------------------------------------------------------------------------|---------|----------| +| name | the name of your link | String | true | +| url | The URL of your Link | String | true | +| about | A short description of your Link | String | true | |