AzurePipelinesPS icon indicating copy to clipboard operation
AzurePipelinesPS copied to clipboard

Are there docs/development somewhere else?

Open howardjones opened this issue 2 years ago • 3 comments

I installed the PS module, and got 4.0.25 even though 4.0.13 is the "latest" listed here on github. The readme here has an example login process using a deprecated Version instead of ApiVersion. (and the example vNext is not a valid version)

The help for Get-APProjectList has an example with parameters that don't exist...

Get-APProjectList -Instance 'https://dev.azure.com' -Collection 'myCollection' -Project 'myFirstProject'

Get-APProjectList: A parameter cannot be found that matches parameter name 'Project'.

Is there a newer version of the docs somewhere else? It's kind of confusing!

Also, what's a collection? Is that what ADO calls an Organization?

howardjones avatar Sep 07 '22 16:09 howardjones

Hey @howardjones !

I've also took a look at this tool. Using 4.0.32 version. I've managed to negotiate with our Azure DevOps (AzD) Services instance. Here is my Session config

get-apsession
Remove-APSession -Id '1'
get-apsession
$splat = @{
    Instance            = 'https://dev.azure.com/'
    Collection          = '<ORGANIZATION_NAME>' //those part of URI, which goes after `Instance`
    Project             = 'AZD_PROJECT'
    ApiVersion          = '6.0' //only 5.0 and 6.0 was working for me
    PersonalAccessToken = '<YOUR_PAT>'
    SessionName         = '<YOUR_ARBITRARY_CAPTION>'
}
New-APSession @splat

From this point you should be able to use this tool.

Paladin33rus avatar Feb 16 '23 09:02 Paladin33rus

Thank you @Paladin33rus ! I finally got around to trying this module and it looks very promising, but yes running into issues and confusion straight from the "getting started" readme isn't great.

@Dejulia489 - I see you've made some commits recently, if folks submit PRs (even if only for documention) will you have time to evaluate them semi-regularly?

(The dept has a homegrown module that talks to the "VSTS" Api, but isn't well maintained/updated to support things like the YAML Preview-Parse, and if we can get more folks contributing publicly, I'd rather put my time in here.)

OranguTech avatar Apr 10 '24 21:04 OranguTech

I stopped publishing release notes at some point but if it’s causing confusion I can look into automating them as part of the deployment pipeline.

I’d be happy to accept PRs that contribute any type of improvement to the module.

Dejulia489 avatar Apr 11 '24 00:04 Dejulia489