In this video, discover why custom Actions should have a README file and the key information the file should include.
- [Instructor] So far, we've put a lot … into this custom action. … We came up with an objective, made a Docker file, … and then coded and tested the entry point script … with the logic and commands that complete the action. … The last thing we need is a readme file. … Now, I have to be clear, … a readme file is not a requirement for an action to work. … After all, the action will work perfectly fine without one. … However, a readme file is required … if we want to share an action in the GitHub Marketplace. … In addition, a descriptive and well written readme file … is strongly encouraged for explaining what your action does, … how someone can use it, … and perhaps even why they should use it in the first place. … There are a few key things we want to include … in our readme file. … A headline with a brief description … that clearly explains the action … and the benefits of using it. … Specifics on any secrets, environment variables, … or arguments that are needed … for the action to operate correctly. …
- Creating an action
- Creating a workflow
- Adding actions to a workflow
- Using an action from a repository
- Using environment variables
- Building custom actions
- Use cases for actions and workflows
Skill Level Beginner
1. Your first Action
2. Connecting Actions with Workflows
3. Using Actions
4. Building Custom Actions
5. Use Cases
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.