Skip to content

Commit ab32175

Browse files
committed
Add nightly build instllation instructions
1 parent 65f87ab commit ab32175

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

Diff for: README.md

+14
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,24 @@
99
- Sketches
1010
- Libraries
1111

12+
## Documentation
13+
1214
For usage instructions, see [the documentation](https://arduino.github.io/arduino-lint/latest/)
1315

1416
## Continuous Integration
1517

1618
There is a GitHub Actions action that makes it easy to use **arduino-lint**` in your CI workflows!
1719

1820
See https://github.com/arduino/arduino-lint-action for more information.
21+
22+
## How to contribute
23+
24+
Contributions are welcome!
25+
26+
Please see the [How to contribute](https://arduino.github.io/arduino-lint/latest/CONTRIBUTING/) page for information on
27+
building the source code, running tests, and contributing your changes to the project.
28+
29+
### Beta testing
30+
31+
[Nightly builds](https://arduino.github.io/arduino-lint/latest/installation/#nightly-builds) are available for beta
32+
testing.

Diff for: docs/CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ There are several ways you can get involved:
88
| ------------------------------------------------- | ------------------------------------------------------- |
99
| - Support request<br/>- Question<br/>- Discussion | Post on the [Arduino Forum][forum] |
1010
| - Bug report<br/>- Feature request | Issue report (read the [issue guidelines][issues]) |
11+
| Beta testing | Try out the [nightly build][nightly] |
1112
| - Bug fix<br/>- Enhancement | Pull Request (read the [pull request guidelines][prs]) |
1213
| Monetary | - [Donate][donate]<br/>- [Buy official products][store] |
1314

1415
[forum]: https://forum.arduino.cc/index.php?board=3.0
1516
[issues]: #issue-reports
17+
[nightly]: installation.md#nightly-builds
1618
[prs]: #pull-requests
1719
[donate]: https://www.arduino.cc/en/Main/Contribute
1820
[store]: https://store.arduino.cc
@@ -26,6 +28,7 @@ High quality bug reports and feature requests are valuable contributions to the
2628

2729
### Before reporting an issue
2830

31+
- Give the [nightly build](installation.md#nightly-builds) a test drive to see if your issue was already resolved.
2932
- Search [existing pull requests and issues](https://github.com/arduino/arduino-lint/issues?q=) to see if it was already
3033
reported. If you have additional information to provide about an existing issue, please comment there. You can use
3134
[GitHub's "Reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) if you

Diff for: docs/installation.md

+24
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,30 @@ already in your `PATH` or add the arduino-lint installation path to your `PATH`
5353

5454
These are available from the "Assets" sections on the [releases page](https://github.com/arduino/arduino-lint/releases).
5555

56+
#### Nightly builds
57+
58+
These builds are generated every day at 01:00 GMT from the `main` branch and should be considered unstable. In order to
59+
get the latest nightly build available for the supported platform, use the following links:
60+
61+
| Platform | | |
62+
| --------- | ---------------------------- | ---------------------------- |
63+
| Linux | [32 bit][linux32-nightly] | [64 bit][linux64-nightly] |
64+
| Linux ARM | [32 bit][linuxarm32-nightly] | [64 bit][linuxarm64-nightly] |
65+
| Windows | [32 bit][windows32-nightly] | [64 bit][windows64-nightly] |
66+
| macOS | | [64 bit][macos-nightly] |
67+
68+
[linux64-nightly]: https://downloads.arduino.cc/arduino-lint/nightly/arduino-lint_nightly-latest_Linux_64bit.tar.gz
69+
[linux32-nightly]: https://downloads.arduino.cc/arduino-lint/nightly/arduino-lint_nightly-latest_Linux_32bit.tar.gz
70+
[linuxarm64-nightly]: https://downloads.arduino.cc/arduino-lint/nightly/arduino-lint_nightly-latest_Linux_ARM64.tar.gz
71+
[linuxarm32-nightly]: https://downloads.arduino.cc/arduino-lint/nightly/arduino-lint_nightly-latest_Linux_ARMv7.tar.gz
72+
[windows64-nightly]: https://downloads.arduino.cc/arduino-lint/nightly/arduino-lint_nightly-latest_Windows_64bit.zip
73+
[windows32-nightly]: https://downloads.arduino.cc/arduino-lint/nightly/arduino-lint_nightly-latest_Windows_32bit.zip
74+
[macos-nightly]: https://downloads.arduino.cc/arduino-lint/nightly/arduino-lint_nightly-latest_macOS_64bit.tar.gz
75+
76+
> These links return a `302: Found` response, redirecting to latest generated builds by replacing `latest` with the
77+
> latest available build date, using the format YYYYMMDD (i.e for 2019-08-06 `latest` is replaced with `20190806` )
78+
79+
Checksums for the nightly builds are available at
5680
`https://downloads.arduino.cc/arduino-lint/nightly/nightly-<DATE>-checksums.txt`
5781

5882
### Build from source

0 commit comments

Comments
 (0)