Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Piedone committed Nov 2, 2024
1 parent ae6ebca commit 7780a0a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
1 change: 1 addition & 0 deletions Docs/Workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ These features are designed to reduce resource usage (like paid GitHub Actions m
- [Post-pull request checks automation](Workflows/Productivity/PostPullRequestChecksAutomation.md)
- [Publish NuGet package](Workflows/Productivity/PublishNuGetPackage.md)
- [Spell-checking](Workflows/Productivity/SpellChecking.md)
- [Validate NuGet Publish](Workflows/Productivity/ValidateNugetPublish.md)
- [Validate pull request](Workflows/Productivity/ValidatePullRequest.md)
- [Validate submodule](Workflows/Productivity/ValidateSubmodule.md)
- [YAML linting](Workflows/Productivity/YamlLinting.md)
Expand Down
1 change: 1 addition & 0 deletions Docs/Workflows/Productivity/PublishNuGetPackage.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@ Valid values for `verbosity` are those defined by [MSBuild](https://docs.microso

- If you have multiple projects in the repository or if the project you want to build is in a subfolder, then add a solution to the root of the repository that references all projects you want to build.
- References to projects (`<ProjectReference>` elements) not in the repository won't work, these need to be changed to package references (`<PackageReference>` elements). Make the conditional based on `$(NuGetBuild)`. See the [Helpful Extensions project file](https://github.com/Lombiq/Helpful-Extensions/blob/dev/Lombiq.HelpfulExtensions/Lombiq.HelpfulExtensions.csproj) for an example. References to projects in the repository will work and those projects, if configured with the proper metadata, will be published together, with dependencies retained among the packages too.
- Also see [`validate-nuget-publish`](ValidateNugetPublish.md) for a workflow that validates the NuGet publishing process without actually pushing the package to NuGet or creating a GitHub release.
20 changes: 20 additions & 0 deletions Docs/Workflows/Productivity/ValidateNugetPublish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Validate NuGet Publish

Validates the NuGet publishing process without actually pushing the package to NuGet or creating a GitHub release. Useful to check if the project is still publishable, and didn't get an unexpected breaking change. Example validate-nuget-publish.yml_:

```yaml
name: Validate NuGet Publish

on:
pull_request:
push:
branches:
- dev

jobs:
validate-nuget-publish:
name: Validate NuGet Publish
uses: Lombiq/GitHub-Actions/.github/workflows/validate-nuget-publish.yml@dev
```
The workflow otherwise takes the same configuration options as [`publish-nuget`](PublishNuGetPackage.md), but doesn't require the `API_KEY` secret.

0 comments on commit 7780a0a

Please sign in to comment.