Skip to content

Commit 4bf082d

Browse files
committed
Update readme
1 parent ffafc37 commit 4bf082d

File tree

1 file changed

+14
-24
lines changed

1 file changed

+14
-24
lines changed

README.md

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,37 @@ Simple extension to interact with GitHub Actions from within VS Code.
1010
2. Open a repository with a `github.com` origin
1111
3. When prompted, allow `GitHub Actions` to access your `github` account from the "Accounts" menu:
1212

13-
![Location of the "Accounts" menu](https://user-images.githubusercontent.com/2201819/106392564-413ae880-63a7-11eb-8b67-d06c1eede4ea.png)
13+
![Sign in via Accounts menu](./media/sign-in.png)
1414

1515
## Features
1616

1717
### Auto-complete and documentation
1818

19-
No additional YAML extension needed, this extension includes a built-in language server with full support for the workflow schema.
19+
No additional YAML extension needed, this extension includes a built-in language server with support for the workflow schema:
2020

2121
![Workflow auto-complete](./media/workflow-auto-complete.gif)
2222

23-
### Auto-complete actions parameters
23+
#### Actions parameters
2424

2525
Auto-completion and validation for every action you reference in `uses`:
2626

2727
![Actions auto-complete](./media/actions-auto-complete.gif)
2828

29-
### Auto-complete runner label
29+
#### Runner labels
30+
31+
Auto-completion and validation of labels for hosted and self-hosted runners:
3032

3133
![Auto-complete runner label](./media/runs-on-auto-complete.gif)
3234

33-
### Smart auto-complete and evaluation of expressions
35+
### Expressions
36+
37+
Auto-completion, validation, and evaluation of expressions:
3438

3539
![Auto-complete and evaluation of expressions](./media/env-auto-complete.gif)
3640

37-
### Auto-complete and validate `github` event expressions
41+
#### `github` event expressions
3842

39-
The extension knows about all the webhook payloads and suggests and auto-completes event payload fields
43+
Auto-complete and validate all webhook event payloads:
4044

4145
![Auto-complete github event expressions](./media/github-auto-complete.gif)
4246

@@ -56,7 +60,7 @@ The extension knows about all the webhook payloads and suggests and auto-complet
5660

5761
### Trigger runs
5862

59-
If a workflow uses `repository_dispatch` as a trigger, you can start a new workflow run from the workflow context menu:
63+
If a workflow uses `repository_dispatch` or `workflow_dispatch` as a trigger, you can start a new workflow run from the workflow context menu:
6064

6165
![](./media/rdispatch.gif)
6266

@@ -73,20 +77,6 @@ Or from the editor when editing a workflow:
7377
You can pin workflows to the status bar per workspace, and automatically see the status of the most recent run. For example, to see if the change you just pushed passes the CI Build:
7478
![](./media/pin-workflows.gif)
7579

76-
1. To setup, configure the `"github-actions.workflows.pinned.workflows"` property on a global level, or per workspace (`.vscode/settings.json`):
77-
78-
```json
79-
{
80-
"github-actions.workflows.pinned.workflows": [".github/workflows/build.yml", ".github/workflows/create.yml"],
81-
}
82-
```
83-
84-
2. To enable auto-refresh via polling, set `refresh.enabled` to `true`. This works by polling the workflow runs API with a default interval of `30` seconds. You can customized the interal via `refresh.interval`:
80+
### View workflow runs for the current branch
8581

86-
```json
87-
{
88-
"github-actions.workflows.pinned.workflows": [".github/workflows/build.yml", ".github/workflows/create.yml"],
89-
"github-actions.workflows.pinned.refresh.enabled": true,
90-
"github-actions.workflows.pinned.refresh.interval": 65,
91-
}
92-
```
82+
![](./media/workflows-current-branch.gif)

0 commit comments

Comments
 (0)