Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kinsondigital/packagemonster
GitHub action that checks if a nuget package of a particular version exists.
https://github.com/kinsondigital/packagemonster
actions github-actions github-actions-ci hacktoberfest
Last synced: about 11 hours ago
JSON representation
GitHub action that checks if a nuget package of a particular version exists.
- Host: GitHub
- URL: https://github.com/kinsondigital/packagemonster
- Owner: KinsonDigital
- License: mit
- Created: 2021-08-11T16:38:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-10T19:24:01.000Z (about 1 month ago)
- Last Synced: 2024-10-30T05:41:37.572Z (21 days ago)
- Topics: actions, github-actions, github-actions-ci, hacktoberfest
- Language: C#
- Homepage: https://github.com/marketplace/actions/packagemonster
- Size: 413 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
**Package Monster**
[](https://github.com/KinsonDigital/PackageMonster/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
[](https://discord.gg/qewu6fNgv7)
## **🤷🏼♂️ What is it? 🤷🏼♂️**
### This GitHub action checks whether or not a NuGet package with a particular name and version exists in the public NuGet gallery package repository [nuget.org](https://www.nuget.org).
> **Note** This GitHub action is built using C#/NET and runs in a docker container. If the job step for running this action is contained in a job that runs on **Windows**, you will need to move the step to a job that runs on **Ubuntu**. You can split up your jobs to fulfill `runs-on` requirements of the GitHub action. This can be accomplished by moving the step into its own job. You can then route the action step outputs to the job outputs and use them throughout the rest of your workflow. For more information, refer to the Github documentation links below:
> For more info on step and job outputs, refer to the GitHub documentation links below:
> - [Defining outputs for jobs](https://docs.github.com/en/actions/using-jobs/defining-outputs-for-jobs)
> - [Setting a step action output parameter](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter)
🪧 Example 🪧
```yaml
name: Package Monster Action Sample
on:
workflow_dispatch:
jobs:
test_action:
name: Test Package Monster GitHub Action
runs-on: ubuntu-latest 👈🏼 # Required (Refer to the note above)
steps:
- uses: actions/checkout@v3
- name: Check If Nuget Package Exists
id: nuget-exists
uses: JohnDoe/[email protected]
with:
package-name: MyPackage 👈🏻 # Required input
version: 1.2.3 👈🏻 # Required input
fail-when-not-found: true 👈🏻 # Optional input
- name: Print Output Result #PowerShell Core
shell: pwsh 👈🏼 # Must be explicit with the shell to use PowerShell on Ubuntu
run: |
# Output name for the Package Monster GitHub action 👇🏼
# _____|_____
# | |
$nugetExists = "${{ steps.nuget-exists.outputs.nuget-exists }}";
if ($nugetExists -eq "true") {
Write-Host "::notice::The NuGet package exists!!";
} else {
Write-Host "::error::The NuGet package does not exist!!";
exit 1;
}
```
---
## **➡️ Action Inputs ⬅️**
| Input Name | Description | Required | Default Value |
|---|:---------------------------------------------------------------------------|:---:|:---:|
| `package-name` | The name of the NuGet package. | yes | N/A |
| `version` | The version of the package. | yes | N/A |
| `fail-when-not-found` | Will fail the job if the NuGet package of a specific version is not found. | no | false |
---
## **⬅️ Action Output ➡️**
The name of the output is `nuget-exists` and it returns a `boolean` of `true` or `false`.
Refer to the **Example** above for how to use the output of the action.
---
🙏🏼 Contributing 🙏🏼
Interested in contributing? If so, click [here](https://github.com/KinsonDigital/.github/blob/main/docs/CONTRIBUTING.md) to learn how to contribute your time or [here](https://github.com/sponsors/KinsonDigital) if you are interested in contributing your funds via one-time or recurring donation.
## **🔧 Maintainers 🔧**
[Calvin Wilkinson](https://twitter.com/KDCoder) (KinsonDigital GitHub Organization - Owner)
[Kristen Wilkinson](https://twitter.com/kswilky) (KinsonDigital GitHub Organization - Project Management, Documentation, Tester)
🚔 Licensing And Governance 🚔
[](https://github.com/KinsonDigital/.github/blob/main/docs/code_of_conduct.md)
[](https://github.com/KinsonDigital/PackageMonster/blob/main/LICENSE.md)
This software is distributed under the very permissive MIT license and all dependencies are distributed under MIT-compatible licenses.
This project has adopted the code of conduct defined by the **Contributor Covenant** to clarify expected behavior in our community.