Skip to content

Add docs for local dev chain with Halibut #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for local dev chain with Halibut #661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/local-build-chain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# How to Set up a Local Nuget feed to Use a Custom Build of Halibut in Tentacle and Octopus

It's time consuming to rely on Teamcity pull requests to generate artifacts to line up versions of Halibut, Tentacle and Octopus to develop locally.

Instead, we can build and generate local packages, and use them directly using the Local Nuget Feed feature.

These instructions are for Rider, but the Local Nuget feed feature is not IDE-dependant.

## Halibut

1. Open the Halibut solution in Rider.
2. Go to the "\_build" run configuration and set the Program Arguments to `--Target CopyToLocalPackages`
3. Run the "\_build" configuration.
4. This will generate some artifacts in C:\dev\LocalPackages. (This is my local packages folder - your output folder may be different. Please see the Run output)
5. The artifacts will contain files that are suffixed with your branch name, e.g. Halibut.8.1.1234-branch-name
6. Run the command `dotnet nuget add source C:\dev\LocalPackages\ -n "Local Packages"`. Replace the path with your local output folder
7. Open the Tentacle Solution in Rider
8. Verify that Rider is showing `C:\dev\LocalPackages\` as a new feed in the Nuget section.
9. In the Tentacle repository, use Rider's Nuget > Packages section to select the correct Version of Halibut. Ensure that the "Prerelease" checkbox is checked.
10. Click on the "upgrade"/"downgrade" icon.
11. Build Tentacle. You should now be using the local version of Halibut.

## Tentacle

1. Open the Tentacle solution in Rider.
2. Go to the "\_build" run configuration and set the Program Arguments to `--Target CopyClientAndContractsToLocalPackages`
3. Run the "\_build" configuration.
4. This will generate some artifacts in C:\dev\LocalPackages. (This is my local packages folder - your output folder may be different. Please see the Run output)
5. The artifacts will contain files that are suffixed with your branch name, e.g. Octopus.Tentacle.Contracts.8.3.2786-branch-name and Octopus.Tentacle.Client.8.3.2786-branch-name
6. Open the Octopus Solution in Rider
7. Verify that Rider is showing `C:\dev\LocalPackages\` as a new feed in the Nuget section.
8. In the Octopus repository, use Rider's Nuget > Packages section to select the correct Version of Tentacle.Client and Tentacle.Contracts. Ensure that the "Prerelease" checkbox is checked.
9. Click on the "upgrade"/"downgrade" icon.
10. Build Octopus. You should now be using the local version of Tentacle.