Azure / Azure/azure-functions-openapi-extension
Bug report, feature request or other request
- Dominant language
- C#
- Stars
- 388
- Forks
- 202
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the issue**
So I can see that Get-OpenApiDocument.ps1 works fine locally - but in trying to execute the powershell from azdo pipeline (yml) GITHUB_WORKSPACE seems irrelevant - I assume that's for github action integration. It first fails on the Set-Location call to "$repositoryRoot/$FunctionAppPath"
It's not clear to me if I'm actually trying to access the github repository OR the build artefact (which is a zip file).
If I point it to the directory that contains the API zip file then it then fails saying that func is an unknown commandlet, etc.. in relation to this line:
$funcCommand = $(Get-Command func).Source
I'm using an ubuntu agent so I'm not sure if I need to include something as a requires in my powershell script to ensure that the Azure function core tools are available.
Is there further documentation on actually using this file in an Azdo ci/cd pipeline? Am I confused that this powershell script should work in an azdo pipeline?
Contributor guide
Research direction
Start with Get-OpenApiDocument.ps1, especially the GITHUB_WORKSPACE path used by Set-Location and the Get-Command func lookup. Verify how the script should be run from an Azure DevOps YAML pipeline with a repository or API zip, then document the required paths and Azure Functions Core Tools prerequisite; done when the supported workflow and setup are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, powershell
- Domain
- cloud, devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100