Skip to content

Commit

Permalink
Feat(Repo): add issue / PR template and label-commenter and close/sta…
Browse files Browse the repository at this point in the history
…le issue config (#160)

* Feat(Repo): add issue / PR template and label-commenter and close/stale issue config

* remove old close issue config

* add missing workflow for label
  • Loading branch information
stonebuzz authored Oct 4, 2024
1 parent 040f9f6 commit f389a9d
Show file tree
Hide file tree
Showing 6 changed files with 199 additions and 34 deletions.
104 changes: 104 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
name: Bug Report
description: Create a report to help us improve news
body:
- type: markdown
attributes:
value: |
Dear GLPI plugin user.
**⚠️ Please never use standard issues to report security problems. See [security policy](https://github.com/pluginsGLPI/news/security/policy) for more details. ⚠️**
BEFORE SUBMITTING YOUR ISSUE, please make sure to read and follow these steps:
* We do not track feature requests nor enhancements here. Propose them on the [suggest dedicated site](https://suggest.glpi-project.org).
* Keep this tracker in ENGLISH. If you want support in your language, the [community forum](https://forum.glpi-project.org) is the best place.
* Always try to reproduce your issue at least on latest stable release.
The GLPI team.
- type: markdown
attributes:
value: |
## Professional Support
We do not guarantee any processing / resolution time for community issues.
If you need a quick fix or any guarantee, you should consider to buy a GLPI Network Subscription.
More information here: https://glpi-project.org/subscriptions/
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow hereinabove rules and [Contribution guide](https://github.com/glpi-project/glpi/blob/main/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Code of Conduct
validations:
required: true
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
validations:
required: true
- type: input
id: glpi-version
attributes:
label: GLPI Version
description: What version of our GLPI are you running?
validations:
required: true
- type: input
id: plugin-version
attributes:
label: Plugin version
description: What version of `news` are you running?
validations:
required: true
- type: textarea
attributes:
label: Bug description
description: A concise description of the problem you are experiencing and what you expected to happen.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. Find them in `*-error.log` files under `glpi/files/_log/`.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
render: shell
- type: input
id: url
attributes:
label: Page URL
description: If applicable, page URL where the bug happens.
validations:
required: false
- type: textarea
attributes:
label: Steps To reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. With this config...
2. Go to...
3. Scroll down to...
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Your GLPI setup information
description: Please copy and paste information you will find in GLPI in `Setup > General` menu, `System` tab.
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: Add any other context about the problem here.
validations:
required: false
25 changes: 25 additions & 0 deletions .github/label-commenter-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
labels:
- name: "invalid"
labeled:
issue:
body: |
This issue has been closed because you did not provide the requested information.
action: "close"
- name: "support"
labeled:
issue:
body: |
This issue has been closed as we only track bugs here.
You can get community support on [forums](https://forum.glpi-project.org/) or you can consider [taking a subscription](https://glpi-project.org/subscriptions/) to get professional support.
You can also [contact GLPI editor team](https://portal.glpi-network.com/contact-us) directly.
action: close
- name: "feature suggestion"
labeled:
issue:
body: |
This issue has been closed as we only track bugs here.
You can open a topic to discuss with community about this enhancement on [suggestion website](https://glpi.userecho.com/).
You can also [contact GLPI editor team](https://portal.glpi-network.com/contact-us) directly if you are willing to sponsor this feature.
action: close
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Checklist before requesting a review

*Please delete options that are not relevant.*

- [ ] I have performed a self-review of my code.
- [ ] I have added tests (when available) that prove my fix is effective or that my feature works.
- [ ] This change requires a documentation update.

## Description

- It fixes # (issue number, if applicable)
- Here is a brief description of what this PR does

## Screenshots (if appropriate):

34 changes: 0 additions & 34 deletions .github/workflows/autoclose-issues.yml

This file was deleted.

35 changes: 35 additions & 0 deletions .github/workflows/close_stale_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: 'Close stale issues'
on:
schedule:
- cron: '0 8 * * *'

jobs:
stale:
if: github.repository == 'glpi-plugin/news'
permissions:
issues: write # for actions/stale to close stale issues
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
with:
stale-issue-message: >-
There has been no activity on this issue for some time and therefore it is considered stale
and will be closed automatically in 10 days.
If this issue is related to a bug, please try to reproduce on latest release. If the problem persist,
feel free to add a comment to revive this issue.
If it is related to a new feature, please open a topic to discuss with community about this enhancement
on [suggestion website](https://glpi.userecho.com/).
You may also consider taking a [subscription](https://glpi-project.org/subscriptions/) to get professionnal
support or [contact GLPI editor team](https://portal.glpi-network.com/contact-us) directly.
days-before-issue-stale: 15
days-before-pr-stale: -1 # PR will be marked as stale manually.
days-before-close: 5
exempt-issue-labels: "bug,enhancement,question,security" # Issues with "bug", "enhancement", "question" or "security" labels will not be marked as stale
exempt-all-milestones: true # Do not check issues/PR with defined milestone.
ascending: true # First check older issues/PR.
operations-per-run: 750 # Max API calls per run.
20 changes: 20 additions & 0 deletions .github/workflows/label-commenter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: "Label commenter"

on:
issues:
types:
- "labeled"
- "unlabeled"

jobs:
comment:
permissions:
contents: "read"
issues: "write"
runs-on: "ubuntu-latest"
steps:
- name: "Checkout"
uses: "actions/checkout@v4"

- name: "Label commenter"
uses: "peaceiris/actions-label-commenter@v1"

0 comments on commit f389a9d

Please sign in to comment.