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: learn-pr/github/create-custom-github-actions/includes/exercise-create-custom-action.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,9 @@ When you select the _Start the exercise on GitHub_ button, you'll navigate to a
13
13
When you've finished the exercise in GitHub, return here for:
14
14
15
15
> [!div class="checklist"]
16
-
> * A quick knowledge check
17
-
> * A summary of what you've learned
18
-
> * To earn a badge for completing this module
16
+
> - A quick knowledge check
17
+
> - A summary of what you've learned
18
+
> - To earn a badge for completing this module
19
19
20
20
>[!NOTE]
21
21
> You don't need to modify any of the workflow files to complete this exercise. **Altering the contents in this workflow can break the exercise's ability to validate your actions, provide feedback, or grade the results**.
Copy file name to clipboardExpand all lines: learn-pr/github/create-custom-github-actions/includes/introduction.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
GitHub Actions allow you to create individual, custom actions by writing code that interacts with your repository in any way you'd like, including integrating with GitHub's APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.
2
2
3
-
You can write your own custom actions to use in your workflow or share the actions you build with the GitHub community. To share actions you've built with the community, your repository must be public. Actions can run directly on compute resources (such as virtual machines) or in Docker containers. You can also define an action's inputs, outputs, and environment variables.
3
+
You can write your own custom actions to use in your workflow, or share the actions you build with the GitHub community. To share actions you've built with the community, your repository must be public. Actions can run directly on compute resources (such as virtual machines) or in Docker containers. You can also define an action's inputs, outputs, and environment variables.
4
4
5
5
In this module, you'll learn the different ways to create a custom action, its necessary metadata and syntax, and how to publish a custom action to the GitHub Marketplace.
6
6
@@ -22,6 +22,6 @@ This module assumes you have basic familiarity with GitHub Actions and workflows
22
22
- The ability to navigate and edit files in GitHub
23
23
- For more information about GitHub, see [Introduction to GitHub](https://github.com/skills/introduction-to-github).
24
24
- Basic familiarity with GitHub Actions and workflows
25
-
- If you aren't familiar with workflows, jobs and steps, check out the [Automate development tasks by using GitHub Actions](/training/modules/github-actions-automate-tasks/) module
25
+
- If you aren't familiar with workflows, jobs and steps, check out the [Automate development tasks by using GitHub Actions](/training/modules/github-actions-automate-tasks/) module.
26
26
- Basic familiarity with continuous integration using GitHub Actions and workflows
27
-
- If you're unfamiliar with continuous integration using GitHub Actions and workflows, check out [Build continuous integration workflows by using GitHub Actions](/training/modules/github-actions-ci/)
27
+
- If you're unfamiliar with continuous integration using GitHub Actions and workflows, check out [Build continuous integration (CI) workflows by using GitHub Actions](/training/modules/github-actions-ci/).
Copy file name to clipboardExpand all lines: learn-pr/github/create-custom-github-actions/includes/publish-custom-github-action.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,16 +16,16 @@ When an action is in a private repository, only workflows in the same repository
16
16
17
17
## Document your action
18
18
19
-
It can be very frustrating to use a new tool or application when the documentation is vague or even missing. It's important to include good documentation with your action so that others can see how it works, whether you plan to make it public or private. The first thing to do is creating a good `README.md` file for your action.
19
+
It can be very frustrating to use a new tool or application when the documentation is vague or even missing. It's important to include good documentation with your action so that others can see how it works, whether you plan to make it public or private. The first thing to do is create a good `README.md` file for your action.
20
20
21
21
The `README.md` file is often the first place developers will look at to see how the action works. This is a great place to include all of the important information for the action. The following is a non-exhaustive list of things to include:
22
22
23
-
- A detailed description of what the action does
24
-
- Required input and output arguments
25
-
- Optional input and output arguments
26
-
- Secrets the action uses
27
-
- Environment variables the action uses
28
-
- An example of how to use your action in a workflow
23
+
- A detailed description of what the action does.
24
+
- Required input and output arguments.
25
+
- Optional input and output arguments.
26
+
- Secrets the action uses.
27
+
- Environment variables the action uses.
28
+
- An example of how to use your action in a workflow.
29
29
30
30
As a general rule, the `README.md` file should include everything a user should know to use the action. If you think it could be useful information, include it in the `README.md`.
31
31
@@ -35,7 +35,7 @@ If you're developing an action for other people to use, whether it's public or p
35
35
36
36
### Good practices for release and version management
37
37
38
-
A good release-management strategy should include versioning recommendations. Users should not be referencing an action's default branch with the action, because the default branch which is likely to contain the latest code (which might or might not be stable) and could result in your workflow breaking. Instead, we recommend that users specify a major version when using the action, and to only direct them to a more specific version if they encounter issues. They can do this by configuring their GitHub Actions workflow to target a tag, a commit's SHA, or a specific branch named for a release. Let's take a closer look at these release options.
38
+
A good release-management strategy should include versioning recommendations. Users should not be referencing an action's default branch with the action. This is because the default branch that's likely to contain the latest code (which might or might not be stable) could result in your workflow breaking. Instead, we recommend that users specify a major version when using the action, and to only direct them to a more specific version if they encounter issues. They can do this by configuring their GitHub Actions workflow to target a tag, a commit's SHA, or a specific branch named for a release. Let's take a closer look at these release options.
Copy file name to clipboardExpand all lines: learn-pr/github/create-custom-github-actions/includes/summary.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
@@ -1,4 +1,4 @@
1
-
Your goal in this module was to understand the different types of GitHub actions and then create your own custom GitHub action and use it in a workflow.
1
+
Your goal in this module was to understand the different types of GitHub actions, and then create your own custom GitHub action and use it in a workflow.
2
2
3
3
To accomplish this goal, you first learned about the necessary metadata and syntax to write custom GitHub actions. You learned about workflow commands to extend functionality to your action, how to choose a private or public location for your action, and establishing best practices for documenting and versioning your action. You also learned how to publish your action to the GitHub Marketplace.
0 commit comments