|
1 | 1 | # GitHub Actions for VS Code |
2 | 2 |
|
3 | | -[](https://github.com/github/vscode-github-actions/actions/workflows/build.yml) |
| 3 | +The GitHub Actions extension lets you manage you manage your workflows, view the workflow run history, and helps with authoring workflows. |
4 | 4 |
|
5 | | -Simple extension to interact with GitHub Actions from within VS Code. |
6 | | - |
7 | | -## Setup |
8 | | - |
9 | | -1. Install the extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=github.vscode-github-actions) |
10 | | -2. Open a repository with a `github.com` `origin` git remote |
11 | | -3. When prompted, allow `GitHub Actions` access to your GitHub account: |
12 | | - |
13 | | -  |
| 5 | + |
14 | 6 |
|
15 | 7 | ## Features |
16 | 8 |
|
17 | | -The extension provides a convenient way to monitor workflows and workflow runs from VS Code as well as language-server features for editing workflow YAML files. |
18 | | - |
19 | | -### Auto-complete and documentation |
| 9 | +### Manage workflows and runs |
20 | 10 |
|
21 | | -No additional YAML extension needed, this extension includes a built-in language server with support for the workflow schema: |
| 11 | +* Manage your workflows and runs without leaving your editor. |
| 12 | +* Keep track of your CI builds and deployments. |
| 13 | +* Investigate failures and view logs. |
22 | 14 |
|
23 | | - |
| 15 | + |
24 | 16 |
|
25 | | -Auto-completion and validation for every action you reference in `uses`: |
| 17 | +### Workflow authoring |
26 | 18 |
|
27 | | - |
| 19 | +Be more confident when authoring and modifying workflows. Find errors before committing workflows with: |
28 | 20 |
|
29 | | -Auto-completion and validation of labels for hosted and self-hosted runners: |
| 21 | +**Syntax highlighting** for workflows and GitHub Actions Expressions makes it clear where values are inserted at execution time: |
30 | 22 |
|
31 | | - |
| 23 | + |
32 | 24 |
|
33 | | -#### Expressions auto-complete |
| 25 | +**Integrated documentation** for the workflow schema, expression functions, and even event payloads: |
34 | 26 |
|
35 | | -Auto-completion, validation, and evaluation of expressions: |
| 27 | + |
36 | 28 |
|
37 | | - |
| 29 | +**Validation and code completion** for the YAML schema and GitHub Actions Expressions. Get instant validation and code completion for the workflow schema, expression functions, event payloads, and job or step `outputs`: |
38 | 30 |
|
39 | | -Auto-complete and validate all webhook event payloads: |
| 31 | + |
40 | 32 |
|
41 | | - |
| 33 | +**Smart validation and code completion for actions and reusable workflows**: the extension automatically parses parameters, inputs, and outputs for referenced actions and called reusable workflows for code-completion and validation. |
42 | 34 |
|
43 | | -### Monitor workflow runs |
| 35 | + |
44 | 36 |
|
45 | | -See runs for workflows in the repository, drill into jobs and steps, and inspect logs: |
| 37 | +## Getting started |
46 | 38 |
|
47 | | - |
48 | | - |
49 | | - |
50 | | -### Other features |
51 | | - |
52 | | -- Trigger `repository_dispatch` or `workflow_dispatch` workflow runs |
53 | | -- View, edit, and add secrets |
54 | | -- Pin workflow to the VS Code status bar |
| 39 | +1. Install the extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=github.vscode-github-actions) |
| 40 | +1. Sign in with your GitHub account and when prompted allow `GitHub Actions` access to your GitHub account. |
| 41 | +1. Open a GitHub repository |
55 | 42 |
|
56 | 43 | ## Contributing |
57 | 44 |
|
|
0 commit comments