-
-
Notifications
You must be signed in to change notification settings - Fork 389
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into additional_include_paths_libs
- Loading branch information
Showing
340 changed files
with
8,939 additions
and
7,575 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
name: docs | ||
|
||
on: | ||
pull_request: | ||
types: | ||
- opened | ||
- synchronize | ||
- closed | ||
paths: | ||
# existing docs | ||
- 'docs/**' | ||
# changes to the cli reference generator | ||
- 'docsgen/**' | ||
# potential changes to commands documentation | ||
- 'cli/**' | ||
# potential changes to gRPC documentation | ||
- 'rpc/**' | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: Install Taskfile | ||
uses: Arduino/actions/setup-taskfile@master | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Setup Go | ||
uses: actions/setup-go@v2-beta | ||
with: | ||
go-version: '1.13' | ||
|
||
- name: Install Go dependencies | ||
run: | | ||
go version | ||
go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc | ||
- name: Install protoc compiler | ||
uses: arduino/setup-protoc@v1.1.0 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v1 | ||
with: | ||
python-version: '3.6' | ||
architecture: 'x64' | ||
|
||
- name: Cache dependencies | ||
uses: actions/cache@v1 | ||
with: | ||
path: ~/.cache/pip | ||
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | ||
restore-keys: | | ||
${{ runner.os }}-pip- | ||
- name: Install Python dependencies | ||
run: | | ||
python3 -m pip install --upgrade pip | ||
python3 -m pip install -r ./requirements_docs.txt | ||
- name: Build docs website | ||
run: task docs:build | ||
|
||
- name: Deploy | ||
# publish docs only when PR is merged | ||
if: github.event.pull_request.merged == true | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./public |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,3 +20,9 @@ venv | |
|
||
# Misc. | ||
.DS_Store | ||
|
||
# Mkdocs | ||
/public/ | ||
/docsgen/arduino-cli | ||
/docs/rpc/*.md | ||
/docs/commands/*.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.