Skip to content

Commit

Permalink
Merge pull request #110 from banchan86/create-package-nuget
Browse files Browse the repository at this point in the history
Update "Create a Package" article with NuGet publishing workflow
  • Loading branch information
glopesdev authored Jan 9, 2025
2 parents 94b6146 + 9d78898 commit 84a9724
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions articles/create-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ The Bonsai language can be extended with custom packages, which are installed an

![Inspecting the package metadata](~/images/extensions-packagemetadata.png)

2. Fill in or edit all the relevant metadata fields. These are critical to correctly communicate the provenance of your project to other users. Please pay special attention to `Title`, `Description`, `Authors`, `Copyright`, `PackageProjectUrl`, `PackageLicenseExpression`, `PackageIcon` and `PackageTags` to make sure that they correctly describe your project. Make sure that `Version` is correctly assigned in every new release to avoid problems during package updates.
2. Fill in or edit all the relevant metadata fields. These are critical to correctly communicate the provenance of your project to other users. Please pay special attention to `Title`, `Description`, `Authors`, `Copyright`, `PackageProjectUrl`, `PackageLicenseExpression`, `PackageIcon` and `PackageTags` to make sure that they correctly describe your project. Make sure that `Version` is correctly assigned in every new release to avoid problems during package updates. In order to make your project discoverable through the Bonsai package manager, make sure to include the `PackageType` field and specify both `Dependency` and `BonsaiLibrary` as package types.

> [!Tip]
> Use version suffixes for sharing prerelease versions for testing, e.g. `0.1.0-alpha`. If a package version has a prerelease suffix, it will only be listed by the package manager if the checkbox "Include prerelease" is checked.
Expand All @@ -118,4 +118,4 @@ The Bonsai language can be extended with custom packages, which are installed an
> If you have your custom package installed in the same editor used to debug the source code, Bonsai will prefer the installed package over the compiled source code library. In this case, either uninstall the package, or use a local Bonsai installation.

> [!Note]
> If you would like to share the package with the broader Bonsai community, consider publishing your package in the [**Bonsai Community feed**](https://www.myget.org/gallery/bonsai-community). Click the `Connect to Feed` button for more details on how to push packages to the feed.
> If you would like to share the package with the broader Bonsai community, consider publishing it to [**NuGet**](https://www.nuget.org/packages/manage/upload) by creating a `NuGet` account and uploading the `.nupkg` file. Ensure the `PackageType` field is properly defined before submission.
Binary file modified images/extensions-packagemetadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 84a9724

Please sign in to comment.