Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zyactions/dotnet-restore
A GitHub Action that wraps the .NET CLI `dotnet restore` command.
https://github.com/zyactions/dotnet-restore
continuous-integration dotnet github-actions
Last synced: about 2 months ago
JSON representation
A GitHub Action that wraps the .NET CLI `dotnet restore` command.
- Host: GitHub
- URL: https://github.com/zyactions/dotnet-restore
- Owner: zyactions
- License: mit
- Created: 2022-12-11T13:57:22.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-21T19:26:28.000Z (over 1 year ago)
- Last Synced: 2024-10-17T07:08:11.154Z (2 months ago)
- Topics: continuous-integration, dotnet, github-actions
- Language: YAML
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# .NET Setup
![License: MIT][shield-license-mit]
[![CI][shield-ci]][workflow-ci]
[![Ubuntu][shield-platform-ubuntu]][job-runs-on]
[![macOS][shield-platform-macos]][job-runs-on]
[![Windows][shield-platform-windows]][job-runs-on]
A GitHub Action that wraps the .NET CLI `dotnet restore` command.
## Features
- Wraps the `dotnet restore` [.NET CLI][dotnet-sdk] command
- Provides a structured way of using this command in a workflow
- Supports all platforms (Linux, macOS, Windows)
> **Note**
>
> This action provides a wrapper around the `dotnet restore` [.NET CLI][dotnet-sdk] command.
> For further details, please check out the [official documentation][dotnet-restore].
## Usage
### Restore Packages
```yaml
steps:
- ...
- name: .NET Restore
uses: zyactions/dotnet-restore@v1
```
The `dotnet restore` command automatically searches for a Visual Studio Solution file (`*.sln`) in the repository root.
### Restore Packages for a specific Project- or Solution
```yaml
steps:
- ...
- name: .NET Restore
uses: zyactions/dotnet-restore@v1
with:
working-directory: test
workspace: Tests.sln
```
## Inputs
### `working-directory`
The working-directory for the action.
Defaults to the repository root directory (`github.workspace`).
> **Note**
>
> If a specific .NET SDK version is to be used, the working directory must point to the directory that contains the `global.json` or a subdirectory of it.
### `workspace`
The Visual Studio workspace (directory, project- or solution-file).
This path is relative to the `working-directory` unless an absolute path is used.
The `dotnet restore` command automatically searches for a Visual Studio Solution file (`*.sln`) in the specified workspace directory, if no explicit solution- or project- file is specified.
Example values:
- `path/to/workspace`
- `path/to/Solution.sln`
- `path/to/Project.csproj`
### `configfile`
The NuGet configuration file (nuget.config) to use. If specified, only the settings from this file will be used. If not specified, the hierarchy of configuration files from the current directory will be used.
For more information, see [Common NuGet Configurations][nuget-configurations].
### `ignore-failed-sources`
Only warn about failed sources if there are packages meeting the version requirement.
### `force`
Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the `project.assets.json` file.
### `force-evaluate`
Forces `restore` to reevaluate all dependencies even if a lock file already exists.
### `use-lock-file`
Enables project lock file to be generated and used with restore.
### `lock-file-path`
Output location where project lock file is written. By default, this is `PROJECT_ROOT\packages.lock.json`.
### `locked-mode`
Don't allow updating project lock file. This is useful when deterministic builds are required.
## Requirements
The [.NET CLI][dotnet-sdk] needs to be installed on the runner. To be independent from the GitHub defaults, it's recommended to install a specific version of the SDK prior to calling this action.
To install the .NET SDK in your workflow, the following actions can be used:
- [zyactions/dotnet-setup][zyactions-dotnet-setup]
- [actions/setup-dotnet][actions-setup-dotnet]
## Dependencies
This action does not use external dependencies.
## Versioning
Versions follow the [semantic versioning scheme][semver].
## License
.NET Restore Action is licensed under the MIT license.
[actions-setup-dotnet]: https://github.com/actions/setup-dotnet
[dotnet-restore]: https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-restore
[dotnet-sdk]: https://github.com/dotnet/sdk
[job-runs-on]: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on
[nuget-configurations]: https://learn.microsoft.com/en-us/nuget/consume-packages/configuring-nuget-behavior
[semver]:https://semver.org
[shield-license-mit]: https://img.shields.io/badge/License-MIT-blue.svg
[shield-ci]: https://github.com/zyactions/dotnet-restore/actions/workflows/ci.yml/badge.svg
[shield-platform-ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?logo=ubuntu\&logoColor=white
[shield-platform-macos]: https://img.shields.io/badge/macOS-53C633?logo=apple\&logoColor=white
[shield-platform-windows]: https://img.shields.io/badge/Windows-0078D6?logo=windows\&logoColor=white
[workflow-ci]: https://github.com/zyactions/dotnet-restore/actions/workflows/ci.yml
[zyactions-dotnet-setup]: https://github.com/zyactions/dotnet-setup