You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Description
This pull request includes multiple changes to update outdated
documentation links across various files. The updates ensure that all
links point to the correct and current URLs on the GitHub documentation
site.
Updates to documentation links:
*
[`.github/CODEOWNERS`](diffhunk://#diff-3d36a1bf06148bc6ba1ce2ed3d19de32ea708d955fed212c0d27c536f0bd4da7L1-R1):
Updated the link to the GitHub documentation about code owners.
*
[`.github/release.yml`](diffhunk://#diff-409fea45635f464aa0592700a92cf483be2f5b21b60f8f1b383756067ee79213L1-R1):
Updated the link to the GitHub documentation about configuring
automatically generated release notes.
*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L13-R14):
Updated multiple links to the GitHub documentation, including those for
workflow commands, context awareness, and GitHub Apps.
[[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L13-R14)
[[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L59-R59)
[[3]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L106-R106)
Updates to PowerShell scripts:
*
[`src/functions/private/Actions/Get-GitHubWorkflowRunByRepo.ps1`](diffhunk://#diff-15835fb7d9c0f2d945276051ee378bdb3300a58e5c5b29983126962ef4a9c917L25-R25):
Updated the link to the GitHub documentation for listing workflow runs
for a repository.
*
[`src/functions/private/Actions/Get-GitHubWorkflowRunByWorkflow.ps1`](diffhunk://#diff-f1a7512226243dd8be3bba8fcac74f178aae2a0f11d1e675a02d651e7cfde069L27-R27):
Updated the link to the GitHub documentation for listing workflow runs
for a workflow.
* [`src/functions/private/Apps/GitHub
Apps/Get-GitHubAppByName.ps1`](diffhunk://#diff-2446812fa850e0b15e44ea484a0ef116efbe4b5d7e22b74960faf084b4015256L15-R15):
Updated the link to the GitHub documentation for getting an app.
*
[`src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1`](diffhunk://#diff-c9f7dea521a81a196f46cb061086a358a387f3c3a1ed0892c2c008238795bab8L20-R20):
Updated the link to the GitHub documentation for refreshing user access
tokens.
*
[`src/functions/private/Teams/Get-GitHubRESTTeam.ps1`](diffhunk://#diff-efacd3612f7ed73e0426147e0fac909035328b1ea1a8f9a4a30ec5222b8666b1L23-R23):
Updated the link to the GitHub documentation for getting a team by name.
* [`src/functions/public/Actions/Workflow
Run/Get-GitHubWorkflowRun.ps1`](diffhunk://#diff-d2331f59ff3e8de019d46827a62656d820b903da4b7f62868ddcf9bd94500bc2L36-R37):
Updated multiple links to the GitHub documentation for listing workflow
runs for a workflow and repository.
* [`src/functions/public/Actions/Workflow
Run/Restart-GitHubWorkflowRun.ps1`](diffhunk://#diff-46a063c6b2c9b4adde58c1b7c790cb460edab35098374f93103ca8e75b480de0L13-R13):
Updated the link to the GitHub documentation for re-running a workflow.
* [`src/functions/public/Actions/Workflow
Run/Stop-GitHubWorkflowRun.ps1`](diffhunk://#diff-81736970139b8ec28be0acdacd46b906050ec999d78e397064e9ef77e3ecb1e9L15-R15):
Updated the link to the GitHub documentation for canceling a workflow
run.
*
[`src/functions/public/Actions/Workflow/Disable-GitHubWorkflow.ps1`](diffhunk://#diff-b18561223c819498beaf91f5e2c9a4e2784da2693b8cff1177a32f7ede62f939L4-R4):
Updated the link to the GitHub documentation for disabling a workflow.
*
[`src/functions/public/Actions/Workflow/Enable-GitHubWorkflow.ps1`](diffhunk://#diff-38ae5fe1a8cc9a6f90b7e164a80d6ee16a5b3c97e9791cedcd1f3c733155df1aL4-R4):
Updated the link to the GitHub documentation for enabling a workflow.
*
[`src/functions/public/Actions/Workflow/Get-GitHubWorkflow.ps1`](diffhunk://#diff-cd2cdd719bba4347994dc205293761bbc000b5db3cb03ea7a583f7a298992137L22-R22):
Updated the link to the GitHub documentation for listing repository
workflows.
*
[`src/functions/public/Actions/Workflow/Get-GitHubWorkflowUsage.ps1`](diffhunk://#diff-71fae8086354c206780b979779b2b2c20e0d8b2ae8a8ac48e20d14971cd37986L13-R13):
Updated the link to the GitHub documentation for getting workflow usage.
*
[`src/functions/public/Actions/Workflow/Start-GitHubWorkflow.ps1`](diffhunk://#diff-4c9b81a5835b2db40ecc843cb10c1953f164d2765eeca76008654cd2d776b04eL18-R18):
Updated the link to the GitHub documentation for creating a workflow
dispatch event.
* [`src/functions/public/Apps/GitHub
App/Get-GitHubApp.ps1`](diffhunk://#diff-eb4b0ed1f801228094dc7d155d3b2cd9a7a417d294ead8583bdfa87e455efcd5L20-R20):
Updated the link to the GitHub documentation for getting an app.
* [`src/functions/public/Apps/GitHub
App/Get-GitHubAppJSONWebToken.ps1`](diffhunk://#diff-24a011fa6d25c6e8c7a27949f842a0a45d3ae10a3acb7aac07eb82f69ff5ae79L23-R23):
Updated the link to the GitHub documentation for generating a JSON Web
Token (JWT) for a GitHub App.
*
[`src/functions/public/Auth/Get-GitHubViewer.ps1`](diffhunk://#diff-1e75a435cc90f52258e3aaf9a383c90364e919582164d7745fd70d2e1e6bf7deL15-R15):
Updated the link to the GitHub documentation for the GraphQL API -
Queries - Viewer.
*
[`src/functions/public/Commands/Add-GitHubMask.ps1`](diffhunk://#diff-7b4a7930ce1b4175bf9bcdd31d6ec8492cf451f0c8d9e387fcb0a97c70b7a709L23-R23):
Updated the link to the GitHub documentation for masking a value in a
log.
## Type of change
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [x] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]
## Checklist
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
Copy file name to clipboardExpand all lines: README.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,8 @@ and GitHub enthusiasts who want to use PowerShell to integrate or manage GitHub
10
10
with multiple accounts; be that GitHub (public, github.com), GitHub Enterprise Cloud (GHEC, including GHE.com) and GitHub Enterprise Server (GHES).
11
11
-**A great GitHub Action Workflow companion**
12
12
The module is built to be a companion in GitHub Actions. It comes with PowerShell-flavored
13
-
[workflow-commands](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions) and
14
-
is [context aware](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs).
13
+
[workflow-commands](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions) and
14
+
is [context aware](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs).
15
15
So it detects how it is being used and loads available information dynamically. You can provide it the `GITHUB_TOKEN`, a client ID and private key
16
16
for a GitHub App, or a user access token (fine-grained or classic). In addition to be a great local scripting companion, it also understands when
17
17
its run in GitHub Actions where it will automatically detect the event that triggered the workflow and provide the necessary context to commands. So
@@ -56,7 +56,7 @@ This is the recommended method for authentication due to access tokens being sho
56
56
It opens a browser window and prompts you to log in to GitHub. Once you log in, you will be provided with
57
57
a code that you need to paste into the PowerShell console. The command already puts the code in your clipboard.
58
58
It uses a GitHub App to authenticate, which is more secure than using a personal access token. The GitHub App
59
-
is only granted access to the organizations or repositories you install it on. Visit the [GitHub Apps documentation](https://docs.github.com/en/developers/apps/about-apps)
59
+
is only granted access to the organizations or repositories you install it on. Visit the [GitHub Apps documentation](https://docs.github.com/developers/apps/about-apps)
60
60
to read more about GitHub Apps. You can also use a different GitHub App to issue user access tokens, check the section on
61
61
[Using a different GitHub App for issuing User access tokens](#using-a-different-github-app-for-issuing-user-access-tokens) for more information.
62
62
@@ -103,7 +103,7 @@ Connect-GitHubAccount
103
103
104
104
This uses the same flow as above, but instead of using the GitHub App, it uses an OAuth app with long lived tokens.
105
105
During the signing you can also authorize the app to access your private repositories.
106
-
Visit the [OAuth apps documentation](https://docs.github.com/en/developers/apps/about-apps) to read more about OAuth apps on GitHub.
106
+
Visit the [OAuth apps documentation](https://docs.github.com/developers/apps/about-apps) to read more about OAuth apps on GitHub.
Copy file name to clipboardExpand all lines: src/functions/public/Apps/GitHub App/Get-GitHubAppJSONWebToken.ps1
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@
20
20
System.String
21
21
22
22
.NOTES
23
-
[Generating a JSON Web Token (JWT) for a GitHub App | GitHub Docs](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app#example-using-powershell-to-generate-a-jwt)
23
+
[Generating a JSON Web Token (JWT) for a GitHub App | GitHub Docs](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app#example-using-powershell-to-generate-a-jwt)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Add-GitHubMask.ps1
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@
20
20
Masks the value of $SecretValue1 and $SecretValue2 so that its printed like ***, using the pipeline
21
21
22
22
.NOTES
23
-
[Masking a value in a log](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#masking-a-value-in-a-log)
23
+
[Masking a value in a log](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#masking-a-value-in-a-log)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Add-GitHubSystemPath.ps1
+1-1
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@
12
12
Add-GitHubSystemPath -Path '$HOME/.local/bin'
13
13
14
14
.NOTES
15
-
[Adding a system path](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path)
15
+
[Adding a system path](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Disable-GitHubCommand.ps1
+1-1
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@
16
16
Stops processing any workflow commands.
17
17
18
18
.NOTES
19
-
[Stopping and starting workflow commands](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#stopping-and-starting-workflow-commands)
19
+
[Stopping and starting workflow commands](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#stopping-and-starting-workflow-commands)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Enable-GitHubCommand.ps1
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@
15
15
Resumes processing any workflow commands.
16
16
17
17
.NOTES
18
-
[Stopping and starting workflow commands](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#stopping-and-starting-workflow-commands)
18
+
[Stopping and starting workflow commands](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#stopping-and-starting-workflow-commands)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1
+1-1
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@
10
10
Set-GitHubEnv -Name 'MyVariable' -Value 'MyValue'
11
11
12
12
.NOTES
13
-
[Setting an environment variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable)
13
+
[Setting an environment variable](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1
+1-1
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@
24
24
Groups commands where no workflow commands are run, using an alias and DSL approach.
25
25
26
26
.NOTES
27
-
[Stopping and starting workflow commands](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#stopping-and-starting-workflow-commands)
27
+
[Stopping and starting workflow commands](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#stopping-and-starting-workflow-commands)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Set-GitHubStepSummary.ps1
+2-2
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@
10
10
11
11
Job summaries support GitHub flavored Markdown, and you can add your Markdown content for a step to the `GITHUB_STEP_SUMMARY`
12
12
environment file. `GITHUB_STEP_SUMMARY` is unique for each step in a job. For more information about the per-step file that
13
-
`GITHUB_STEP_SUMMARY` references, see [Environment files](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions?utm_source=chatgpt.com#environment-files).
13
+
`GITHUB_STEP_SUMMARY` references, see [Environment files](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions?utm_source=chatgpt.com#environment-files).
14
14
15
15
When a job finishes, the summaries for all steps in a job are grouped together into a single job summary and are shown on the
16
16
workflow run summary page. If multiple jobs generate summaries, the job summaries are ordered by job completion time.
@@ -19,7 +19,7 @@
19
19
Set-GitHubStepSummary -Summary 'Hello, World!'
20
20
21
21
.NOTES
22
-
[Adding a job summary](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions?utm_source=chatgpt.com#adding-a-job-summary)
22
+
[Adding a job summary](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions?utm_source=chatgpt.com#adding-a-job-summary)
Copy file name to clipboardExpand all lines: src/functions/public/Commands/Write-GitHubDebug.ps1
+2-2
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
.DESCRIPTION
7
7
Write a debug message in GitHub Actions. The message will only be displayed if the action is running in debug mode.
8
8
To run in debug mode, you must create a secret or variable named ACTIONS_STEP_DEBUG with the value `true` to see the debug messages set by
9
-
this command in the log. For more information, see [Enabling debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging).
9
+
this command in the log. For more information, see [Enabling debug logging](https://docs.github.com/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging).
10
10
11
11
If both the secret and variable are set, the value of the secret takes precedence over the variable.
0 commit comments