Skip to content

Commit

Permalink
Merge pull request #41 from theohbrothers/docs/readme-add-documentati…
Browse files Browse the repository at this point in the history
…on-on-predefining-project-base-directory

Docs (readme): Add documentation on predefining project base directory
  • Loading branch information
joeltimothyoh authored Sep 25, 2023
2 parents 69c0645 + f7fec37 commit f981361
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ Configure the following CI settings for your project.

Add a secret variable `NUGET_API_KEY` containing your [PSGallery API key](https://docs.microsoft.com/en-us/powershell/scripting/gallery/how-to/publishing-packages/publishing-a-package?view=powershell-6#powershell-gallery-account-and-api-key) to your main project's CI settings for publishing your module on [PowerShell Gallery](https://www.powershellgallery.com/).

#### Environment variables

##### Project base directory

By default, `PSModulePublisher` defaults to using the main project's root directory as the path for execution. To override the default location, simply set the *environment* variable `PROJECT_BASE_DIR` to contain a custom directory value in your CI environment before executing `PSModulePublisher`.

## Usage

### Development
Expand Down

0 comments on commit f981361

Please sign in to comment.