Skip to content

Commit

Permalink
docs: clarify server shutdown (#915)
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 authored May 17, 2023
1 parent 40a1a26 commit 2695c35
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ jobs:

### Start server

If your tests run against a local server, use `start` parameter, the server will run in the background and will shut down after tests complete
If your tests run against a local server, use the `start` parameter to start your server. The server will run in the background.

```yml
name: With server
Expand All @@ -662,7 +662,7 @@ jobs:
start: npm start
```

**Note:** sometimes on Windows you need to run a different start command. You can use `start-windows` parameter for this
**Note:** sometimes on Windows you need to run a different start command. You can use the `start-windows` parameter for this.

```yml
name: With server
Expand All @@ -684,7 +684,7 @@ jobs:

[![start example](https://github.com/cypress-io/github-action/workflows/example-start/badge.svg?branch=master)](.github/workflows/example-start.yml)

**Note:** GitHub cleans up the running server processes automatically. This action does not stop them.
**Note:** A server continues to run until the end of the GitHub workflow job that started it. At the end of the job the GitHub workflow runner executes a "Complete job" phase automatically where it terminates any server processes which are still running.

### Start multiple servers

Expand Down

0 comments on commit 2695c35

Please sign in to comment.