Commit Graph

76 Commits

Author SHA1 Message Date
Stefan Schulte
c6d37f6ecc Generate documentation from actions.yml
Right now the documentation of valid inputs (and outputs) seems to be
manually maintained inside the `README.md` with a reference to the
`actions.yml` file.

Since this can be rather tedious to maintain this commit now uses
[github-actions-docs][1] to automatically generate documentation.

[1]: https://www.npmjs.com/package/github-action-docs
2025-03-07 13:15:18 +01:00
Ben Wells
fbeca22fb2 Update README.md (#1193) 2025-01-16 08:49:29 -06:00
William Entriken
0a44ba7841 Correct version string (#1124) 2024-09-19 08:53:38 -05:00
suyashgaonkar
26961cf329 Documentation update in the README file (#1106)
* first commit on using setup node

* Delete .github/workflows/helloWorld.yml

* Create main.yml

* Rename main.yml to helloworld.yml

* goodbye world added

* name changed to goodbye

* updated README

---------

Co-authored-by: Suyash Gaonkar <39784472+suyashrg18@users.noreply.github.com>
2024-07-15 11:47:17 -05:00
Ben Greeley
25b062c917 Update README.md to update default Node version to 20 (#949)
The README's default example for setting up Node use version 16, which is at end of life. This PR updates those examples to use 20.
2024-02-13 11:33:00 -06:00
Róbert Papp
7247617371 Add package.json to node-version-file list of examples. (#879) 2023-12-13 13:02:47 +01:00
fusagiko / takayamaki
f3ec4ca66f Fix README.md (#898)
* Fix URL of locally-cached Node.js version in README

* Change example of Major versions in Supported version syntax

setup-node v4 supports node v20, but these example may
cause misunderstanding like a v20 is not supported.

---------

Co-authored-by: fusagiko/takayamaki <takayamaki@users.noreply.github.com>
2023-12-13 12:46:19 +01:00
Joel Wetzell
c45882a6ea update to setup-node@v4 in docs (#884) 2023-11-13 17:02:44 +01:00
Guillaume Membré
23755b521f upgrade actions/checkout to v4 (#868) 2023-10-23 15:57:08 +02:00
Olle Jonsson
69b2dd252e Refer to semver package name in README.md (#808) 2023-07-11 10:03:08 +02:00
Philip Harrison
a9893b0cfb Update to node 18.x (#751) 2023-05-10 16:04:46 +02:00
Dmitry Shibanov
9d255ef245 Adjust usage section (#734) 2023-04-06 10:52:43 +02:00
Ivan
ae9f0f7448 Update workflow badges (#685) 2023-01-31 08:45:30 +02:00
Phan An
f38519bb96 Fix a minor typo (#662) 2023-01-11 01:01:08 +01:00
Jongwoo Han
9227cda3f0 Replace workflow badge with new badge (#653) 2023-01-10 10:59:38 +01:00
Dmitry Shibanov
64ed1c7eab Add support for v8-canary, nightly and rc (#655) 2023-01-05 13:16:21 +01:00
Evan Mattson
bbe2ac79a1 Fix typo in README (#646) 2022-12-19 10:12:38 +01:00
Dmitry Shibanov
2349c84f5c Add support for nightly and rc versions (#611) 2022-11-17 14:35:58 +01:00
Dmitry Shibanov
00e1b6691b Pass the token input through on GHES (#595) 2022-11-02 12:24:44 +01:00
Larissa Fortuna
32f78d9bfa Update README.md
Updating term "virtual environments" to "runner images" and updating links
2022-08-25 15:35:44 -07:00
Christian Clauss
09ba51f18e README.md: Encourage testing on current Node.js (#533) 2022-07-07 14:53:32 +02:00
AJ Jordan
b3ca1ac971 Support npm-shrinkwrap.json out-of-the-box (#439) 2022-07-04 23:29:56 +02:00
Rob
cdcc53e14f Update README.md (#522) 2022-06-17 20:47:55 +02:00
Jack Bates
b287e177c9 Document * vs. current/latest/node difference (#508) 2022-06-14 14:13:13 +02:00
Jack Bates
eeb10cff27 Support lts/-n aliases (#481) 2022-06-02 12:30:33 +02:00
tooomm
3601f2a33e improve version syntax presentation (#493) 2022-05-18 09:50:55 +02:00
Milos Pantic
17f8bd9264 Expand current syntax to support aliases for latest version (current/latest/node) (#483) 2022-05-12 17:26:02 +02:00
Jon Koops
b067f78ed3 Use CI friendly commands in documentation (#326) 2022-05-05 16:16:51 +02:00
Adam Stachowicz
25184c4485 Update README.md (#475)
* Update README.md

* Update README.md
2022-04-26 11:11:03 -04:00
Araxeus
337fdf2194 fix broken link in readme (#473)
* fix broken link

* fix broken link
2022-04-22 08:58:19 -04:00
Dmitry Shibanov
146c4d84a5 improve caching documentation (#468) 2022-04-18 16:15:27 +02:00
Anil Seervi
76d3665dc0 Convert CONDUCT to CODE_OF_CONDUCT.md (#391)
* Rename CONDUCT to CODE_OF_CONDUCT.md

* Update CODE_OF_CONDUCT link
2022-04-05 11:16:57 -04:00
Peter Mescalchin
75716637dc Bump to actions/checkout@v3 (#437) 2022-04-01 10:13:52 +02:00
Peter Mescalchin
546fd45825 Updated documentation/workflows to use actions/setup-node@v3 (#433)
* Update documentation `actions/setup-node@v2` -> `actions/setup-node@v3`

* Bump workflows to `actions/setup-node@v3`

* Update `README.md` workflow status badges to new format
2022-03-31 15:14:07 -04:00
HonkingGoose
7a0f7a9962 Fix grammar in the README (#331) 2021-12-30 17:01:04 +03:00
Hargun Kaur
d08cf22211 Adding Node.js version file support (#338) 2021-11-29 12:18:31 +03:00
Maxim Lobanov
76a4cff9ae update readme and dist files 2021-08-05 12:00:47 +00:00
MaksimZhukov
180b77fed2 Update the caching section in the README 2021-08-03 17:18:13 +03:00
MaksimZhukov
9f31dbbbc4 Support caching for mono repos and repositories with complex structure 2021-08-02 20:44:59 +03:00
Jacob Gillespie
0ae03de2b7 Reorder to npm, yarn, pnpm 2021-07-15 20:14:30 +01:00
Jacob Gillespie
3af302a4f2 Switch to pnpm store path command 2021-07-15 12:43:19 +01:00
Jacob Gillespie
fdbc93ea6e Add disclaimer to pnpm action example, pin action 2021-07-14 13:03:28 +01:00
Jacob Gillespie
162ddf7c40 Add pnpm caching support 2021-06-30 20:17:23 +01:00
Maxim Lobanov
e1e1d4c853 Update README.md
Co-authored-by: Alena Sviridenko <alenasviridenko@github.com>
2021-06-30 15:12:34 +03:00
Maxim Lobanov
40f85c8c97 update readme 2021-06-30 15:07:45 +03:00
Dmitry Shibanov
72922790cb fix for documentation 2021-06-30 10:39:46 +03:00
Dmitry Shibanov
d36a3314a5 work on resolving comments 2021-06-25 12:06:49 +03:00
Dmitry Shibanov
f2b87bb2c2 Squashed commit of the following:
commit 446068aff1ec25da69c5b6af6d01dd19b230b4b2
Author: Alena Sviridenko <alenasviridenko@github.com>
Date:   Tue Jun 22 17:51:35 2021 +0300

    updated headers

commit d7e254e6e9534bb627373b7e40400cc45a888815
Author: Alena Sviridenko <alenasviridenko@github.com>
Date:   Thu Jun 17 17:35:34 2021 +0300

    updated links

commit ffd9956eda8c43e846f3305bad21fa064b07280f
Author: AlyonaSviridenko <alenasviridenko@github.com>
Date:   Thu Jun 17 17:33:41 2021 +0300

    Added advanced usage

commit 1e068f031030962d380a1bae32beb806d1c6f818
Author: AlyonaSviridenko <alenasviridenko@github.com>
Date:   Thu Jun 17 15:07:42 2021 +0300

    Updated readme with caching

commit 7528c3399a9c8e0b4e63f7a079e0078af6b92d6a
Author: Maxim Lobanov <v-malob@microsoft.com>
Date:   Wed Jun 16 14:43:46 2021 +0300

    Update versions.yml
2021-06-22 18:32:22 +03:00
Robert Stoll
5c355be170 use 14 instead of 12 in README beacuse peoply copy (#235) 2021-02-23 23:21:23 -05:00
Bryan MacFarlane
23bdee16bc Clarifications to the README (#167) (#229)
* Update README.md

* Update README.md

Co-authored-by: Bryan MacFarlane <bryanmacfarlane@github.com>

Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
2021-01-20 11:48:26 -05:00