Skip to content

Commit bfda9f6

Browse files
committed
Update readme
1 parent 9fb8351 commit bfda9f6

7 files changed

Lines changed: 19 additions & 34 deletions

File tree

README.md

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,42 @@
11
# GitHub Actions for VS Code
22

3-
[![Build](https://github.com/github/vscode-github-actions/actions/workflows/build.yml/badge.svg)](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.
44

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-
![Sign in via Accounts menu](./media/allow-access.png)
5+
![](./media/header.png)
146

157
## Features
168

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
2010

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. Keep track of your CI builds and deployments. Investigate failures and view logs.
2212

23-
![Workflow auto-complete](./media/workflow-auto-complete.gif)
13+
![View workflow runs and logs](./media/workflows.png)
2414

25-
Auto-completion and validation for every action you reference in `uses`:
15+
### Workflow authoring
2616

27-
![Actions auto-complete](./media/actions-auto-complete.gif)
17+
Be more confident when authoring and modifying workflows. Find errors before committing workflows with:
2818

29-
Auto-completion and validation of labels for hosted and self-hosted runners:
19+
**Syntax highlighting** for workflows and GitHub Actions Expressions makes it clear where values are inserted at execution time:
3020

31-
![Auto-complete runner label](./media/runs-on-auto-complete.gif)
21+
![Syntax highlighting](media/highlight.png)
3222

33-
#### Expressions auto-complete
23+
**Integrated documentation** for the workflow schema, expression functions, and even event payloads:
3424

35-
Auto-completion, validation, and evaluation of expressions:
25+
![Tooltip showing description for a pull_request payload](media/docs.png)
3626

37-
![Auto-complete and evaluation of expressions](./media/env-auto-complete.gif)
27+
**Validation and code completion** for the YAML schema and GitHub Action Expressions. Get instant validation and code completion for the workflow schema, expression functions, event payloads, and job or step `outputs`:
3828

39-
Auto-complete and validate all webhook event payloads:
29+
![Validation for YAML keys and expressions](media/validation.png)
4030

41-
![Auto-complete github event expressions](./media/github-auto-complete.gif)
31+
**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.
4232

43-
### Monitor workflow runs
33+
![Video showing workflow validation and auto-completion](./media/authoring.gif)
4434

45-
See runs for workflows in the repository, drill into jobs and steps, and inspect logs:
35+
## Getting started
4636

47-
![See workflows and runs for the current repository](./media/logs.gif)
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
37+
1. Install the extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=github.vscode-github-actions)
38+
1. Sign in with your GitHub account and when prompted allow `GitHub Actions` access to your GitHub account.
39+
1. Open a repository with a `github.com` `origin` remote
5540

5641
## Contributing
5742

media/authoring.gif

9.58 MB
Loading

media/docs.png

153 KB
Loading

media/header.png

269 KB
Loading

media/highlight.png

88.2 KB
Loading

media/validation.png

293 KB
Loading

media/workflows.png

860 KB
Loading

0 commit comments

Comments
 (0)