Skip to content

Commit 46ecd40

Browse files
Update README.md
1 parent eaf5355 commit 46ecd40

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

recipes/ci-cd/github-actions/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# GitHub Actions recipes
22

3-
## Intro
3+
## About
44

55
This section covers how to use GitHub Actions in a CI/CD flow such as you run automated tests, deploy and publish your repo. All running for free in the cloud whenever the workflow is triggered such as with a push or merged Pull Request.
66

7-
To use GH Actions, you must create a workflow YAML file with appropriate fields set including triggers and steps. You can write shell commands as steps and you can use use actions from the GH Marketplace to help you setup your environment (install a language and packages) and perform test and deploy steps, without you having to write a lot of code.
7+
To use GH Actions, you must create a workflow YAML file with appropriate fields set including triggers and steps. You can write shell commands as _steps_ and you can use use actions from the GH Marketplace to help you setup your environment (install a language and packages) and perform test and deploy steps, without you having to write a lot of code.
88

9-
Check the [Basic workflow](workflows/basic.md) for a sample which covers the minimum fields or the [Workflows](workflows/) section to see sample workflows across programming languages.
9+
See the first link under resources below for a beginner's guide to setting up workflows.
1010

11-
Or use this section to learn more about [jobs](jobs.md) and [triggers](triggers.md) from samples and instructions.
11+
Check the [Basic workflow](workflows/basic.md) here for a sample which covers the minimum fields or the [Workflows](workflows/) section to see sample workflows across programming languages.
12+
13+
Or use this GH Actions section of the cook to learn more about [jobs](jobs.md) and [triggers](triggers.md) from samples and instructions.
1214

1315

1416
## Resources
1517

16-
- [Configuring and managing workflows](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) from actions docs
17-
- [Syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions)
18+
Here are some links to help you with basic and advanced use of GH Actions
19+
20+
- [Configuring and managing workflows](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) - a good step by step tutorial for setting up GH Actions
21+
- [Workflow syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions)
1822
- [Github Actions Documentation](https://help.github.com/en/actions)
1923
- [Github Actions](https://github.com/actions) org on Github
2024
- The [Github Actions](https://github.community/c/github-actions) community forums

0 commit comments

Comments
 (0)