Skip to content

Commit

Permalink
Updated the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Wael Kdouh committed Jan 25, 2023
1 parent 9e6264c commit f669bdb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/apiops/4-extractApimArtifacts/apiops-github-3-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ nav_order: 2

The extractor tool will be required under Scenario A (Users Who Build APIs Using the Azure Portal). Under Scenario B you don't need to utilize the extractor tool to generate the artifacts as the artifacts will be created in the IDE. Having said that, nothing prevents you from utilizing the extractor tool to generate the initial artifacts if you are introducing the tool to an existing APIM instance.

1. Head to the actions section within your repository and manually run the "Run - Extractor" workflow. ![pipeline variable group](../../assets/images/GithubActionsRunExtractor.png)
1. Before you run the extractor for the first time the GH Actions bot needs "read and write permissions" as well as the checked "Allow GitHub Actions to create and approve pull requests". These settings can be found under the settings section within your repository. ![pipeline variable group](../../assets/images/GithubWorkflowPermissions.png)
2. Head to the actions section within your repository and manually run the "Run - Extractor" workflow. ![pipeline variable group](../../assets/images/GithubActionsRunExtractor.png)

3. Under **Pull requests** section on your github repo, you should see a new pull request with the extracted artifacts. **Don't merge the Pull Request yet** as we still need to configure the Run-Publisher.yaml file in the next section before we merge. You can always rerun the pipeline to refresh your repository with the latest Azure changes.
![create-pr-extractor](../../assets/images/PullRequest.png)
Expand Down
Binary file added docs/assets/images/GithubWorkflowPermissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f669bdb

Please sign in to comment.