Skip to content

Commit 46a303d

Browse files
committed
Update policies and README
1 parent 53afbf6 commit 46a303d

File tree

8 files changed

+133
-171
lines changed

8 files changed

+133
-171
lines changed

.github/CODEOWNERS

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Any repo changes beyond docs require PM owner approval.
2+
* @localden @jmprieur
3+
4+
# Conceptual and API content needs the review of the engineering team.
5+
msal-python-conceptual/* @MicrosoftDocs/identity-sdk-cca-engineering-team
6+
7+
# API documentation does not have code owners, but that is OK.
8+
# Anyone can create a PR to the `main` branch and we will review
9+
# the changes on the one-off basis.
10+
python/

.github/policies/auto-label-pr.yml

Lines changed: 0 additions & 82 deletions
This file was deleted.

.github/policies/auto-merge-sync-pr.yml

Lines changed: 0 additions & 51 deletions
This file was deleted.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
id:
2+
name: GitOps.PullRequestIssueManagement
3+
description: GitOps.PullRequestIssueManagement primitive
4+
owner:
5+
resource: repository
6+
disabled: false
7+
where:
8+
configuration:
9+
resourceManagementConfiguration:
10+
eventResponderTasks:
11+
- description: Sync API documentation to staging environment.
12+
triggerOnOwnActions: true
13+
if:
14+
- payloadType: Pull_Request
15+
- isAction:
16+
action: Opened
17+
- isActivitySender:
18+
user: microsoft-github-policy-service[bot]
19+
- titleContains:
20+
pattern: Merge smoke-test into main
21+
isRegex: False
22+
then:
23+
- addLabel:
24+
label: ':octocat: auto-merge'
25+
- enableAutoMerge:
26+
mergeMethod: Squash
27+
- approvePullRequest:
28+
comment: ':shipit:'
29+
- description: Sync staging environment to production.
30+
triggerOnOwnActions: true
31+
if:
32+
- payloadType: Pull_Request
33+
- isAction:
34+
action: Opened
35+
- isActivitySender:
36+
user: microsoft-github-policy-service[bot]
37+
- titleContains:
38+
pattern: Merge main into live
39+
isRegex: False
40+
then:
41+
- addLabel:
42+
label: ':octocat: auto-merge'
43+
- enableAutoMerge:
44+
mergeMethod: Merge
45+
- approvePullRequest:
46+
comment: ':shipit:'

.github/policies/scheduled-prod-sync.yml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,36 @@ where:
66
configuration:
77
resourceManagementConfiguration:
88
scheduledSearches:
9-
- description: Push to main (scheduled sync)
9+
- description: Push to live branch (scheduled 11AM PT publish)
1010
frequencies:
1111
- daily:
12-
time: 1:00
12+
time: 18:00
13+
filters: []
14+
actions:
15+
- createPullRequest:
16+
head: main
17+
base: live
18+
title: Merge main into live
19+
body: Automated merge of the main branch into live, syncing documentation content to the production environment.
20+
- description: Push to live branch (scheduled 6PM PT publish)
21+
frequencies:
1322
- daily:
14-
time: 9:00
23+
time: 2:00
24+
filters: []
25+
actions:
26+
- createPullRequest:
27+
head: main
28+
base: live
29+
title: Merge main into live
30+
body: Automated merge of the main branch into live, syncing documentation content to the production environment.
31+
- description: Push to live branch (scheduled 2AM PT publish)
32+
frequencies:
1533
- daily:
16-
time: 17:00
34+
time: 10:00
1735
filters: []
1836
actions:
1937
- createPullRequest:
2038
head: main
2139
base: live
2240
title: Merge main into live
23-
body: Please don't squash-merge this PR.
41+
body: Automated merge of the main branch into live, syncing documentation content to the production environment.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: GitOps.PullRequestIssueManagement - Scheduled PRs
2+
description: Creates pull requests on a schedule
3+
resource: repository
4+
5+
where:
6+
configuration:
7+
resourceManagementConfiguration:
8+
scheduledSearches:
9+
- description: Push to main branch (scheduled 10AM PT publish)
10+
frequencies:
11+
- daily:
12+
time: 17:00
13+
filters: []
14+
actions:
15+
- createPullRequest:
16+
head: smoke-test
17+
base: main
18+
title: Merge smoke-test into main
19+
body: Automated merge of the smoke-test branch into main, syncing API documentation content to the staging environment.
20+
- description: Push to main branch (scheduled 5PM PT publish)
21+
frequencies:
22+
- daily:
23+
time: 1:00
24+
filters: []
25+
actions:
26+
- createPullRequest:
27+
head: smoke-test
28+
base: main
29+
title: Merge smoke-test into main
30+
body: Automated merge of the smoke-test branch into main, syncing API documentation content to the staging environment.
31+
- description: Push to main branch (scheduled 1AM PT publish)
32+
frequencies:
33+
- daily:
34+
time: 9:00
35+
filters: []
36+
actions:
37+
- createPullRequest:
38+
head: smoke-test
39+
base: main
40+
title: Merge smoke-test into main
41+
body: Automated merge of the smoke-test branch into main, syncing API documentation content to the staging environment.

.github/policies/scheduled-sync.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
1-
# Microsoft Authentication Library (MSAL) for Python Documentation
1+
# Microsoft Authentication Library (MSAL) for Python
22

33
[![Validate existing links](https://github.com/MicrosoftDocs/microsoft-authentication-library-for-python/actions/workflows/linkvalidator.yml/badge.svg)](https://github.com/MicrosoftDocs/microsoft-authentication-library-for-python/actions/workflows/linkvalidator.yml)
44

5-
This is the documentation repository for Microsoft Authentication Library (MSAL) for Python. If you are looking for the library, refer to [AzureAD/microsoft-authentication-library-for-python](https://github.com/AzureAD/microsoft-authentication-library-for-python).
5+
This is the **documentation repository** for Microsoft Authentication Library (MSAL) for Python.
6+
7+
| Resource | Location |
8+
|:-----------------------------|:-----------|
9+
|**SDK Repository** | [`AzureAD/microsoft-authentication-library-for-python`](https://github.com/AzureAD/microsoft-authentication-library-for-python) |
10+
|**SDK Package** | [`msal`](https://pypi.org/project/msal/) |
11+
|**SDK Documentation** | [MSAL for Python on Microsoft Learn](https://learn.microsoft.com/entra/msal/python/) |
12+
| 🔒 **SDK Documentation CI Job** | [Azure Pipelines](https://apidrop.visualstudio.com/Content%20CI/_build?definitionId=61691) |
613

714
## Contributions
815

916
Contributions to our documentation are welcome. Make sure to familiarize yourself with the [Microsoft Writing Style Guide](https://learn.microsoft.com/style-guide/welcome/) and the [Contributor Guide](https://learn.microsoft.com/contribute/) before making any changes.
1017

11-
> **Warning**
12-
> **Do not** modify any YML files in the `python/docs-ref-autogen` folder - those are generated automatically from the library source code and any changes will be automatically overwritten the next time the documentation Continuous Integration (CI) job runs. To make changes to any API docs you will need to open a pull request in the [AzureAD/microsoft-authentication-library-for-python](https://github.com/AzureAD/microsoft-authentication-library-for-python) repository.
13-
14-
If you would like to author an entirely new document (e.g., for a new scenario), make sure to [open an issue](https://github.com/MicrosoftDocs/microsoft-authentication-library-for-python/issues) first. This will allow the engineering team to discuss the proposed changes and ensure that it won't be overwritten by future changes.
18+
If you would like to author an entirely new document (e.g., for a new scenario), make sure to [open an issue](https://github.com/AzureAD/microsoft-authentication-library-for-python/issues) first. This will allow the engineering team to discuss the proposed changes and ensure that it won't be overwritten by future changes.
1519

16-
## API reference documentation automation
20+
## API Documentation
1721

18-
Continuous Integration (CI) jobs for this repository are available in the [automation Azure DevOps instance](https://apidrop.visualstudio.com/Content%20CI/_build?definitionId=6169).
22+
**Do not** modify any XML files in the `python/docs-ref-autogen` folder - those are generated automatically from the library source code and any changes will be automatically overwritten the next time the documentation runs.
1923

20-
>**Note**
21-
>The changes from the CI job will always be pushed to the `smoke-test` branch first. To propagate them to production, merge the changes into `main`, and then merge `main` to `live`. Ensure that all checks pass before merging changes.
24+
To make changes to any API docs you will need to open a pull request in the [`AzureAD/microsoft-authentication-library-for-python`](AzureAD/microsoft-authentication-library-for-python) repository and amend code comments.
2225

2326
## Microsoft Open Source Code of Conduct
2427

0 commit comments

Comments
 (0)