Skip to content

Commit b2bd0de

Browse files
authored
[skip changelog] Update references to docs workflow (arduino#890)
The docs workflow was split into two workflows: publish-docs and validate-docs, but the references to the original workflow were not updated.
1 parent 466c8c2 commit b2bd0de

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tools needed to use any Arduino compatible board and platforms.
77

88
[![tests-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=test)
99
[![nightly-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=nightly)
10-
[![docs-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=docs)
10+
[![docs-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=publish-docs)
1111
[![codecov-badge]](https://codecov.io/gh/arduino/arduino-cli)
1212

1313
> **Note:** this software is currently under active development: anything can change at any time, API and UI must be
@@ -42,7 +42,7 @@ e-mail contact: [email protected]
4242

4343
[tests-badge]: https://github.com/Arduino/arduino-cli/workflows/test/badge.svg
4444
[nightly-badge]: https://github.com/Arduino/arduino-cli/workflows/nightly/badge.svg
45-
[docs-badge]: https://github.com/Arduino/arduino-cli/workflows/docs/badge.svg
45+
[docs-badge]: https://github.com/Arduino/arduino-cli/workflows/publish-docs/badge.svg
4646
[codecov-badge]: https://codecov.io/gh/arduino/arduino-cli/branch/master/graph/badge.svg
4747
[install]: https://arduino.github.io/arduino-cli/installation
4848
[user documentation]: https://arduino.github.io/arduino-cli/

docs/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ case of failures we might ask you to update the PR with correct formatting.
281281
### Docs automation
282282

283283
In order to avoid unwanted changes to the public website hosting the Arduino CLI documentation, only Mike is allowed to
284-
push changes to the `gh-pages` branch, and this only happens from within the CI, in a workflow named [docs][11].
284+
push changes to the `gh-pages` branch, and this only happens from within the CI, in a workflow named [publish-docs][11].
285285

286286
The CI is responsible for guessing which version of the Arduino CLI we're building docs for, so that generated contents
287287
will be stored in the appropriate section of the documentation website. Because this guessing might be fairly complex,
@@ -344,7 +344,7 @@ If your PR doesn't need to be included in the changelog, please start the PR tit
344344
[7]: https://pages.github.com/
345345
[9]: https://www.mkdocs.org/
346346
[10]: https://github.com/jimporter/mike
347-
[11]: https://github.com/arduino/arduino-cli/blob/master/.github/workflows/docs.yaml
347+
[11]: https://github.com/arduino/arduino-cli/blob/master/.github/workflows/publish-docs.yaml
348348
[12]: https://github.com/arduino/arduino-cli/blob/master/docs/build.py
349349
[prettier-website]: https://prettier.io/
350350
[prettier-vscode-extension]: https://github.com/prettier/prettier-vscode

0 commit comments

Comments
 (0)