Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to manage Autolink references on a repository #368

Open
henkmeulekamp opened this issue Sep 26, 2022 · 1 comment
Open

Add option to manage Autolink references on a repository #368

henkmeulekamp opened this issue Sep 26, 2022 · 1 comment
Labels
api completeness This is basic API functionality that hasn't been implemented yet. api-repositories Work to complete the API's defined here: https://developer.github.com/v3/repos/ enhancement An issue or pull request introducing new functionality to the project.

Comments

@henkmeulekamp
Copy link

Feature Idea Summary

I would like the PowerShellForGitHub be able to manage the autolink references on a given repository.
https://docs.github.com/en/rest/repos/autolinks#create-an-autolink-reference-for-a-repository

{
"id": 1,
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=",
"is_alphanumeric": true
}

Feature Idea Additional Details

Add the following to get existing list of autolinks, create a new, or remove a given auto-reference

Example

Get-GitHubRepositoryAutoLink  [-OwnerName <String>] [-RepositoryName <String>] [-AccessToken <String>]

New-GitHubRepositoryAutoLink  [-OwnerName <String>] [-RepositoryName <String>] [-AccessToken <String>] 
  [-KeyPrefix <String>]  [-UrlTemplate <String>]  [-IsAlphaNumeric] 

Remove-GitHubRepositoryAutoLink  [-OwnerName <String>] [-RepositoryName <String>] [-AccessToken <String>] 
  [-AutoLinkId] <Int64> [-Force] [-WhatIf] [-Confirm]

Requested Assignment

  • If possible, I would like to implement this.

Operating System

OsName : Microsoft Windows 11 Pro
OsOperatingSystemSKU : 48
OsArchitecture : 64-bit
WindowsVersion : 2009
WindowsBuildLabEx : 22000.1.amd64fre.co_release.210604-1628
OsLanguage : en-US
OsMuiLanguages : {en-US, en-GB}

PowerShell Version

Name Value


PSVersion 7.2.6
PSEdition Core
GitCommitId 7.2.6
OS Microsoft Windows 10.0.22000
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0

Module Version

Running:
Installed: 0.16.1

@henkmeulekamp henkmeulekamp added enhancement An issue or pull request introducing new functionality to the project. triage needed An issue that needs to be reviewed by a member of the team. labels Sep 26, 2022
@HowardWolosky HowardWolosky added api completeness This is basic API functionality that hasn't been implemented yet. api-repositories Work to complete the API's defined here: https://developer.github.com/v3/repos/ and removed triage needed An issue that needs to be reviewed by a member of the team. labels Sep 26, 2022
@HowardWolosky
Copy link
Member

Thanks for the suggestion, @henkmeulekamp. Sounds good -- go ahead and start working on it if you'd like.
The main question I have around the API design is [-IsAlphaNumeric]. According to the docs, the published API defaults to true for that. Are you suggestion changing the default behavior such that users must supply that switch? If not, then I think you'd want to change your design so that the switch is named [IsNumericOnly] or something similar so that if left off, we still get the published default behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api completeness This is basic API functionality that hasn't been implemented yet. api-repositories Work to complete the API's defined here: https://developer.github.com/v3/repos/ enhancement An issue or pull request introducing new functionality to the project.
Projects
None yet
Development

No branches or pull requests

2 participants