Skip to content

Commit c132355

Browse files
authored
Update README.md [skip ci]
1 parent 5dd6ca4 commit c132355

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,41 @@
77
<!-- ALL-CONTRIBUTORS-BADGE:END -->
88

99
# GitHub Actions for Visual Studio
10+
1011
The GitHub Actions extension lets you manage your workflows, view the workflow run history, and edit GitHub secrets.
1112

1213
![image](https://github.com/timheuer/GitHubActionsVS/assets/4821/43e011c8-2ac1-4ae9-aa95-747fe033e5c6)
1314

1415
## Features
15-
TBD
16+
17+
This extension mainly serves to provide a quick way to see the GitHub Actions for your open solution if identified as a GitHub.com repo. To view these, either right click on the solution or project in Solution Explorer and click "GitHub Actions" from the menu:
18+
19+
![image](https://github.com/timheuer/GitHubActionsVS/assets/4821/ab61f0b9-d82d-41f4-bc29-cfc7507fea7f)
20+
21+
If an active solution exists and it is both a git and GitHub.com repository, the window will start querying the repository for Actions information on runs and secrets. A progress bar will be shown then you can expand to see the results.
1622

1723
### View workflow run history
18-
TBD
1924

20-
### Edit GitHub secrets
21-
TBD
25+
To view the history simply select a run and navigate through the tree view to see details. You can double-click on a leaf node to launch to the log point on the repo to view the rich log output.
26+
27+
> Not yet implemented: The ability to [monitor a workflow run while in process](https://github.com/timheuer/GitHubActionsVS/issues/15).
28+
29+
If you close and open a new project the window will be refreshed to represent the current state.
30+
31+
#### Limit run count retrieval
32+
By default a maximum of last 10 runs are retrieved. You can change this in the `Tools...Options` of Visual Studio and set an integer value.
33+
34+
![image](https://github.com/timheuer/GitHubActionsVS/assets/4821/588fc711-1c02-4268-a9a4-32411028f213)
35+
36+
37+
#### Manually refresh
38+
You can manually refresh the view by clicking the refresh icon in the toolbar:
39+
40+
![image](https://github.com/timheuer/GitHubActionsVS/assets/4821/865d424d-29e1-40e8-96c4-1eeffb458682)
41+
42+
### Edit GitHub secrets (Coming soon...)
43+
44+
Update or Add repo secrets directly from within Visual Studio.
2245

2346
## Contributors
2447

@@ -46,9 +69,10 @@ TBD
4669

4770
<!-- ALL-CONTRIBUTORS-LIST:END -->
4871

49-
5072
## Requirements
73+
5174
Visual Studio 2022 17.6 or later is required to use this extension. Additionally since GitHub Actions is obviously a feature of GitHub, you will need to be attached to an active GitHub.com repository.
5275

5376
## Code of Conduct
77+
5478
This project has adopted the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). For more information see the Code of Conduct itself or contact project maintainers with any additional questions or comments or to report a violation.

0 commit comments

Comments
 (0)