In this video, learn about 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 logic and commands that complete the action. … We've also added essential metadata, … so our action can run in workflows. … 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 … 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 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, …
Author
Michael Jenkins
Released
2/21/2020- Creating an action
- Creating a workflow
- Adding actions to a workflow
- Using an action from a repository
- Developing a CI/CD pipeline with GitHub Actions
- Building custom actions
- Publishing an action to the GitHub Marketplace
Skill Level Beginner
Duration
Views
-
Introduction
-
What you should know1m 31s
-
Working with YAML files1m 25s
-
1. Your First Action
-
Your first Action2m 31s
-
-
2. Connecting Actions with Workflows
-
Create a workflow3m 11s
-
Add actions to a workflow4m 27s
-
Run a workflow2m 31s
-
Add conditions to a workflow2m 40s
-
-
3. Using Actions
-
Using secrets4m 1s
-
Using artifacts4m 7s
-
Manage pull requests3m 30s
-
4. Developing a CI/CD Workflow
-
Plan your CI/CD pipeline1m 53s
-
Linting and unit tests2m 7s
-
Testing1m 44s
-
Deploying1m 38s
-
-
5. Building Custom Actions
-
Plan a custom action4m 22s
-
Dockerfile review4m 58s
-
Add a Dockerfile2m 20s
-
Add an entry-point script2m 30s
-
Test an action locally3m 52s
-
Add a metadata file2m 50s
-
Add a README file1m 48s
-
Deploy a custom action2m 22s
-
-
Conclusion
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
Press 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.
Share this video
Embed this video
Video: Add a README file