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
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,12 @@ To dive into the world of GitHub automation with PowerShell, follow the sections
Download and install the GitHub PowerShell module from the PowerShell Gallery with the following command:

```powershell
Install-Module -Name GitHub -Force -AllowClobber
Install-PSResource -Name GitHub -Repository PSGallery -TrustRepository
```

### Logging on

Authenticate using your GitHub credentials or access tokens to begin executing commands. Tokens and other
configuration details are stored encrypted on the system using the PowerShell modules [SecretManagement and SecretStore Overview](https://learn.microsoft.com/en-us/powershell/utility-modules/secretmanagement/overview?view=ps-modules),
for more info on the implementation, see the section on storing configuration.
Authenticate using your GitHub credentials or access tokens to begin executing commands. The module supports multiple authentication methods.

#### Device flow

Expand Down Expand Up @@ -107,6 +105,32 @@ Connect-GitHubAccount
✓ Logged in as system!
```

#### Using a GitHub App

If you are using a GitHub App, you can use the `Connect-GitHubApp` command to authenticate using the client ID and private key.

```powershell
Connect-GitHubApp -ClientId 'lv123456789' -PrivateKey '-----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY-----'
✓ Logged in as my-github-app!
```

#### Using a different host

If you are using GitHub Enterprise, you can use the `-Host` parameter to specify the host you want to connect to.
This can be used in combination with all the other authentication methods.

```powershell
Connect-GitHubAccount -Host 'https://github.local'
✓ Logged in as octocat!
```

Or you might be using GitHub Enterprise Cloud with Data Residency.

```powershell
Connect-GitHubAccount -Host 'https://msx.ghe.com'
✓ Logged in as octocat!
```

### Command Exploration

Familiarize yourself with the available cmdlets using the module's comprehensive documentation or inline help.
Expand Down
45 changes: 0 additions & 45 deletions src/en-US/about_Auth.help.txt

This file was deleted.

107 changes: 0 additions & 107 deletions src/en-US/about_Config.help.txt

This file was deleted.

9 changes: 5 additions & 4 deletions tools/dev/Get-GitHubAppInstallations.ps1
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@

#List installations for the authenticated app
Invoke-RestMethod -Uri 'https://api.github.com/app/installations' -Headers @{
Authorization = "Bearer $token"
}
# #List installations for the authenticated app
# Implemented...
# Invoke-RestMethod -Uri 'https://api.github.com/app/installations' -Headers @{
# Authorization = "Bearer $token"
# }


#Get an organization installation for the authenticated app
Expand Down
Loading