Skip to content

Commit

Permalink
docs(readme) clarify variables
Browse files Browse the repository at this point in the history
  • Loading branch information
sassdawe committed Apr 14, 2024
1 parent 7666ba5 commit 2345896
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: 'PnP PowerShell Sharing Settings as Code'
description: 'Define and enforce SharePoint Online sharing settings with GitHub Actions. If "ALLELSE" is used for any of the settings (but only for ONE), it will apply to all sites which were NOT specified in the other settings. If "null" is used for any of the settings, it will skip that setting.'
description: 'Define and enforce SharePoint Online sharing settings with GitHub Actions.'
inputs:
SHAREPOINT_ADMIN_URL:
description: 'URL of the SharePoint Admin Site'
required: true
CLIENT_ID:
description: 'Username of the admin'
description: 'Client Id of App Registration with SharePoint Online permissions'
required: true
CLIENT_SECRET:
description: 'Password of the admin'
description: 'Client Secret of App Registration with SharePoint Online permissions'
required: true
SHARINGCAPABILITY_DISABLED_SITES:
description: 'Comma separated list of URLS where to disable sharing capability. Or "null" or "ALLELSE".'
Expand Down
6 changes: 4 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
This action signs in into SharePoint Online using ACS and sets the sharing settings for the site collections.

> !Important: Only `windows` based runner can execute this action currently.
If `ALLELSE` is used for any of the settings (but only for **ONE** of them), it will apply that sharing capability to all the rest of the sites which were NOT specified in the other settings. If `null` is used for any of the settings, it will skip that setting.

> !Important: The v1 version requires the use of **Windows** based runners to run this action currently.
## Inputs

Expand Down Expand Up @@ -43,7 +45,7 @@ There is no output for this action.
## Example usage

```yaml
uses: actions/pnp-sharing-settings-action@e76147da8e5c81eaf017dede5645551d4b94427b
uses: actions/pnp-sharing-settings-action@v1
with:
SHAREPOINT_ADMIN_URL: 'https://contoso-admin.sharepoint.com'
CLIENT_ID: ${{ secrets.CLIENT_ID }}
Expand Down

0 comments on commit 2345896

Please sign in to comment.