Merge pull request #1716

github: introduce template for issues

.github/ISSUE_TEMPLATE/10-issue_report.yaml

@@ -0,0 +1,111 @@
+name: Report a Bug
+description: |
+  You found a bug in Bareos causing the application to crash or
+  throw an exception, a component is buggy, or something looks wrong.
+labels: ["bug", "needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for using Bareos and taking the time to fill out this bug report!
+
+        If you are looking for support, please check out our documentation or consider asking a question on mailing list:
+
+          - https://doc.bareos.org/
+          - https://groups.google.com/u/1/g/bareos-users
+  - type: markdown
+    attributes:
+      value: |
+        Before filling the form fields, please consider the following:
+        - Ensure that you have searched the [existing issues](https://github.com/bareos/bareos/issues)
+        - Read the [troubleshooting guide](https://docs.bareos.org/Appendix/Troubleshooting.html)
+        - Read the [guide to filing a bug](https://docs.bareos.org/Appendix/Troubleshooting.html#bug-reports)
+
+        **What is a bug?** A bug describes an unexpected trouble with the software which
+        proves a divergence with the documentation, and/or a crash (trace) that are
+        somewhat reproducible.
+
+        We recommend to discuss your issue on the [mailing list](https://groups.google.com/u/1/g/bareos-users) first.
+  - type: textarea
+    id: bareos_version
+    attributes:
+      label: Bareos component version
+      description: Please fill the version of each Bareos component you are seeing the problem on
+      placeholder: |
+        1. bareos-fd --version
+        2. bareos-dir --version
+        3. bareos-sd --version
+        4. bconsole --version
+        5. ... `any plugins installed`
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Please tell us exactly how to reproduce the problem you are running into.
+      placeholder: |
+        1. ...
+        2. ...
+
+        Note: Please try to ensure the bug is reproducible on another system!
+
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected results
+      description: Please tell us what is expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Actual results
+      description: Please tell us what is actually happening.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **OS**: _`cat /etc/os-release`_
+          - **component**: precise plugin or tools for example, specific filesystem, etc.
+      value: |
+          - OS: ``
+          - component:
+      render: markdown
+    validations:
+      required: false
+  - type: textarea
+    id: log
+    attributes:
+      label: Relevant log output
+      description: |
+        Please include any logs or command output, they will be automatically formatted into code, so no need for backticks. If you are running any `bareos` commands, please include the output of running them with `-d 250 --dt`. For example, the output of running `bconsole -d200 --dt | tee -a /var/tmp/bconsole_debug.log`.
+
+        If the logs are too large to be uploaded to GitHub, you may upload them as a `txt` file or use online tools like https://pastebin.com to share them.
+
+        Note: Please do not upload screenshots of text. Instead, use code blocks or the above mentioned ways to upload logs.
+      render: shell
+  - type: textarea
+    id: trace
+    attributes:
+      label: Relevant traces output
+      description: |
+        Include the full trace files you will find in your working directory `/var/lib/bareos`.
+
+        While running you may want to increase the debug level of daemon you can refer to [how to setdebug level](https://docs.bareos.org/TasksAndConcepts/BareosConsole.html#bcommandsetdebug)
+        If the logs are too large to be uploaded to GitHub, you may upload them as a `txt` file or use online tools like https://pastebin.com to share them.
+
+        Note: Please do not upload screenshots of text. Instead, use code blocks or the above mentioned ways to upload traces.
+      render: shell
+  - type: textarea
+    id: supplements
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/20-feature_request.yaml

@@ -0,0 +1,56 @@
+name: Feature
+description: |
+    Suggest a new feature for next Bareos
+labels: ["enhancement", "needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for using Bareos!
+
+        If you are looking for support, please check out our documentation or consider asking a question on mailing list:
+
+          - https://doc.bareos.org/
+          - https://groups.google.com/u/1/g/bareos-users
+  - type: markdown
+    attributes:
+      value: |
+        Before filling the form fields, please consider the following:
+        - Ensure that you have searched the [existing issues](https://github.com/bareos/bareos/issues)
+        - Read the [troubleshooting guide](https://docs.bareos.org/Appendix/Troubleshooting.html)
+        - Read the [debugging chapter](https://docs.bareos.org/Appendix/Debugging.html)
+  - type: textarea
+    attributes:
+      label: Use case
+      description: |
+        Please tell us the problem you are running into that led to you wanting a new feature.
+
+        Is your feature request related to a problem? Please give a clear and concise description of what the problem is.
+
+        Describe the alternative solutions you've considered. Is there something similar that already solves this?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Proposal
+      description: |
+        Briefly but precisely describe what you would like Bareos to be able to do.
+
+        Consider attaching something showing what you are imagining:
+         * images
+         * videos
+         * code samples
+         * configuration samples
+
+        Does this have to be provided by Bareos directly, or can it be provided by a package in `bareos/contrib`? If so, maybe consider implementing and publishing such a package rather than filing an issue.
+
+        Please consult our [Developer Guide](https://docs.bareos.org/DeveloperGuide.html)
+    validations:
+      required: true
+  - type: textarea
+    id: tracking_issues
+    attributes:
+      label: Tracking Issues
+      description: List of issues associated with this feature.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+---
+blank_issues_enabled: true
+contact_links:
+  - name: Discuss a feature
+    url: 'https://github.com/bareos/bareos-testing/discussions/new?category=feature'
+    about: |
+      Start a discussion about a new feature Bareos should have
+  - name: Ask a Question
+    url: 'https://groups.google.com/u/1/g/bareos-users'
+    about: |
+      Ask a question about how to use Bareos using google groupe discussions

.github/workflows/no-response.yaml

@@ -0,0 +1,37 @@
+name: No Response
+
+# Both `issue_comment` and `scheduled` event types are required for this Action
+# to work properly.
+on:
+  issue_comment:
+    types: [created]
+  schedule:
+    # Schedule for five minutes after the hour, every 12 hours
+    - cron: '5 */12 * * *'
+
+# By specifying the access of one of the scopes, all of those that are not
+# specified are set to 'none'.
+permissions:
+  issues: write
+
+jobs:
+  noResponse:
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'bareos/bareos' }}
+    steps:
+      - uses: godofredoc/no-response@0ce2dc0e63e1c7d2b87752ceed091f6d32c9df09
+        with:
+          token: ${{ github.token }}
+          # Comment to post when closing an Issue for lack of response. Set to `false` to disable
+          closeComment: >
+            Without additional information, we are unfortunately not sure how to resolve this issue. We are therefore reluctantly going to close this bug for now.
+
+            If you find this problem please file a new issue with the same description, what happens, logs and the output of any command used.
+            [knowledge base setdebug level](https://docs.bareos.org/TasksAndConcepts/BareosConsole.html#bcommandsetdebug)
+            All system setups can be slightly different so it's always better to open new issues and reference the related ones.
+
+            Thanks for your contribution.
+          # Number of days of inactivity before an issue is closed for lack of response.
+          daysUntilClose: 45
+          # Label requiring a response.
+          responseRequiredLabel: "question"

CHANGELOG.md

@@ -59,6 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Documentation
 - docs: improvements for droplet, jobdefs [PR #1581]
 - docs: fix Pool explanation for migration jobs [PR #1728]
+- github: introduce template for issues [PR #1716]
 
 ### Fixed
 - dird: fix `purge oldest volume` [PR #1628]
@@ -117,6 +118,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [PR #1708]: https://github.com/bareos/bareos/pull/1708
 [PR #1710]: https://github.com/bareos/bareos/pull/1710
 [PR #1713]: https://github.com/bareos/bareos/pull/1713
+[PR #1716]: https://github.com/bareos/bareos/pull/1716
 [PR #1717]: https://github.com/bareos/bareos/pull/1717
 [PR #1718]: https://github.com/bareos/bareos/pull/1718
 [PR #1719]: https://github.com/bareos/bareos/pull/1719

docs/manuals/source/DeveloperGuide/developerFAQ.rst

@@ -42,7 +42,7 @@ I have changes that affect tapes and autochangers, how can I test them?
 
 In order to test tapes, we use :command:`mhvtl` to simulate the presence of tape and autochanger devices.
 
-Documentation is available at https://www.mhvtl.com/
+Documentation is available at https://sites.google.com/site/linuxvtl2/
 
 Some distributions, like openSUSE, offer mhvtl packages that you can download and install using your package manager.
 Otherwise you need to clone the mhvtl repository from https://github.com/markh794/mhvtl.git.