VersioningStrategy always empty

fhanggi · 26 February 2022 02:27

Hello
I had a powershell script that i used to add version rules to channels inside projects. This is failing now. I hadn’t run it in a while so i’m suspecting something has changed since we are upgrading regularly. We are currently on version v2021.2

I pinned the issue down to the project’s VersioningStrategy being empty in the project object i’m getting back from the API.
I checked in the GUI and it has a version strategy which is based on a package step.
However it’s always blank when I use the Octopus.Client API inside powershell .

Below is part of my powershell code.
I’m wondering if VersioningStrategy has been moved to some other place?

$projects = $repository.ProjectGroups.GetProjects($projectGroup)
foreach($project in $projects)
{
$project.VersioningStrategy #<—tihs is always empty
}

Any tips would be greatly appreciated.
Thank you
Fabian

Kenneth_Bates · 28 February 2022 01:17

Hi Fabian,

Thanks for getting in touch! Great question, and it’s very possible something did change between the last version you ran it successfully and your current version. Depending on the previous working version, we might be able to narrow it down to which change (re: introduction of Spaces, or Config As Code, etc.), if applicable. However I’d like to get a bit more clarity on your process and goal here.

$project.VersioningStrategy looks to map directly to the release versioning on the project itself, not in version rules on channels. In the UI that is here:

But as I understand you’re wanting to add to the channel itself. Unfortunately I don’t see any pre-written sample scripts to do this but I believe you’d need to use the channels API where you’d see something like this that you might be wanting to target:

Another handy thing to keep in mind is that Octopus is API-first, so even checking out the network tab to see the calls made behind the scenes when making your desired change in the web portal might be a lot of help.

I hope this helps, and please let me know how you go!

Best regards,

Kenny

fhanggi · 28 February 2022 18:01

Hi Kenneth
Thank you for the quick response.
Project.VersioningStrategy used to get me the version strategy for the project which was set up in another place on the UI. I think it has now moved to the Deployment Settings.
I need the versioning strategy of the project not the channel because the channel doesn’t have a versioning rule unless it has rules. I’m trying to add rules.

Here’s more info

Once i found the project i want to change in my ps script i get the channel i’m interested in
$Channel = $repository.Channels.FindByName($project, $ChannelNames[$i])

looking at that channel object there’s no versionin stragegy

I’m looping through the rules for the channel and if the one i want to add doesn’t exist i need to build a rule object

						$NewRule = New-Object Octopus.Client.Model.ChannelVersionRuleResource
						$NewRule.ActionPackages.Add($PackageReferenceStep)
						$NewRule.Tag = $VersionRulePreReleaseTags[$i]
						$Channel.Rules.Add($NewRule)

That requires an ActionPackage which is the versioning strategy
Used to be this $project.VersioningStrategy.DonorPackage

But as i explained that is now always blank.

Do you know where in the API i can get the versioning strategy now?
Like where are the deployment settings. I couldn’t find them.

Thank you.

Fabian

donny.bell · 28 February 2022 18:41

Hi @fhanggi,

Thank you for getting back to us.

I believe the versioning strategy endpoint you are looking for is:

OCTOPUS_URL/api/Spaces-XXXX/projects/Projects-XXXX/deploymentsettings

See my example below:

You can also test this in Swagger:

If you have any additional questions, please don’t hesitate to ask!

Best Regards,
Donny

fhanggi · 28 February 2022 19:24

I made a mistake. I’m not using the API like you show it. I am using the Octopus.Client.dll in powershell.
There i cannot find the DeploymentSettings.
I’m using the latest version of Octopus.Client from nuget. It’s version 11.6.3644.
When i inspect the project object there is no DeploymentSettings object.
do you know how to get the the DeploymentSettings for a proejct by using Octopus.Client?

Thank you very much
Fabian

Kenneth_Bates · 1 March 2022 01:27

Hi Fabian,

Thanks for following up! Firstly, I suspect you’re trying this correctly, and while I was looking through this thread again I had a sneaking suspicion that you may be hitting a known and current bug which I’ll link below. I might be off the mark but it’d be worth ruling out at the very lease.

github.com/OctopusDeploy/Issues

Resource Not Found Error - Versioning Strategy from cloned projects incorrectly referencing package.

opened 03:47PM - 30 Sep 21 UTC

AdamHollow49

kind/bug priority/p2 state/triage team/fire-and-motion

### Team - [X] I've assigned a team label to this issue ### Severity Th…is can cause a serious block as it causes the projects/all endpoint to fail. ### Version 2021.2.7624 ### Latest Version I could not reproduce the problem ### What happened? A user reported issues where cloning projects caused several things to break. It seemed as though when the project was cloned the versioning strategy was brought across, then when the steps within the project were modified and the package being referenced for versioning was no longer included in the project steps, a resource not found error appeared. Ticket for reference: https://octopus.zendesk.com/agent/tickets/76582 We were able to resolve this issue by inserting a default versioning strategy into the deployment settings of the project. ### Reproduction We've been unable to reproduce this issue consistently, there have been several different occurrences of this but unfortunately, no two appear to be the exact same. ### Error and Stacktrace ```shell The resource 'PackageName' was not found. ``` ### More Information Deployment Settings for Project before it was fixed (see Projects-1005): https://hosted.octofront.com/background-tasks/BackgroundTasks-1656684 Deployment Process for Project before it was fixed: https://hosted.octofront.com/background-tasks/BackgroundTasks-1658537 The deployment settings seem to be referencing a package that doesn't exist in the deployment process, returning the Resource Not Found error. We're unsure exactly how these projects got in this state, whether the error was due to specific actions taken after cloning the projects or whether something else broke upon cloning the projects. It would be great if we could investigate this further to rule out or confirm a bug. ### Workaround - Create a new project and query the Deployment Settings via API or DB query. - Insert the blank versioning strategy from the new project over the deployment settings of the broken project. (for an example of how to do this, you can look at aneumann-cdlx's comment below. Swagger makes this very simple, i.e. do a GET on the deploymentsettings endpoint of the blank project to get the JSON body you will use, take that JSON and alter it to have the project ID of the problem project, and do a PUT on the deploymentsettings endpoint of the problem project with this altered JSON body.) - Then, you can open the previously broken project within Octopus and set the versioning strategy as appropriate.

I’m curious of a few things:

Are you able to successfully browse through the project in the web portal?
Are you seeing this same issue across all of your projects?
If it’s just a subset of projects, is this problematic project(s) cloned from another project (as discussed in more detail in the above linked bug report)?

I look forward to hearing back!

Best regards,

Kenny

fhanggi · 1 March 2022 01:49

Hi Kenny

I just found out how to get it to work. However To answer your questions. Yes i can browse through all my projects . Yes my issue (VersioningStrategy being empty) was for all projects that i looked at in my powershell code.

It seems that VersioningStrategy object for the project is not populated anymore. Not sure if that is a bug or by design.

Here is what i had to do to get the VersioningStrategy for a project

Before (not working)
$project.VersioningStrategy.DonorPackage

After (working)
$repository.DeploymentSettings.Get($project).VersioningStrategy.DonorPackage

Hope this helps someone else.

Thank you

Fabian

Kenneth_Bates · 1 March 2022 05:25

Hi Fabian,

I greatly appreciate your follow-up and sharing your findings! It’s something to have a closer look at. Please let me know if you have any questions or concerns going forward.

Best regards,

Kenny

system · 1 April 2022 05:26

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.