Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Any repo changes beyond docs require PM owner approval.
* @localden @jmprieur

# Conceptual and API content needs the review of the engineering team.
msal-python-conceptual/* @MicrosoftDocs/identity-sdk-cca-engineering-team

# API documentation does not have code owners, but that is OK.
# Anyone can create a PR to the `main` branch and we will review
# the changes on the one-off basis.
python/
82 changes: 0 additions & 82 deletions .github/policies/auto-label-pr.yml

This file was deleted.

51 changes: 0 additions & 51 deletions .github/policies/auto-merge-sync-pr.yml

This file was deleted.

46 changes: 46 additions & 0 deletions .github/policies/handle-automatic-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
id:
name: GitOps.PullRequestIssueManagement
description: GitOps.PullRequestIssueManagement primitive
owner:
resource: repository
disabled: false
where:
configuration:
resourceManagementConfiguration:
eventResponderTasks:
- description: Sync API documentation to staging environment.
triggerOnOwnActions: true
if:
- payloadType: Pull_Request
- isAction:
action: Opened
- isActivitySender:
user: microsoft-github-policy-service[bot]
- titleContains:
pattern: Merge smoke-test into main
isRegex: False
then:
- addLabel:
label: ':octocat: auto-merge'
- enableAutoMerge:
mergeMethod: Squash
- approvePullRequest:
comment: ':shipit:'
- description: Sync staging environment to production.
triggerOnOwnActions: true
if:
- payloadType: Pull_Request
- isAction:
action: Opened
- isActivitySender:
user: microsoft-github-policy-service[bot]
- titleContains:
pattern: Merge main into live
isRegex: False
then:
- addLabel:
label: ':octocat: auto-merge'
- enableAutoMerge:
mergeMethod: Merge
- approvePullRequest:
comment: ':shipit:'
28 changes: 23 additions & 5 deletions .github/policies/scheduled-prod-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,36 @@ where:
configuration:
resourceManagementConfiguration:
scheduledSearches:
- description: Push to main (scheduled sync)
- description: Push to live branch (scheduled 11AM PT publish)
frequencies:
- daily:
time: 1:00
time: 18:00
filters: []
actions:
- createPullRequest:
head: main
base: live
title: Merge main into live
body: Automated merge of the main branch into live, syncing documentation content to the production environment.
- description: Push to live branch (scheduled 6PM PT publish)
frequencies:
- daily:
time: 9:00
time: 2:00
filters: []
actions:
- createPullRequest:
head: main
base: live
title: Merge main into live
body: Automated merge of the main branch into live, syncing documentation content to the production environment.
- description: Push to live branch (scheduled 2AM PT publish)
frequencies:
- daily:
time: 17:00
time: 10:00
filters: []
actions:
- createPullRequest:
head: main
base: live
title: Merge main into live
body: Please don't squash-merge this PR.
body: Automated merge of the main branch into live, syncing documentation content to the production environment.
41 changes: 41 additions & 0 deletions .github/policies/scheduled-stage-sync.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: GitOps.PullRequestIssueManagement - Scheduled PRs
description: Creates pull requests on a schedule
resource: repository

where:
configuration:
resourceManagementConfiguration:
scheduledSearches:
- description: Push to main branch (scheduled 10AM PT publish)
frequencies:
- daily:
time: 17:00
filters: []
actions:
- createPullRequest:
head: smoke-test
base: main
title: Merge smoke-test into main
body: Automated merge of the smoke-test branch into main, syncing API documentation content to the staging environment.
- description: Push to main branch (scheduled 5PM PT publish)
frequencies:
- daily:
time: 1:00
filters: []
actions:
- createPullRequest:
head: smoke-test
base: main
title: Merge smoke-test into main
body: Automated merge of the smoke-test branch into main, syncing API documentation content to the staging environment.
- description: Push to main branch (scheduled 1AM PT publish)
frequencies:
- daily:
time: 9:00
filters: []
actions:
- createPullRequest:
head: smoke-test
base: main
title: Merge smoke-test into main
body: Automated merge of the smoke-test branch into main, syncing API documentation content to the staging environment.
23 changes: 0 additions & 23 deletions .github/policies/scheduled-sync.yml

This file was deleted.

23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# Microsoft Authentication Library (MSAL) for Python Documentation
# Microsoft Authentication Library (MSAL) for Python

[![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)

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).
This is the **documentation repository** for Microsoft Authentication Library (MSAL) for Python.

| Resource | Location |
|:-----------------------------|:-----------|
| ✅ **SDK Repository** | [`AzureAD/microsoft-authentication-library-for-python`](https://github.com/AzureAD/microsoft-authentication-library-for-python) |
| ✅ **SDK Package** | [`msal`](https://pypi.org/project/msal/) |
| ✅ **SDK Documentation** | [MSAL for Python on Microsoft Learn](https://learn.microsoft.com/entra/msal/python/) |
| 🔒 **SDK Documentation CI Job** | [Azure Pipelines](https://apidrop.visualstudio.com/Content%20CI/_build?definitionId=61691) |

## Contributions

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.

> **Warning**
> **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.

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.
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.

## API reference documentation automation
## API Documentation

Continuous Integration (CI) jobs for this repository are available in the [automation Azure DevOps instance](https://apidrop.visualstudio.com/Content%20CI/_build?definitionId=6169).
**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.

>**Note**
>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.
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.

## Microsoft Open Source Code of Conduct

Expand Down
Loading