[Question] How to selectively publish APIs across diff instance of APIM env
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start with the APIOps publisher pipeline and Publisher Config file described in the issue, then verify how full-repository and commit-based deployments currently select content. Define how an exclusion or selection mechanism should work for APIs promoted from dev to UAT, and confirm that an environment promotion can omit unfinished APIs while retaining the existing deployment modes.
Written by the indexing model from the issue text.
Description
Release version
v6.0.1.10
Question Details
Background
I have 3 different instances of APIM, 1 APIM instance for each env. E.g. dev, uat and production (PRD).
Each env have their own branch in Github too.
APIM between each env may not be the same, because APIs are in different stages of SDLC. More details below.
In Dev APIM will contains APIs that are Proof-of-concept, under development or for demo. When the APIs are ready from development or successful POC, i will put the APIs in UAT APIM for user testing. Once UAT is ready and user sign-off, only then the API will go into PRD APIM.
Publishing Across Env
My ideal flow of ApiOps (CICD + GitOps) is for main to be single source of truth.
So from main, i will generate the dev branch, then uat branch.
Any new API will be a feature branch from dev.
Flow: feature -> dev -> uat -> prd
Issue
There is currently no option to selectively publish specific APIs during promotion between environments.
The publisher supports only:
Full repository deployment, or
Deployment by specific commit ID
As a result, APIs that are not yet ready for promotion (e.g. unfinished POCs or APIs without user sign-off) get deployed unintentionally.
Hence will like to check if anyone has similar set-up and how you configure your CI/CD?
Expected behavior
When Merge to higher env, e.g. from dev to uat
Able to select which APIs that are not to be publish e.g. in Publisher Config file
Only APIs that are not in it will be publish
Actual behavior
Either publish by commit id or whole repo
Reproduction Steps
-
Setup 3 different Azure API Management (APIM) instances — one for each environment:
apim-dev (development)
apim-uat (user acceptance testing)
apim-prd (production) -
Configure the APIOps extractor and publisher pipelines, each linked to a different GitHub branch:
dev branch → apim-dev
uat branch → apim-uat
prd branch → apim-prd -
In apim-dev, create several APIs for testing or proof-of-concept (POC).
Example:
orders-api (ready for UAT)
inventory-api (still under development) -
Run the extractor pipeline for apim-dev, pushing configurations to the dev branch.
-
Merge the dev branch into the uat branch to promote APIs to UAT.
-
Run the APIOps publisher pipeline for the uat environment.
-
Observe that the publisher pipeline publishes all APIs from the dev branch (both orders-api and inventory-api) to apim-uat.
- Dominant language
- C#
- Stars
- 448
- Forks
- 247
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/apiops
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
[Feat] 조합 영역 구분선 개선 Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100