Skip to content

Commit a837c7f

Browse files
committed
docs: issue forms for wrong cells and advisories
1 parent d4b39d3 commit a837c7f

5 files changed

Lines changed: 148 additions & 2 deletions

File tree

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Report a break (advisory)
2+
description: A toolchain release broke existing NativeScript releases and people should be warned.
3+
title: "[advisory] <toolchain> <version> breaks <package> <versions>"
4+
labels: ["advisory"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
A confirmed advisory becomes a file under `data/overrides/` and shows up on the site and in `ns doctor` for everyone on the affected versions.
10+
- type: input
11+
id: package
12+
attributes:
13+
label: Affected package and versions
14+
description: A semver range of the releases that break.
15+
placeholder: "@nativescript/ios <9.2.0"
16+
validations:
17+
required: true
18+
- type: input
19+
id: condition
20+
attributes:
21+
label: Toolchain condition
22+
description: Which toolchain versions trigger it, as a range.
23+
placeholder: "Xcode >=27"
24+
validations:
25+
required: true
26+
- type: dropdown
27+
id: severity
28+
attributes:
29+
label: Severity
30+
options:
31+
- Builds fail (error)
32+
- Builds succeed but something is broken (warning)
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: what
37+
attributes:
38+
label: What happens
39+
description: The error or misbehaviour, with the exact message where there is one.
40+
validations:
41+
required: true
42+
- type: input
43+
id: fix
44+
attributes:
45+
label: Known fix or workaround
46+
placeholder: "Update to @nativescript/ios 9.2.0"
47+
- type: input
48+
id: link
49+
attributes:
50+
label: Related issue or discussion
51+
placeholder: "https://github.com/NativeScript/ios/issues/…"
52+
- type: textarea
53+
id: environment
54+
attributes:
55+
label: Environment
56+
description: Output of `ns doctor --markdown` or `npx nativescript-envinfo`.
57+
render: markdown

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: The compatibility matrix
4+
url: https://compatibility.nativescript.org
5+
about: The live site this repository produces.
6+
- name: NativeScript CLI issues
7+
url: https://github.com/NativeScript/nativescript-cli/issues
8+
about: Problems with ns doctor, builds or the CLI itself belong there.
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Wrong compatibility data
2+
description: A cell on compatibility.nativescript.org does not match reality.
3+
title: "[data] <package> <version> with <toolchain> <version>"
4+
labels: ["data"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks. A confirmed report becomes a file under `data/overrides/` or `data/verified/`, so the more precise the versions, the faster it lands.
10+
- type: dropdown
11+
id: package
12+
attributes:
13+
label: Package
14+
options:
15+
- "@nativescript/ios"
16+
- "@nativescript/android"
17+
- "@nativescript/visionos"
18+
- "nativescript (CLI)"
19+
validations:
20+
required: true
21+
- type: input
22+
id: version
23+
attributes:
24+
label: Package version
25+
placeholder: "9.1.0"
26+
validations:
27+
required: true
28+
- type: dropdown
29+
id: toolchain
30+
attributes:
31+
label: Toolchain
32+
options:
33+
- Xcode
34+
- CocoaPods
35+
- Android compile SDK
36+
- Android build-tools
37+
- JDK
38+
- Node.js
39+
validations:
40+
required: true
41+
- type: input
42+
id: toolchain-version
43+
attributes:
44+
label: Toolchain version
45+
placeholder: "26.4, 37, 21, 24.2.0…"
46+
validations:
47+
required: true
48+
- type: dropdown
49+
id: shown
50+
attributes:
51+
label: What the site shows
52+
options:
53+
- Verified by CI
54+
- Declared
55+
- Unverified
56+
- Advisory
57+
- Unsupported
58+
validations:
59+
required: true
60+
- type: dropdown
61+
id: reality
62+
attributes:
63+
label: What is actually true
64+
options:
65+
- It builds and runs fine
66+
- The build fails
67+
- It builds but the app misbehaves at runtime
68+
validations:
69+
required: true
70+
- type: textarea
71+
id: evidence
72+
attributes:
73+
label: Evidence
74+
description: The failing command and its error, a CI run, or anything else that shows the outcome. Paste logs as-is.
75+
render: shell
76+
- type: textarea
77+
id: environment
78+
attributes:
79+
label: Environment
80+
description: Output of `ns doctor --markdown` (NativeScript CLI 9.2 or newer) or `npx nativescript-envinfo`.
81+
render: markdown

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ metadata, CI builds and maintainer advisories, serves it as JSON for tools such
1111
as [`ns doctor`](https://github.com/NativeScript/nativescript-cli), and renders
1212
it as a browser-support-style matrix for people.
1313

14-
Found a wrong cell? [Open an issue](https://github.com/NativeScript/compatibility/issues/new).
14+
Found a wrong cell? [Open an issue](https://github.com/NativeScript/compatibility/issues/new/choose).
1515
Toolchain requirements for a runtime belong in its `package.json` (see below);
1616
everything else lives in [`data/`](data).
1717

‎web/src/App.vue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ function label(key: string): string {
4848
verification runs and maintainer advisories. Click a cell for the version-by-version picture.
4949
</p>
5050
<nav class="mt-2 flex flex-wrap gap-x-4 gap-y-1 text-sm">
51-
<a class="text-declared hover:underline" href="https://github.com/NativeScript/compatibility/issues/new">Report a problem</a>
51+
<a class="text-declared hover:underline" href="https://github.com/NativeScript/compatibility/issues/new/choose">Report a problem</a>
5252
<a class="text-declared hover:underline" href="https://github.com/NativeScript/compatibility">Data on GitHub</a>
5353
<a class="text-declared hover:underline" href="/v1/compatibility.json">JSON</a>
5454
<a class="text-declared hover:underline" href="/v1/schemas/package.json">Schema</a>

0 commit comments

Comments
 (0)