Skip to content

Commit

Permalink
docs: readability improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
samypr100 committed May 13, 2024
1 parent 38f7203 commit d670ee4
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,11 @@ as provided by [Format-Volume](https://learn.microsoft.com/en-us/powershell/modu

#### `drive-path`

The path to the Dev Drive VHDX file, by default resolves to `C:\dev_drive.vhdx`.
Note, when a relative path is provided, it will be relative to `C:\` or the default
workspace drive letter.
The path to the Dev Drive VHDX file, defaults to the relative path `dev_drive.vhdx`.

When a relative path is provided, it will be relative to `C:\`, `D:\` or the default
workspace drive letter on the runner. Hence, `dev_drive.vhdx` will likely resolve to
`C:\dev_drive.vhdx` or `D:\dev_drive.vhdx`.

When an absolute path is provided, make sure it's located outside `${{ github.workspace }}`
otherwise `workspace-copy` can cause issues. This action will raise an error in such cases.
Expand Down Expand Up @@ -99,18 +101,18 @@ assigned letter is `E`, `${{ env.DEV_DRIVE }}` will contain `E:`.
#### `DEV_DRIVE_WORKSPACE`

When `workspace-copy` is set to true, this contains the workspace location as represented
by the dev drive location. For example if your GitHub workspace is `C:\a\<project-name>\<project-name>`
by the dev drive location. For example if your GitHub workspace is `D:\a\<project-name>\<project-name>`
your dev drive workspace will be `E:\<project-name>` by default assuming the drive letter is `E`.

#### `DEV_DRIVE_PATH`

The canonical location of the VHDX file.

When `drive-path` is set to a relative path like `my_drive.vhdx`
the location in this variable will likely be `C:\my_drive.vhdx`.
the location in this variable will likely be `D:\my_drive.vhdx`.

On the other hand, when `drive-path` is set to an absolute path,
that's likely what this variable will contain after normalization.
On the other hand, when `drive-path` is set to an absolute path, that will become
the value this variable will contain after normalization.

### Examples

Expand Down

0 comments on commit d670ee4

Please sign in to comment.