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
Copy file name to clipboardExpand all lines: content/actions/how-tos/create-and-publish-actions/create-a-cli-action.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ This article will demonstrate how to write an action that retrieves a specific v
31
31
32
32
## Prerequisites
33
33
34
-
You should have an understanding of how to write a custom action. For more information, see [AUTOTITLE](/actions/how-tos/creating-and-publishing-actions/managing-custom-actions).
34
+
You should have an understanding of how to write a custom action. For more information, see [AUTOTITLE](/actions/how-tos/create-and-publish-actions/manage-custom-actions).
35
35
36
36
## Example
37
37
@@ -64,7 +64,7 @@ module.exports = setup
64
64
65
65
{% endraw %}
66
66
67
-
To use this script, replace `getDownloadURL` with a function that downloads your CLI. You will also need to create an actions metadata file (`action.yml`) that accepts a `version` input and that runs this script. For full details about how to create an action, see [AUTOTITLE](/actions/creating-actions/creating-a-javascript-action).
67
+
To use this script, replace `getDownloadURL` with a function that downloads your CLI. You will also need to create an actions metadata file (`action.yml`) that accepts a `version` input and that runs this script. For full details about how to create an action, see [AUTOTITLE](/actions/tutorials/create-actions/create-a-javascript-action).
Copy file name to clipboardExpand all lines: content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Many people access {% data variables.product.github %} at a domain other than {%
32
32
33
33
To ensure that your action is compatible with other platforms, do not use any hard-coded references to API URLs such as `https://api.github.com`. Instead, you can:
34
34
35
-
* Use environment variables (see [AUTOTITLE](/actions/reference/variables-reference#default-environment-variables)):
35
+
* Use environment variables (see [AUTOTITLE](/actions/reference/workflows-and-actions/variables#default-environment-variables)):
36
36
37
37
* For the REST API, use the `GITHUB_API_URL` environment variable.
38
38
* For GraphQL, use the `GITHUB_GRAPHQL_URL` environment variable.
Copy file name to clipboardExpand all lines: content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ contentType: how-tos
23
23
>[!NOTE]
24
24
> You must accept the terms of service to publish actions in {% data variables.product.prodname_marketplace %}.
25
25
26
-
Before you can publish an action, you'll need to create an action in your repository. For more information, see [AUTOTITLE](/actions/creating-actions).
26
+
Before you can publish an action, you'll need to create an action in your repository. For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations).
27
27
28
28
When you plan to publish your action to {% data variables.product.prodname_marketplace %}, you'll need to ensure that the repository only includes the metadata file, code, and files necessary for the action. Creating a single repository for the action allows you to tag, release, and package the code in a single unit. {% data variables.product.prodname_dotcom %} also uses the action's metadata on your {% data variables.product.prodname_marketplace %} page.
Copy file name to clipboardExpand all lines: content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,9 +70,9 @@ Here is an example process that you can follow to automatically run tests, creat
70
70
71
71
* When a pull request is opened, either from a branch or a fork, your testing workflow will again run the tests, this time with the merge commit.
72
72
73
-
***Note:** for security reasons, workflows triggered by `pull_request` from forks have restricted `GITHUB_TOKEN` permissions and do not have access to secrets. If your tests or other workflows triggered upon pull request require access to secrets, consider using a different event like a [manual trigger](/actions/using-workflows/events-that-trigger-workflows#manual-events) or a [`pull_request_target`](/actions/using-workflows/events-that-trigger-workflows#pull_request_target). For more information, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull-request-events-for-forked-repositories).
73
+
***Note:** for security reasons, workflows triggered by `pull_request` from forks have restricted `GITHUB_TOKEN` permissions and do not have access to secrets. If your tests or other workflows triggered upon pull request require access to secrets, consider using a different event like a [manual trigger](/actions/reference/workflows-and-actions/events-that-trigger-workflows#manual-events) or a [`pull_request_target`](/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target). For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull-request-events-for-forked-repositories).
74
74
75
-
1. Create a semantically tagged release. {% ifversion fpt or ghec %} You may also publish to {% data variables.product.prodname_marketplace %} with a simple checkbox. {% endif %} For more information, see [AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release){% ifversion fpt or ghec %} and [AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action){% endif %}.
75
+
1. Create a semantically tagged release. {% ifversion fpt or ghec %} You may also publish to {% data variables.product.prodname_marketplace %} with a simple checkbox. {% endif %} For more information, see [AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release){% ifversion fpt or ghec %} and [AUTOTITLE](/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace#publishing-an-action){% endif %}.
76
76
77
77
* When a release is published or edited, your release workflow will automatically take care of compilation and adjusting tags.
78
78
@@ -89,10 +89,10 @@ Using semantic releases means that the users of your actions can pin their workf
89
89
{% data variables.product.github %} provides tools and guides to help you work with the open source community. Here are a few tools we recommend setting up for healthy bidirectional communication. By providing the following signals to the community, you encourage others to use, modify, and contribute to your action:
90
90
91
91
* Maintain a `README` with plenty of usage examples and guidance. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes).
92
-
* Include a workflow status badge in your `README` file. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge). Also visit [shields.io](https://shields.io/) to learn about other badges that you can add.{% ifversion fpt or ghec %}
92
+
* Include a workflow status badge in your `README` file. For more information, see [AUTOTITLE](/actions/how-tos/monitor-workflows/add-a-status-badge). Also visit [shields.io](https://shields.io/) to learn about other badges that you can add.{% ifversion fpt or ghec %}
93
93
* Add community health files like `CODE_OF_CONDUCT`, `CONTRIBUTING`, and `SECURITY`. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types).{% endif %}
94
94
* Keep issues current by utilizing actions like [actions/stale](https://github.com/actions/stale).{% ifversion fpt or ghec %}
95
-
* Use {% data variables.product.github %}'s security features to communicate about vulnerabilities and how to fix them. For more information, see [AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions#protecting-actions-youve-created).{% endif %}
95
+
* Use {% data variables.product.github %}'s security features to communicate about vulnerabilities and how to fix them. For more information, see [AUTOTITLE](/actions/reference/security/secure-use#protecting-actions-youve-created).{% endif %}
Copy file name to clipboardExpand all lines: content/actions/how-tos/deploy/configure-and-manage-deployments/configure-custom-protection-rules.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,11 @@ contentType: how-tos
22
22
23
23
Custom deployment protection rules are powered by {% data variables.product.prodname_github_apps %}. Once a deployment protection rule is configured and installed in a repository, it can be enabled for any environments in the repository.
24
24
25
-
After you enable a custom deployment protection rule on an environment, every time a workflow step targets that environment, the deployment protection rule will run automatically. For more information about targeting an environment for deployments, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment).
25
+
After you enable a custom deployment protection rule on an environment, every time a workflow step targets that environment, the deployment protection rule will run automatically. For more information about targeting an environment for deployments, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments).
26
26
27
27
When a custom deployment protection rule is triggered it will wait for up to 30 days for a webhook event response before it times out and the workflow job fails.
28
28
29
-
For more information about creating your own custom deployment protection rules, see [AUTOTITLE](/actions/deployment/protecting-deployments/creating-custom-deployment-protection-rules).
29
+
For more information about creating your own custom deployment protection rules, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/create-custom-protection-rules).
30
30
31
31
{% data reusables.actions.custom-deployment-protection-rules-limits %}
32
32
@@ -44,7 +44,7 @@ The following is a list of official partner implementations for deployment prote
44
44
45
45
## Prerequisites
46
46
47
-
In order for a custom deployment protection rule to be available to all environments in a repository, you must first install the custom deployment protection rule on the repository. For more information, see [AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps).
47
+
In order for a custom deployment protection rule to be available to all environments in a repository, you must first install the custom deployment protection rule on the repository. For more information, see [AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app).
48
48
49
49
After a custom deployment protection rule has been installed in a repository, it must be enabled for each environment where you want the rule to apply.
50
50
@@ -57,4 +57,4 @@ After a custom deployment protection rule has been installed in a repository, it
57
57
1. Under "Deployment protection rules," check the box next to each custom deployment protection rule you want to enable for the environment.
58
58
1. Click **Save protection rules**.
59
59
60
-
Once a custom deployment protection rule has been enabled for an environment, it will automatically run whenever a workflow reaches a job that references the environment. You can see the results of an approval or rejection for your deployment by reviewing the details of the deployment. For more information, see [AUTOTITLE](/actions/managing-workflow-runs/reviewing-deployments).
60
+
Once a custom deployment protection rule has been enabled for an environment, it will automatically run whenever a workflow reaches a job that references the environment. You can see the results of an approval or rejection for your deployment by reviewing the details of the deployment. For more information, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments).
0 commit comments