Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4 Updates #433

Merged
merged 16 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/03-github/01-getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ jobs:

buildForWindowsBasedPlatforms:
name: Build for ${{ matrix.targetPlatform }}
runs-on: windows-2019
runs-on: windows-2022
strategy:
fail-fast: false
matrix:
Expand Down
23 changes: 23 additions & 0 deletions docs/03-github/04-builder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,29 @@ to avoid any conflicts.

_**required:** `false`_ _**default:** `"/github/workspace"`_

#### dockerCpuLimit

Number of CPU cores to assign the Windows docker container. Defaults to all available cores when no
value is specified. Can accept fractional values, ie 0.5 for half of a cpu core's execution time.

_**required:** `false`_ _**default:** `""`_

#### dockerMemoryLimit

Amount of memory to assign the docker container. Defaults to 95% of total system memory rounded down
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: simply wondering if we should have consistency with "Windows docker container" vs "docker container" in here.

to the nearest megabyte on Linux and 80% on Windows when no value is specified. On unrecognized
platforms, defaults to 75% of total system memory. To manually specify a value, use the format
\<number\>\<unit\>, where unit is either m or g. ie: 512m = 512 megabytes and 4g = 4 gigabytes.

_**required:** `false`_ _**default:** `""`_

#### dockerIsolationMode

Isolation mode to use for the docker container. Can be one of process, hyperv, or default. Only
applicable on Windows.

_**required:** `false`_ _**default:** `"default"`_

AndrewKahr marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a suggestion combining some the above ideas. I used a list for m and g units for dockerMemoryLimit. Using e.g. instead of ie for examples. I'm definitely ok to merge as it is right now by the way.


dockerCpuLimit

Number of CPU cores to assign to the Docker container. Defaults to all available cores when no value is specified. Can accept fractional values, e.g., 0.5 for half of a CPU core's execution time.

required: false default: ""

dockerMemoryLimit

Amount of memory to assign to the Docker container. Defaults to 95% of total system memory rounded down to the nearest megabyte on Linux and 80% on Windows. If the platform is unrecognized, it defaults to 75% of total system memory. To manually specify a value, use the format <number><unit>. The units can be:

  • m: Megabytes (e.g., 512m = 512 megabytes)
  • g: Gigabytes (e.g., 4g = 4 gigabytes)

required: false default: ""

dockerIsolationMode

Isolation mode to use for the Docker container when running on Windows. Can be one of:

  • process
  • hyperv
  • default: This mode will choose the recommended mode as described by Microsoft. Server versions will use process, while desktop versions will use hyperv.

required: false default: "default"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this a lot better, will be using this strategy. Excellent suggestion!

## Outputs

Below are outputs that can be accessed by using `${{ steps.myBuildStep.outputs.outputName }}`, where
Expand Down
Loading