Add support for repository autolink #371

henkmeulekamp · 2022-10-04T20:07:56Z

Description

Implement basic support for autolinks (s) on a repository.

I'm quite new to writing PowerShell Modules, let me know If I missed something.

Issues Fixed

Implements Add option to manage Autolink references on a repository #368

References

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
}

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

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

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

Checklist

henkmeulekamp · 2022-10-04T20:13:42Z

@microsoft-github-policy-service agree

HowardWolosky

Thanks for the contribution, @henkmeulekamp! Impressive job for your first attempt at writing some PowerShell code.

It looks like there's still some work to be done in here before it can be merged, but you're very far along on the journey here.

Looking forward to seeing the next update.

HowardWolosky · 2022-10-04T23:51:21Z

PowerShellForGitHub.psd1

@@ -7,7 +7,7 @@
    CompanyName = 'Microsoft Corporation'
    Copyright = 'Copyright (C) Microsoft Corporation.  All rights reserved.'

-    ModuleVersion = '0.16.1'
+    ModuleVersion = '0.17.0'


Please don't modify the version with your change. This only happens when a new module version is being released.

HowardWolosky · 2022-10-04T23:58:12Z

USAGE.md

+
+#### Create a new autolink
+```powershell
+New-GitHubRepositoryAutolink -OwnerName microsoft -RepositoryName PowerShellForGitHub -UriPrefix PRJ- -Urltemplate https://company.issuetracker.com/browse/prj-<num>


Suggested change

New-GitHubRepositoryAutolink -OwnerName microsoft -RepositoryName PowerShellForGitHub -UriPrefix PRJ- -Urltemplate https://company.issuetracker.com/browse/prj-<num>

New-GitHubRepositoryAutolink -OwnerName microsoft -RepositoryName PowerShellForGitHub -KeyPrefix 'PRJ-' -UrlTemplate 'https://company.issuetracker.com/browse/prj-<num>'

HowardWolosky · 2022-10-04T23:59:13Z

GitHubRepositoryAutolink.ps1

+    .OUTPUTS
+        GitHub.RepositoryAutolink
+
+    .EXAMPLE


Please add a .NOTES that this is restricted to repository admins only.
Example:

PowerShellForGitHub/GitHubBranches.ps1

Lines 686 to 687 in 007deb7

.NOTES

Protecting a branch requires admin or owner permissions to the repository.

Please add to all of these commands.

HowardWolosky · 2022-10-05T00:02:03Z

GitHubRepositoryAutolink.ps1

+        The OwnerName and RepositoryName will be extracted from here instead of needing to provide
+        them individually.
+
+    .PARAMETER Sort


Not relevant for this API. Copy/paste error?

HowardWolosky · 2022-10-05T00:02:20Z

GitHubRepositoryAutolink.ps1

+        [Alias('RepositoryUrl')]
+        [string] $Uri,
+
+        [ValidateSet('Newest', 'Oldest', 'Stargazers')]


Not relevant for this API. Copy/paste error?

HowardWolosky · 2022-10-06T16:59:46Z

GitHubRepositoryAutolink.ps1

+                Add-Member -InputObject $item -Name 'AutolinkId' -Value $item.id -MemberType NoteProperty -Force
+            }
+
+            Add-Member -InputObject $item -Name 'AutolinkKeyPrefix' -Value $item.key_prefix -MemberType NoteProperty -Force


Suggested change

Add-Member -InputObject $item -Name 'AutolinkKeyPrefix' -Value $item.key_prefix -MemberType NoteProperty -Force

Add-Member -InputObject $item -Name 'KeyPrefix' -Value $item.key_prefix -MemberType NoteProperty -Force

HowardWolosky · 2022-10-06T17:00:05Z

GitHubRepositoryAutolink.ps1

+            }
+
+            Add-Member -InputObject $item -Name 'AutolinkKeyPrefix' -Value $item.key_prefix -MemberType NoteProperty -Force
+            Add-Member -InputObject $item -Name 'AutolinkUrlTemplate' -Value $item.url_template -MemberType NoteProperty -Force


Suggested change

Add-Member -InputObject $item -Name 'AutolinkUrlTemplate' -Value $item.url_template -MemberType NoteProperty -Force

Add-Member -InputObject $item -Name 'UrlTemplate' -Value $item.url_template -MemberType NoteProperty -Force

HowardWolosky · 2022-10-06T17:01:03Z

Tests/GitHubRepositoryAutolinks.tests.ps1

+    @{
+        defaultRepoDesc = "This is a description."
+        defaultRepoHomePage = "https://www.microsoft.com/"
+        defaultRepoTopic = "microsoft"
+    }.GetEnumerator() | ForEach-Object {
+        Set-Variable -Force -Scope Script -Option ReadOnly -Visibility Private -Name $_.Key -Value $_.Value
+    }


Where are these being used?

HowardWolosky · 2022-10-06T17:07:54Z

Tests/GitHubRepositoryAutolinks.tests.ps1

+            }
+
+            It 'Should have the expected type and additional properties' {
+                $team.PSObject.TypeNames[0] | Should -Be 'GitHub.RepositoryAutolink'


This makes me feel like you didn't validate your tests before submitting the PR since this is referencing both a variable ($team) and properties (like OranizationName) that don't exist.

HowardWolosky · 2022-10-06T17:09:40Z

Tests/GitHubRepositoryAutolinks.tests.ps1

+        Set-Variable -Force -Scope Script -Option ReadOnly -Visibility Private -Name $_.Key -Value $_.Value
+    }
+
+    Describe 'GitHubRepositoryAutolink\Get-GitHubRepositoryAutolink' {


This is a great first test, but you have a few more to add:

Retrieving a single autolink

Creating an autolink via the pipeline

etc...

Refer to some of the other test files to get an idea on the breadth of scenarios covered.

Please also take a look at the work being done in #366, and adjust your test file to be Pester 5 compliant.

- codereview comment, needed only when releasing

- requires testing - Test cleanup

henkmeulekamp · 2022-10-06T21:30:29Z

Resolved most of the comments, many thanks for bringing these up. I missed some obvious things on the first run.. maybe due to focusing to much on PowerShell working itself.

Will have another look at the tests and fix the 2 todo comments.

Many thanks for the review so far. Learning a lot of PowerShell constructs/wow. Will resubmit PR after addressing the last open points.

- num block is important and requires validation

microsoft-github-policy-service · 2023-05-09T01:46:55Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 14 days of this comment.

microsoft-github-policy-service · 2023-08-13T17:25:03Z

This pull request has been automatically closed due to a lack of activity from the author. We understand. Life happens and other things likely came up. We would still love to see your contribution get merged in. Now that it has been closed, a different community member may wish to pick up where you left off. If so, they should speak up by commenting below. If you're still interested in completing this yourself, just respond back and let us know.

henkmeulekamp and others added 10 commits September 26, 2022 22:24

First pass at adding autolink reference

f4b69be

Fix header title to plural

11922a6

Remove brand names from examples

78b7ab9

Fix for missing nestedmodule

4d92f41

Some fixes after manual testing

f4d5d31

Fixes after testing

5c83a2c

fix usage example paramvalue

9c85545

Add Tests

92cd70e

Move patch level

020a356

Update contributors

8f17ed3

henkmeulekamp changed the title ~~Feature/autolink #368~~ Add support for repository autolink #368 Oct 4, 2022

henkmeulekamp changed the title ~~Add support for repository autolink #368~~ Add support for repository autolink Oct 4, 2022

HowardWolosky requested changes Oct 6, 2022

View reviewed changes

ghost added the needs-author-feedback label Oct 6, 2022

henkmeulekamp added 5 commits October 6, 2022 21:17

revert change to version number

e7a4a3d

- codereview comment, needed only when releasing

fix param names KeyPrefix and UrlTemplate

bcb428b

Add notes mentioning required rights on autolink

cb51686

Remove copy-past mistake; Sort

7a56cd4

Better grammar

483e608

ghost removed the needs-author-feedback label Oct 6, 2022

henkmeulekamp added 6 commits October 6, 2022 22:00

More textual improvements

5b8488e

address IsNumeric vs IsNumericOnly

f8fd5c9

more efficient way to set value

4541c6b

Fix ValueFromPipelineByPropertyName Issues

0a06731

- requires testing - Test cleanup

Fix ValueFromPipelineByPropertyName 2

b044f1e

two more cleanups of copy/past code

797fb82

henkmeulekamp marked this pull request as draft October 6, 2022 20:46

henkmeulekamp added 2 commits October 6, 2022 23:06

Add option to get asingle autolink by autolinkId

1b99b81

Remove not sused param

d32b5a7

henkmeulekamp added 2 commits October 6, 2022 23:19

one fix IsPresent only on switch

9778532

fis isPresent

d467f63

fix todo on param validation

f960cf5

- num block is important and requires validation

HowardWolosky added the needs-author-feedback label Apr 30, 2023

microsoft-github-policy-service bot added the status-no-recent-activity label May 9, 2023

microsoft-github-policy-service bot closed this Aug 13, 2023

microsoft-github-policy-service bot added the auto-closed-unmerged An unmerged pull request that has been auto-closed due to lack of activity. label Aug 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for repository autolink #371

Add support for repository autolink #371

henkmeulekamp commented Oct 4, 2022

henkmeulekamp commented Oct 4, 2022

HowardWolosky left a comment

HowardWolosky Oct 4, 2022

HowardWolosky Oct 4, 2022

HowardWolosky Oct 4, 2022

HowardWolosky Oct 5, 2022

HowardWolosky Oct 5, 2022

HowardWolosky Oct 6, 2022

HowardWolosky Oct 6, 2022

HowardWolosky Oct 6, 2022

HowardWolosky Oct 6, 2022

HowardWolosky Oct 6, 2022

HowardWolosky Dec 15, 2022

henkmeulekamp commented Oct 6, 2022

microsoft-github-policy-service bot commented May 9, 2023

microsoft-github-policy-service bot commented Aug 13, 2023

	New-GitHubRepositoryAutolink -OwnerName microsoft -RepositoryName PowerShellForGitHub -UriPrefix PRJ- -Urltemplate https://company.issuetracker.com/browse/prj-<num>
	New-GitHubRepositoryAutolink -OwnerName microsoft -RepositoryName PowerShellForGitHub -KeyPrefix 'PRJ-' -UrlTemplate 'https://company.issuetracker.com/browse/prj-<num>'

	.NOTES
	Protecting a branch requires admin or owner permissions to the repository.

	Add-Member -InputObject $item -Name 'AutolinkKeyPrefix' -Value $item.key_prefix -MemberType NoteProperty -Force
	Add-Member -InputObject $item -Name 'KeyPrefix' -Value $item.key_prefix -MemberType NoteProperty -Force

	Add-Member -InputObject $item -Name 'AutolinkUrlTemplate' -Value $item.url_template -MemberType NoteProperty -Force
	Add-Member -InputObject $item -Name 'UrlTemplate' -Value $item.url_template -MemberType NoteProperty -Force

Add support for repository autolink #371

Add support for repository autolink #371

Conversation

henkmeulekamp commented Oct 4, 2022

Description

Issues Fixed

References

Checklist

henkmeulekamp commented Oct 4, 2022

HowardWolosky left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

henkmeulekamp commented Oct 6, 2022

microsoft-github-policy-service bot commented May 9, 2023

microsoft-github-policy-service bot commented Aug 13, 2023