Skip to contentSkip to conversation

GitHub Issues Usage

PATCH In review Frank Lichtenheld 2 participants 7 messages Nov 30, 2022

lore
Share & tools
lore
#0 lore raw

cover GitHub Issues Usage

At the Hackathon in Delft we decided to switch to GitHub Issues since the old Trac system will need to be replaced.

GitHub issues have the main advantage that many other projects are also on GitHub. So apart from being familiar to users we also have the ability to link to other projects or move issues over to them if applicable.

This patch series adds a first issue template for our use and does various documentation updates.

Frank Lichtenheld (3):
GitHub Issues: Create first issue template (Bug) GitHub Issues: add new links to INSTALL and README GitHub Issues: add note to Changes as well

 .github/ISSUE_TEMPLATE/bug_report.md | 25 +++++++++++++++++++++++++
 Changes.rst                          |  6 ++++++
 INSTALL                              |  4 +++-
 README                               |  5 ++++-
 4 files changed, 38 insertions(+), 2 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
Signature · 1 line
2.34.1
#1 lore raw

PATCH 1/3 GitHub Issues: Create first issue template (Bug)

If we want people to use GH issues, we should
probably offer some issue templates to give
guidance on what to include.

Based on GH's standard bug template.

---
 .github/ISSUE_TEMPLATE/bug_report.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/bug_report.md new file +25 -0
new file mode 100644
index 00000000..6cbd3ba4
@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior. Please make sure to not post any secrets like keys and passwords.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Version information (please complete the following information):**
+ - OS: [e.g. Ubuntu 22.04]
+ - OpenVPN version: [e.g. 2.5.8]
+ - Repeat for peer if relevant
+
+**Additional context**
+Add any other context about the problem here.
Signature · 1 line
2.34.1
#3 lore raw

PATCH 2/3 GitHub Issues: add new links to INSTALL and README

In reply to Frank Lichtenheld

But keep the old links around as well for now since the GitHub issues aren't useful, yet.

---
 INSTALL | 4 +++-
 README  | 5 ++++-
 2 files changed, 7 insertions(+), 2 deletions(-)
INSTALL +3 -1
index db24e98c..a63bab6a 100644
@@ -276,6 +276,8 @@ TUN/TAP Driver References:
 
 CAVEATS & BUGS:
 
-* see the bug tracker on https://community.openvpn.net/openvpn/report
+* See the bug tracker on https://github.com/OpenVPN/openvpn/issues
   and the wiki on https://community.openvpn.net/wiki for more detailed
   caveats on operating systems, and for open and resolved bug reports.
+* Note: We only recently switched to GitHub for reporting new issues,
+  old issues can be found at https://community.openvpn.net/openvpn/report
README +4 -1
index 523abb70..04eb16ff 100644
@@ -30,7 +30,10 @@ For a sample VPN configuration, see
   http://openvpn.net/howto.html
 
 To report an issue, see
-  https://community.openvpn.net/openvpn/newticket
+  https://github.com/OpenVPN/openvpn/issues/new
+  (Note: We recently switched to GitHub for reporting new issues,
+   old issues can be found at:
+   https://community.openvpn.net/openvpn/report)
 
 For a description of OpenVPN's underlying protocol,
   see the file ssl.h included in the source distribution.
Signature · 1 line
2.34.1
#5 lore raw

PATCH 3/3 GitHub Issues: add note to Changes as well

In reply to Frank Lichtenheld

For maximum visibility.

---
 Changes.rst | 6 ++++++
 1 file changed, 6 insertions(+)
Changes.rst +6 -0
index 11652b85..fe91ece2 100644
@@ -1,6 +1,12 @@
 Overview of changes in 2.6
 ==========================
 
+Project changes
+---------------
+
+We want to deprecate our old Trac bug tracking system.
+Please report any issues with this release in GitHub
+instead: https://github.com/OpenVPN/openvpn/issues
 
 New features
 ------------
Signature · 1 line
2.34.1
Acked-by on v1 3/3
#6 lore raw

[Openvpn-devel] [PATCH applied] Re: GitHub Issues: add note to Changes as well

Your patch has been applied to the master branch.

commit cf884bebe15e802256ed6edfabf925bf4b97bdef

Author: Frank Lichtenheld
Date:   Wed Nov 30 14:31:54 2022 +0100
     GitHub Issues: add note to Changes as well

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg25590.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

Acked-by on v1 2/3
#4 lore raw

[Openvpn-devel] [PATCH applied] Re: GitHub Issues: add new links to INSTALL and README

In reply to Frank Lichtenheld

Your patch has been applied to the master branch.

commit 48490cd137317e94d0df047be53d0b3cc2a06ed0

Author: Frank Lichtenheld
Date:   Wed Nov 30 14:31:53 2022 +0100
     GitHub Issues: add new links to INSTALL and README

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg25591.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

#2 lore raw

[Openvpn-devel] [PATCH applied] Re: GitHub Issues: Create first issue template (Bug)

In reply to Frank Lichtenheld

Your patch has been applied to the master branch.

commit 816eae83a57df4fa3ffd49b1794779ae9054a6ee

Author: Frank Lichtenheld
Date:   Wed Nov 30 14:31:52 2022 +0100
     GitHub Issues: Create first issue template (Bug)

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg25589.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering