Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ about: Something broke or behaved differently from the docs
labels: bug
---

For security problems, [send a private report](https://github.com/jsugg/atx/security/advisories/new)
instead of using this public form.

**What happened?**

A clear description of the behavior you saw.
Expand All @@ -20,8 +23,18 @@ Minimal steps, including the exact `atx` command:
atx ...
```

**Environment**
**Diagnostics**

Run this command and paste its sanitized output:

```console
atx doctor --json
```

Use the same `--state-dir` as the failing command, if you set one.
Remove credentials, environment values and private command output.
Redact paths or user names you don't want in a public issue.

Include your OS version and `atx version` output too; doctor does not report them.

- OS and version:
- ATX version (`atx version`):
- Session or durable mode:
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Report a security problem privately
url: https://github.com/jsugg/atx/security/advisories/new
about: Send vulnerability reports privately, not in a public issue.
2 changes: 2 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Please email `juanpedrosugg+github [at] gmail [dot] com` with a short reproducti
and the affected version. Do not open a public issue for a vulnerability that could
put someone's commands, environment, or local files at risk.

You can also [send a private report through GitHub](https://github.com/jsugg/atx/security/advisories/new).

There is no guaranteed response window yet; this is a one-person side-project.
I will acknowledge a useful report as soon as I can and keep the reporter
updated while checking it.
Expand Down
7 changes: 7 additions & 0 deletions scripts/check-workflow-guards.sh
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,11 @@ if grep -Fq -- '--no-verify' .github/workflows/publish-crates-io.yml; then
exit 1
fi

require_literal .github/ISSUE_TEMPLATE/config.yml 'blank_issues_enabled: true'
require_literal .github/ISSUE_TEMPLATE/config.yml ' url: https://github.com/jsugg/atx/security/advisories/new'
require_literal .github/ISSUE_TEMPLATE/bug_report.md 'atx doctor --json'
require_literal .github/ISSUE_TEMPLATE/bug_report.md 'Remove credentials, environment values and private command output.'
require_literal .github/ISSUE_TEMPLATE/bug_report.md "Redact paths or user names you don't want in a public issue."
require_literal .github/ISSUE_TEMPLATE/bug_report.md "Include your OS version and \`atx version\` output too; doctor does not report them."

printf 'workflow-guards: PASS\n'
Loading