Skip to content

Commit f7cfef8

Browse files
committed
Add test plan for auto-refresh feature in GitHub Actions extension
1 parent 3692e70 commit f7cfef8

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

TEST_PLAN.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Test Plan for Issue #229 Fix
2+
3+
## Objective
4+
Verify that the GitHub Actions extension automatically refreshes the workflow run list after a user manually triggers a workflow run.
5+
6+
## Prerequisites
7+
1. A GitHub repository with GitHub Actions enabled.
8+
2. A workflow file in that repository that supports `workflow_dispatch` (manual trigger).
9+
* Example `workflow_dispatch` configuration in `.github/workflows/test.yml`:
10+
```yaml
11+
name: Manual Test
12+
on: workflow_dispatch
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- run: echo "Hello World"
18+
```
19+
3. The repository is cloned locally and opened in VS Code.
20+
21+
## Manual Test Steps
22+
23+
1. **Launch Extension in Debug Mode**:
24+
* Open the `vscode-github-actions` project in VS Code.
25+
* Press `F5` or go to "Run and Debug" and select "Watch & Launch Extension".
26+
* This will open a new "Extension Development Host" window.
27+
28+
2. **Open Test Repository**:
29+
* In the Extension Development Host window, open the folder of your test repository (from Prerequisites).
30+
31+
3. **Navigate to GitHub Actions View**:
32+
* Click on the GitHub Actions icon in the Activity Bar (sidebar).
33+
* Expand the "Workflows" section.
34+
* Find your manual workflow (e.g., "Manual Test").
35+
36+
4. **Trigger Workflow Run**:
37+
* Right-click on the workflow name.
38+
* Select **"Run Workflow"**.
39+
* (Optional) If prompted for branch or inputs, provide them and confirm.
40+
41+
5. **Verify Behavior**:
42+
* **Immediate Feedback**: Look for a status bar message or notification saying "Waiting for workflow run to start...".
43+
* **Auto-Refresh**: Watch the "Workflows" list. Within 1-20 seconds, the list should automatically refresh.
44+
* **New Run**: A new workflow run (likely in "Queued" or "In Progress" state) should appear at the top of the list under the workflow.
45+
46+
## Expected Result
47+
* The user does **not** need to manually click the refresh button.
48+
* The UI updates automatically once the new run is created on GitHub.
49+
50+
## Troubleshooting
51+
* If the run doesn't appear after 20 seconds, check if the workflow actually started on GitHub.com.
52+
* Check the "Output" panel (select "GitHub Actions" in the dropdown) for any error logs.

0 commit comments

Comments
 (0)