Skip to content

Commit 893fad3

Browse files
author
vinay-lanka
committed
2 parents 27fd341 + 38a80a6 commit 893fad3

File tree

114 files changed

+4115
-1307
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+4115
-1307
lines changed

.github/workflows/docs.yaml

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: docs
2+
3+
on:
4+
pull_request:
5+
paths:
6+
# existing docs
7+
- 'docs/**'
8+
# changes to the cli reference generator
9+
- 'docsgen/**'
10+
# potential changes to commands documentation
11+
- 'cli/**'
12+
# potential changes to gRPC documentation
13+
- 'rpc/**'
14+
push:
15+
branches:
16+
- master
17+
# At this day, GitHub doesn't support YAML anchors, d'oh!
18+
paths:
19+
- 'docs/**'
20+
- 'docsgen/**'
21+
- 'cli/**'
22+
- 'rpc/**'
23+
24+
jobs:
25+
build:
26+
runs-on: ubuntu-latest
27+
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v2
31+
32+
- name: Install Taskfile
33+
uses: Arduino/actions/setup-taskfile@master
34+
with:
35+
repo-token: ${{ secrets.GITHUB_TOKEN }}
36+
37+
- name: Setup Go
38+
uses: actions/setup-go@v2-beta
39+
with:
40+
go-version: '1.14'
41+
42+
- name: Install Go dependencies
43+
run: |
44+
go version
45+
go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
46+
47+
- name: Install protoc compiler
48+
uses: arduino/[email protected]
49+
with:
50+
repo-token: ${{ secrets.GITHUB_TOKEN }}
51+
52+
- name: Setup Python
53+
uses: actions/setup-python@v1
54+
with:
55+
python-version: '3.6'
56+
architecture: 'x64'
57+
58+
- name: Cache dependencies
59+
uses: actions/cache@v1
60+
with:
61+
path: ~/.cache/pip
62+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
63+
restore-keys: |
64+
${{ runner.os }}-pip-
65+
66+
- name: Install Python dependencies
67+
run: |
68+
python3 -m pip install --upgrade pip
69+
python3 -m pip install -r ./requirements_docs.txt
70+
71+
- name: Build docs website
72+
run: task docs:build
73+
74+
- name: Deploy
75+
# publish docs only when PR is merged on master
76+
if: github.event_name == 'push'
77+
uses: peaceiris/actions-gh-pages@v3
78+
with:
79+
github_token: ${{ secrets.GITHUB_TOKEN }}
80+
publish_dir: ./public

.github/workflows/test.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
- name: Install Go
2626
uses: actions/setup-go@v1
2727
with:
28-
go-version: '1.13'
28+
go-version: '1.14'
2929

3030
- name: Install Go deps
3131
# Since 10/23/2019 pwsh is the default shell

.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@ venv
2020

2121
# Misc.
2222
.DS_Store
23+
24+
# Mkdocs
25+
/public/
26+
/docsgen/arduino-cli
27+
/docs/rpc/*.md
28+
/docs/commands/*.md

Dockerfiles/builder/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ENV PATH $PATH:/usr/local/go/bin
55
# Install tooling
66
ENV GORELEASER_VER 0.113.0
77
ENV GORELEASER_SHA 2379beebb6369b75ccead7f7a43269de700b51821feae3857701d106ed72bd63
8-
ENV GOVER 1.13
8+
ENV GOVER 1.14
99
RUN set -ex \
1010
&& curl -o goreleaser.tar.gz -LO https://github.com/goreleaser/goreleaser/releases/download/v${GORELEASER_VER}/goreleaser_Linux_x86_64.tar.gz \
1111
&& echo "$GORELEASER_SHA goreleaser.tar.gz" | sha256sum -c - || exit 1 \

README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# arduino-cli
2+
3+
![cli-logo](./docs/img/featured-CLI.png)
4+
5+
Arduino CLI is an all-in-one solution that provides builder, boards/library manager,
6+
uploader, discovery and many other tools needed to use any Arduino compatible
7+
board and platforms.
8+
9+
[![tests-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=test)
10+
[![nightly-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=nightly)
11+
[![docs-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=docs)
12+
[![codecov-badge]](https://codecov.io/gh/arduino/arduino-cli)
13+
14+
> **Note:** this software is currently under active development: anything can change
15+
at any time, API and UI must be considered unstable until we release version 1.0.0.
16+
17+
## Docs
18+
19+
For guidance on installation and development, see the [User documentation].
20+
21+
## Quickstart
22+
23+
1. [Install] the Arduino CLI
24+
2. Follow the [Getting Started] guide to check out what the CLI can do
25+
3. Browse the [Commands reference] to see all the available commands
26+
4. Should you have an issue, read the [FAQ] page
27+
28+
## How to contribute
29+
30+
Contributions are welcome!
31+
32+
Please read the document [How to contribute] which will show you how to build
33+
the source code, run the tests, and contribute your changes to the project.
34+
35+
:sparkles: Thanks to all our [contributors]! :sparkles:
36+
37+
38+
[tests-badge]: https://github.com/Arduino/arduino-cli/workflows/test/badge.svg
39+
[nightly-badge]: https://github.com/Arduino/arduino-cli/workflows/nightly/badge.svg
40+
[docs-badge]: https://github.com/Arduino/arduino-cli/workflows/docs/badge.svg
41+
[codecov-badge]: https://codecov.io/gh/arduino/arduino-cli/branch/master/graph/badge.svg
42+
[Install]: https://arduino.github.io/arduino-cli/installation
43+
[User documentation]: https://arduino.github.io/arduino-cli/
44+
[Getting Started]: https://arduino.github.io/arduino-cli/getting-started/
45+
[Commands reference]: https://arduino.github.io/arduino-cli/commands/arduino-cli
46+
[FAQ]: https://arduino.github.io/arduino-cli/FAQ/
47+
[How to contribute]: https://arduino.github.io/arduino-cli/CONTRIBUTING/
48+
[contributors]: https://github.com/arduino/arduino-cli/graphs/contributors

0 commit comments

Comments
 (0)