Skip to content

Commit

Permalink
breaking: switch to dynamic drive type by default for flexibility
Browse files Browse the repository at this point in the history
  • Loading branch information
samypr100 committed May 12, 2024
1 parent a267da6 commit c444bda
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ jobs:
with:
drive-size: 2GB
drive-format: NTFS
drive-type: Dynamic
drive-type: Fixed
drive-path: "my_awesome_drive.vhdx"
workspace-copy: true

Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ this action creates for you.
Just add the following line to the `steps:` list in your GitHub Actions yaml:

```yaml
- uses: samypr100/setup-dev-drive@v1
- uses: samypr100/setup-dev-drive@v2
```
You can optionally pass parameters to the action as follows:
```yaml
- uses: samypr100/setup-dev-drive@v1
- uses: samypr100/setup-dev-drive@v2
with:
drive-size: 1GB
drive-format: ReFS
Expand Down Expand Up @@ -59,10 +59,13 @@ otherwise `workspace-copy` can cause issues.
#### `drive-type`

Determines the type of drive, `Fixed` or `Dynamic`. There are performance tradeoffs between
both, hence for the purposes of this action `Fixed` is used by default.
both. For the purposes of this action `Dynamic` is used by default for flexibility.

`Dynamic` is useful when you want to cache the disk across job runs as it yields a smaller
payload to cache when the job ends.

`Fixed` gives you a notable performance boost, but there's a small creation overhead.

#### `workspace-copy`

This copies `${{ github.workspace }}` to your Dev Drive. Usually when you use `actions/checkout`
Expand Down Expand Up @@ -90,7 +93,7 @@ your dev drive workspace will be `E:\<project-name>` by default assuming the dri

```yaml
- uses: actions/checkout@v4
- uses: samypr100/setup-dev-drive@v1
- uses: samypr100/setup-dev-drive@v2
with:
workspace-copy: true
- name: Install Dependencies
Expand All @@ -99,7 +102,7 @@ your dev drive workspace will be `E:\<project-name>` by default assuming the dri
```

```yaml
- uses: samypr100/setup-dev-drive@v1
- uses: samypr100/setup-dev-drive@v2
- name: "Install Rust toolchain in dev drive"
env:
CARGO_HOME: ${{ env.DEV_DRIVE }}/.cargo
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ inputs:
default: "dev_drive.vhdx"
drive-type:
description: "Determines whether all space is allocated initially or over time. Example: Fixed or Dynamic."
default: "Fixed"
default: "Dynamic"
workspace-copy:
description: "Copy your GITHUB_WORKSPACE checkout to your Dev Drive. Examples: true, false."
default: "false"
Expand Down

0 comments on commit c444bda

Please sign in to comment.