Skip to content

Commit

Permalink
feat(docs): update docs (#775)
Browse files Browse the repository at this point in the history
feat(docs): update docs

Updates the Wing docs. See details in [workflow run].

[Workflow Run]: https://github.com/winglang/docsite/actions/runs/7730836379

------

*Automatically created via the "update-docs" workflow*
  • Loading branch information
monadabot authored Jan 31, 2024
1 parent 02414e5 commit 2925140
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Some Guides:
Here is a list of minimal tools you should install to build the Wing repo in your development
environment:

- [Node.js] v18 and [PNPM] v8
- [Node.js] v20 and [PNPM] v8
- We recommend [volta] to manage node tools
- [Rust]
- We recommend using [rustup] to manage your Rust installation if Rust is not already installed. Be careful of conflicting Rust installations (homebrew rust and rustup)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In this section you will install Wing on your system and run your first wing app

To install Wing, you will need the following setup:

* [Node.js](https://nodejs.org/en/) (>= 18.13.0)
* [Node.js](https://nodejs.org/en/) (>= 20)
* [VSCode](https://code.visualstudio.com/) (not required, but currently supported with an [extension](#wing-vscode-extension))

## Wing Toolchain
Expand Down
16 changes: 7 additions & 9 deletions versioned_docs/version-latest/06-tools/01-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,19 +181,17 @@ Usage:
$ wing test [entrypoint...] [--test-filter <regex>] [--retry [retries]]
```
`[entrypoint...]` specifies the entrypoint list of files that will be compiled and tested. A file is considered a valid entrypoint if its name ends with `.w`.
`[entrypoint...]` is the list of entrypoints that will be compiled and tested.
A file is considered an entrypoint if its name is `main` or ends with `.main` or `.test` and the extension is `.w` or `.ts`.
Exact paths or partial text can be used. If partial, all entrypoints in the current directory that contain the partial path will be used. For example `wing test bucket` will test `bucket.test.w` and `bucket/get.test.w`.
`[--test-filter <regex>]` option to run only specific tests within the entrypoints based on a provided regex.
By default, all entrypoints in the current directory will be used.
`[--retry [retries]]` option specifies the number of retries for failed tests. If no number is specified, the default number of retries is `3`.
`[--test-filter <regex>]` runs only specific tests within the entrypoints based on a provided regex.
For example ([test_bucket.test.w](https://github.com/winglang/wing/tree/main/examples/tests/valid/test_bucket.test.w)):
:::note Default Entrypoint(s)
It's possible to execute `wing test` without specifying any entrypoint, in which case the CLI looks for all files ending with `.test.w` in the current directory. If no files are found, the CLI throws an error.
`[--retry [retries]]` will retry failed tests based on number provided. By default it will retry `3` times.
:::
For example ([test_bucket.test.w](https://github.com/winglang/wing/tree/main/examples/tests/valid/test_bucket.test.w)):
```js
bring cloud;
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-latest/08-guides/02-ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ exports.postSynth = function(config) {
This workflow:
- Checks out the code.
- Installs Node.js v18.
- Installs Node.js v20.
- Installs the winglang CLI with the latest version.
- Installs npm dependencies (this step can be skipped if not necessary).
- Retrieves short-lived credentials for AWS via OIDC.
Expand Down

0 comments on commit 2925140

Please sign in to comment.