From 6d437f7d3efaa2bb3b160c0d99de4bc1a3d78573 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Wed, 30 Mar 2022 14:32:14 -0400 Subject: [PATCH 1/4] feat: create issue template for project --- .github/ISSUE_TEMPLATE/bug_report.yaml | 60 ++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..d0355f10b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,60 @@ +--- +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["needs: investigation", "type: bug"] +body: + - type: markdown + attributes: + value: | + If you need help figuring out how to use a specific buildpack, are seeing an issue in during the buildpack process, or are having issues using multiple buildpacks, please see our chat channels or github discussion board. Issues pertaining to buildpacks may be closed and locked. + - type: textarea + id: description + attributes: + label: Description of problem + description: What happened? What did you expect to happen? + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: What are the steps that we need to follow to reproduce this issue? + validations: + required: true + - type: textarea + id: report-output + attributes: + label: dokku report $APP_NAME + description: Please paste the output of the command `dokku report $APP_NAME`, where `$APP_NAME` is the name of your app + validations: + required: true + - type: textarea + id: report-output + attributes: + label: Additional information + description: | + This information is useful for debugging app issues: + + - Container Inspect Output (if applicable) via `dokku ps:inspect APP_NAME` + - The nginx configuration (if applicable) via `dokku nginx:show-config APP_NAME` + - Link to the exact repository being deployed (if possible/applicable) + + If a deploy is failing or behaving unexpectedly: + + - Application name + - The type of application being deployed (node, php, python, ruby, etc.) + - If using buildpacks, which custom buildpacks are in use + - If using a Dockerfile, the contents of that file + - If it exists, the contents of your Procfile. + validations: + required: false + - type: textarea + id: logs + attributes: + label: Output of failing Dokku commands after running `dokku trace:on` + description: | + BEWARE: `dokku trace:on` will cause some commands to print environment variables, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXX + render: shell + validations: + required: false From a6cc44d507ed0b471a4249416e0493782e363888 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 1 Apr 2022 19:32:00 -0400 Subject: [PATCH 2/4] Update bug_report.yaml --- .github/ISSUE_TEMPLATE/bug_report.yaml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index d0355f10b..aa2239398 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,13 +1,8 @@ --- name: Bug Report description: File a bug report -title: "[Bug]: " labels: ["needs: investigation", "type: bug"] body: - - type: markdown - attributes: - value: | - If you need help figuring out how to use a specific buildpack, are seeing an issue in during the buildpack process, or are having issues using multiple buildpacks, please see our chat channels or github discussion board. Issues pertaining to buildpacks may be closed and locked. - type: textarea id: description attributes: @@ -30,7 +25,7 @@ body: validations: required: true - type: textarea - id: report-output + id: additional-output attributes: label: Additional information description: | @@ -52,9 +47,16 @@ body: - type: textarea id: logs attributes: - label: Output of failing Dokku commands after running `dokku trace:on` - description: | - BEWARE: `dokku trace:on` will cause some commands to print environment variables, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXX + label: "Output of failing commands after running: dokku trace:off" + render: shell + validations: + required: false + - type: textarea + id: trace-logs + attributes: + label: "Output of failing commands after running: dokku trace:on" + description: | + **BEWARE**: `dokku trace:on` will cause some commands to print environment variables, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXX render: shell validations: required: false From 2b4c3d4df1181556a43166e314c4abb7d39b89d5 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 1 Apr 2022 19:32:26 -0400 Subject: [PATCH 3/4] Create buildpack_issue.yaml --- .github/ISSUE_TEMPLATE/buildpack_issue.yaml | 71 +++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/buildpack_issue.yaml diff --git a/.github/ISSUE_TEMPLATE/buildpack_issue.yaml b/.github/ISSUE_TEMPLATE/buildpack_issue.yaml new file mode 100644 index 000000000..078bda0ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/buildpack_issue.yaml @@ -0,0 +1,71 @@ +--- +name: Buildpack Issue +description: Is your deploy failing while building your application using buildpacks? Check this out. +labels: ["upstream: buildpacks"] +body: + - type: markdown + attributes: + value: | + If your build is stuck downloading something, compiling a file, or seems to always fail around the same area, Github Issues is not a great place to debug. This is because these sorts of issues tend to take a lot of back and forth to figure out, and the code for buildpacks is not generally maintained by the Dokku project. + +
+ Debugging tips: + + - If you see text that says `Killed` in your output, attempt to increase free memory by using a larger server or [add swap memory](https://dokku.com/docs/getting-started/troubleshooting/#build-fails-with-killed-message). + - Turn on buildpack trace mode via `dokku config:set $APP_NAME BUILDPACK_XTRACE=1` and retry your deploy. Not all buildpacks support this, but many will output extra debugging information. + - Your hosting provider may have issues accessing AWS S3. Verify a slow/stalled download works by directly curling the file from your host. + - Many buildpacks allow downloading a file from an alternative location specified via environment variable. + - [Increase curl timeouts](https://dokku.com/docs/getting-started/troubleshooting/#deployment-fails-because-of-slow-internet-connection-messages-s) if you see gzip download issues. + - If using multi-buildpack support but a buildpack is failing to apply, ensure you have any files necessary for the `bin/detect` script of the buildpack to `exit 0`. Selected buildpacks must still pass the detection phase in order to be used. +
+ + If you are still having issues, file a ticket here and then further discussing the ticket in one of our [Monitored Support Channels](https://dokku.com/docs/getting-started/where-to-get-help/#monitored-locations) (Discord, Github Discussions, Slack). Your filed ticket may be closed or locked, but any subsequent discovery will be posted to the ticket for posterity. + - type: textarea + id: description + attributes: + label: Description of problem + description: What happened? What did you expect to happen? + validations: + required: true + - type: textarea + id: report-output + attributes: + label: dokku report $APP_NAME + description: Please paste the output of the command `dokku report $APP_NAME`, where `$APP_NAME` is the name of your app. + validations: + required: true + - type: textarea + id: additional-output + attributes: + label: Additional information + description: | + This information is useful for debugging app issues: + + - Container Inspect Output (if applicable) via `dokku ps:inspect APP_NAME` + - The nginx configuration (if applicable) via `dokku nginx:show-config APP_NAME` + - Link to the exact repository being deployed (if possible/applicable) + + If a deploy is failing or behaving unexpectedly: + + - Application name + - The type of application being deployed (node, php, python, ruby, etc.) + - If using buildpacks, which custom buildpacks are in use + - If it exists, the contents of your Procfile. + validations: + required: true + - type: textarea + id: logs + attributes: + label: "Output of failing deploy after running: dokku trace:off" + render: shell + validations: + required: true + - type: textarea + id: trace-logs + attributes: + label: "Output of failing deploy after running: dokku trace:on" + description: | + **BEWARE**: `dokku trace:on` will cause some commands to print environment variables, be sure you're not exposing any sensitive information when posting issues. You may replace these values with XXXXXX + render: shell + validations: + required: true From 699e6f3be6753747165d59f27605cb68f7ae96c5 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 1 Apr 2022 19:32:41 -0400 Subject: [PATCH 4/4] Create feature_request.yaml --- .github/ISSUE_TEMPLATE/feature_request.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000..d15e3dd52 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,16 @@ +--- +name: Feature Request +description: Have an idea for a new feature? Ask away! +labels: ["needs: plan", "type: enhancement"] +body: + - type: markdown + attributes: + value: | + > While pull requests are always welcome, feel free to fill this out with an idea of what you would like to happen and we can discuss if and how it should be implemented in Dokku. + - type: textarea + id: description + attributes: + label: Description of feature + description: When you perform what command or action, what do you think should happen? + validations: + required: true