Skip to content

Commit 90d72ce

Browse files
Add more comments to Release and ReleaseAsset
1 parent 2f9c8d1 commit 90d72ce

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

extensions/ql-vscode/src/codeql-cli/release.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
/**
2-
* A release on GitHub.
2+
* A release of the CodeQL CLI hosted on GitHub.
33
*/
44
export interface Release {
5+
/**
6+
* The assets associated with the release on GitHub.
7+
*/
58
assets: ReleaseAsset[];
69

710
/**
811
* The creation date of the release on GitHub.
12+
*
13+
* This is the date that the release was uploaded to GitHub, and not the date
14+
* when we downloaded it or the date when we fetched the data from the GitHub API.
915
*/
1016
createdAt: string;
1117

@@ -21,7 +27,8 @@ export interface Release {
2127
}
2228

2329
/**
24-
* An asset corresponding to a release on GitHub.
30+
* An asset attached to a release on GitHub.
31+
* Each release may have multiple assets, and each asset can be downloaded independently.
2532
*/
2633
export interface ReleaseAsset {
2734
/**

0 commit comments

Comments
 (0)