If a user logs on (i.e. not a system PAT), print name in connect-githubaccount, and store the loged in username in config, under username.

Add support for logging in using a PAT token.

Documentation link:
https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api?apiVersion=2022-11-28#authenticating-with-a-personal-access-token

https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28

Ideally the GitHub PowerShell module should take a dependency on the CLI itself, but might be worth looking into for how it can be used with the module.

• PowerShell Crescendo

Add functionality using Device Flow to login using a GitHub App.

Default login method to GitHub App, as it is the preferred way (according to docs) to use this.

• Differences between GitHub Apps and OAuth apps | GitHub Docs

Currently the paging size is set per command that supports it, but for simplicity this could be set in the Invoke-GHAPI function and overridden when wanted. i.e. the default value gets removed from the calling function, but remains a default in the Invoke-GHAPI function and overrideable from the calling function by providing a value to the pagesize param for the function.

https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28

Derived from REST-API-Description.

Get the component section and automatically build class(ps1 in classes folder) or type (ps1xml) files. Use the classes as input/return objects in functions.

To avoid having too many config places (files classes and multiple vaults), we want to consolidate and bring all config to a SecretVault using SecretManagement.

This will allow the module to configure the configuration on the store separate from other config that users might have on SecretStore and other providers.

The vault should be able to hold different profiles of users along with having one for the

https://docs.github.com/en/rest/users/ssh-signing-keys?apiVersion=2022-11-28#about-ssh-signing-key-administration

This is a new issue

https://docs.github.com/en/rest/repos/forks?apiVersion=2022-11-28

Change the current implementation of wrapping the Invoke-GitHubApi in paranthesis and accessing the Response value. Instead, pipe for foreach and Write-Output the $_.Response. Optionally add the other fields as a write-verbose

    Invoke-GitHubAPI @inputObject | ForEach-Object {
        Write-Output $_.Response
    }

https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28

Add functionality to login using any of the well known environment variables as described in GitHub CLI documentation:

• gh auth login | GitHub CLI
• gh environment | GitHub CLI
• Automatic token authentication | GitHub Docs

MicrosoftDocs/PowerShell-Docs#4383

Check for releases in https://github.com/cli/cli to get info on the the newest features

This will help align the functionality of the GitHub module with the CLI

Add a configuration store that is supported cross platform.
The store must support storing secrets and other configuration items.
The content must be encrypted while on disk.

API docs: https://www.githubstatus.com/api

Rulesets control how people can interact with selected branches and tags in a repository.

https://docs.github.com/en/rest/repos/rules?apiVersion=2022-11-28

Special cases:
Method Put - Depends on endpoint I.e enable/disable, Start/Stop

Verb Set - Reserved for anything that is of a declarative nature. For endpoints that are not declarative already, create a wrapper function that provides the declarative functionality by combining methods Get + patch/put. The declarative functions should also provide a diff if running with -WhatIf.

Use impact on functions to determine if confirmation should be requested. This could be on activities such as remove/delete org/repo. For these we add -Force switch.

Places where there are only get and put methods available, create wrapper functions that provide add and remove functionality.

Implement the functions on the Users namespace.

Make sure that the code does not create multiple issues for a given tag.

Tags could be:

• # BUG - #BUG -> Tag issue with bug
• # HACK - #HACK -> Tag issue with Dept
• # FIXME - #FIXME -> Tag issue with Dept
• # TODO - #TODO -> Tag issue with Feature?
• # DEBUG - #DEBUG -> Tag issue with Dept?

https://docs.github.com/en/rest/users/emails?apiVersion=2022-11-28

https://docs.github.com/en/rest/repos/rule-suites?apiVersion=2022-11-28

Add detection when running commands to see when the access token expires.

• If running Connect-GitHubAccount with a valid access token, do not prompt again, just refresh. This chould also make the refresh parameter redundant.
• When running commands and the token is expired, automatically refresh, then run the command.

When running Connect-GitHubAccount -Refresh without an available access token, I was sent through the regular Device Flow with Device Code.
When submitting the code in browser, i got the following error:

https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28

Add the commands under the Organization namespace

https://docs.github.com/en/rest/orgs?apiVersion=2022-11-28

Using the available OpenAPI spec from GitHub, create a function that scaffolds or fully creates a function that covers a given path of the spec.

The function builder should be able to take fields from the OpenAPI description to make some patterns of the function.

• Namespace suggestion
• Name of the function
• Comment based documentation with:
  • Synopsis
  • Desciption
  • Parameter description
• Write a warning if the token is of type GitHubApp to warn which functions are not supported

Tools to consider:

• AutoRest - Issues though!
• OpenAI - How though?
• PowerShell directly with the GitHub OpenAPI description. - Time though! -> But more control...

https://docs.github.com/en/rest/gitignore/gitignore?apiVersion=2022-11-28#about-gitignore

To not interrupt the user when running commands interactively, the access token for a user logging in with GitHub app should auto refresh.

This can be done when functions are called and the access token has reached a half- life or expired.

https://docs.github.com/en/rest/repos/tags?apiVersion=2022-11-28

https://docs.github.com/en/rest/repos/autolinks?apiVersion=2022-11-28

The less preferred approach to signing, but still a valid approach.

Spec:

• Should not be the default approach.
• Should support a known default set of scopes (GH CLI is a good reference as it is still using the OAuth approach).

Setup the basics needed for the PSModule framework to work in the repo.

• Trigger on any branch
• Default perform build, test and publish

https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28

When running Get-GitHubConfig the order of data is never the same. This would look so much better if we just sorted alphabetically.

https://docs.github.com/en/rest/licenses/licenses?apiVersion=2022-11-28

https://docs.github.com/en/rest/rate-limit/rate-limit?apiVersion=2022-11-28#get-rate-limit-status-for-the-authenticated-user

Get a reference from the following repo and compare with what is covered in the module

• https://github.com/github/rest-api-description

Create issues when a new feature is introduced

If scope of commands are org, repo or authenticated users, check that the PowerShell for GitHub GitHub App is installed for that scope.