Just received a heads-up from GitHub that the Code of Conduct API preview which uses the scarlet-witch-preview header is being deprecated on December 6, 2021.
It looks like we definitely need to do the following:
Implement Get-GitHubCommunityProfileMetrics per the new API
Then we need to do one of these two things:
Deprecate GetGitHubCodeOfConduct since it uses an API endpoint that is going away.
or
Modify Get-GitHubCodeOfConduct to use Get-GitHubCommunityProfileMetrics behind the scenes, and put the return content into the same format. This should be mostly straight-forward as most of the same data is being returned by the new API, with the exception of body and CodeOfConductKey... That means the body would have to be retrieved with an additional query after the Get-GitHubCommunityProfileMetrics call, and the $Key parameter would have to be deprecated entirely since there is no equivalent way to get that information with the new API.
My preference would be doing 2.
Reference data
This is the current output of Get-GitHubCommunityProfileMetrics for microsoft/PowerShellForGitHub
and this is the current result for Get-GitHubCodeOfConduct -OwnerName microsoft -RepositoryName PowerShellForGitHub
{
"key": "other",
"name": "Other",
"html_url": "https://github.com/microsoft/PowerShellForGitHub/blob/master/CODE_OF_CONDUCT.md",
"url": "https://api.github.com/repos/microsoft/PowerShellForGitHub/community/code_of_conduct",
"body": "# PowerShellForGitHub PowerShell Module\n\n## Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)\nor contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions\nor comments.\n",
"CodeOfConductKey": "other"
}
Issue Details
Just received a heads-up from GitHub that the
Code of Conduct
API preview which uses thescarlet-witch-preview
header is being deprecated onDecember 6, 2021
.Deprecation Notice: https://github.blog/changelog/2021-10-06-deprecation-notice-codes-of-conduct-api-preview/
It is suggested to migrate to the
Get community profile metrics
endpoint to retrieve this information.Suggested Next Steps
It looks like we definitely need to do the following:
Get-GitHubCommunityProfileMetrics
per thenew API
Then we need to do one of these two things:
GetGitHubCodeOfConduct
since it uses an API endpoint that is going away. orGet-GitHubCodeOfConduct
to useGet-GitHubCommunityProfileMetrics
behind the scenes, and put the return content into the same format. This should be mostly straight-forward as most of the same data is being returned by the new API, with the exception ofbody
andCodeOfConductKey
... That means thebody
would have to be retrieved with an additional query after theGet-GitHubCommunityProfileMetrics
call, and the$Key
parameter would have to be deprecated entirely since there is no equivalent way to get that information with the new API.My preference would be doing 2.
Reference data
This is the current output of
Get-GitHubCommunityProfileMetrics
formicrosoft/PowerShellForGitHub
and this is the current result for
Get-GitHubCodeOfConduct -OwnerName microsoft -RepositoryName PowerShellForGitHub