Skip to content

Commit

Permalink
Merge pull request #205 from MicrosoftDocs/localden/policy-fixes
Browse files Browse the repository at this point in the history
Update policies
  • Loading branch information
localden authored Nov 1, 2024
2 parents c9c91a2 + 06544f9 commit 50d4e35
Show file tree
Hide file tree
Showing 8 changed files with 133 additions and 170 deletions.
10 changes: 10 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
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-java-articles/* @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.
java/
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.

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

[![Validate content links](https://github.com/MicrosoftDocs/microsoft-authentication-library-java/actions/workflows/linkchecker.yml/badge.svg)](https://github.com/MicrosoftDocs/microsoft-authentication-library-java/actions/workflows/linkchecker.yml)

This is the documentation repository for Microsoft Authentication Library (MSAL) for Java. If you are looking for the library, refer to [AzureAD/microsoft-authentication-library-for-java](https://github.com/AzureAD/microsoft-authentication-library-for-java).
This is the **documentation repository** for Microsoft Authentication Library (MSAL) for Java.

| Resource | Location |
|:-----------------------------|:-----------|
|**SDK Repository** | [`AzureAD/microsoft-authentication-library-for-java`](https://github.com/AzureAD/microsoft-authentication-library-for-java) |
|**SDK Package** | [`msal4j`](https://mvnrepository.com/artifact/com.microsoft.azure/msal4j) |
|**SDK Documentation** | [MSAL for Java on Microsoft Learn](https://learn.microsoft.com/en-us/entra/msal/java/) |
| 🔒 **SDK Documentation CI Job** | [Azure Pipelines](https://apidrop.visualstudio.com/Content%20CI/_build?definitionId=5249) |

## 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 `java/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-java](https://github.com/AzureAD/microsoft-authentication-library-for-java) 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-java/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-java/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?definitionScope=%5CPROD%5CGitHub_MicrosoftDocs_microsoft-authentication-library-java).
**Do not** modify any XML files in the `java/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.

In this repository, `package.json` on the `main` branch determines what version of `msal4j` the documentation is generated for.
To make changes to any API docs you will need to open a pull request in the [`AzureAD/microsoft-authentication-library-for-java`](https://github.com/AzureAD/microsoft-authentication-library-for-java) repository and amend code comments.

## Microsoft Open Source Code of Conduct

Expand Down

0 comments on commit 50d4e35

Please sign in to comment.