Skip to content

Commit 9db209b

Browse files
committed
restore json representation in reference
1 parent 9de8a4f commit 9db209b

1 file changed

Lines changed: 53 additions & 51 deletions

File tree

docs/reference/release.md

Lines changed: 53 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -58,56 +58,58 @@ For `kind: github/release`
5858

5959
```json
6060
{
61-
// Describes the repository from which releases are being sourced
62-
"repo": {
63-
// The name of the repository, excluding its owner
64-
"name": "Hello-World",
65-
// The full name of the repository, including its owner
66-
"fullname": "octocat/Hello-World",
67-
// Whether the repository is private (inverse of repo.public)
68-
"private": false,
69-
// Whether the repository is publicly accessible (inverse of repo.private)
70-
"public": true,
71-
// Whether the repository has been forked from another repository.
72-
"fork": false,
73-
// The size of the repository in kilobytes, will be zero for empty repositories.
74-
"size": 1024,
75-
// Whether the repository has been archived (and is read only).
76-
"archived": false,
77-
// Whether the repository has been disabled (and is read only).
78-
"disabled": false,
79-
// The name of the main branch for the repository.
80-
"default_branch": "main",
81-
// Whether the repository is empty (has a size of 0kB).
82-
"empty": false,
83-
// Whether the repository is a template which can be used to create new repositories.
84-
"template": false,
85-
// The number of times this repository has been forked.
86-
"forks": 0,
87-
// The number of people who have starred this repository.
88-
"stargazers": 501
89-
},
90-
// Describes a specific release associated with a repository
91-
"release": {
92-
// The name of the release as it appears in the GitHub UI
93-
"name": "v1.0.0",
94-
// The tag name pointing at the commit which generated the release
95-
"tag": "v1.0.0",
96-
// Whether the release is a pre-release
97-
"prerelease": false,
98-
// Whether the release is a draft (inverse of published)
99-
"draft": false,
100-
/// Whether the release has been published yet or not (inverse of draft)
101-
"published": true
102-
},
103-
// Describes a specific artifact which is part of a release
104-
"asset": {
105-
// The name of the release asset
106-
"name": "github-backup-darwin-arm64",
107-
// The size of the release asset in kilobytes
108-
"size": 1024,
109-
// Whether the asset has been downloaded at least once
110-
"downloaded": true
111-
}
61+
// Describes the repository from which releases are being sourced
62+
"repo": {
63+
// The name of the repository, excluding its owner
64+
"name": "Hello-World",
65+
// The full name of the repository, including its owner
66+
"fullname": "octocat/Hello-World",
67+
// Whether the repository is private (inverse of repo.public)
68+
"private": false,
69+
// Whether the repository is publicly accessible (inverse of repo.private)
70+
"public": true,
71+
// Whether the repository has been forked from another repository.
72+
"fork": false,
73+
// The size of the repository in kilobytes, will be zero for empty repositories.
74+
"size": 1024,
75+
// Whether the repository has been archived (and is read only).
76+
"archived": false,
77+
// Whether the repository has been disabled (and is read only).
78+
"disabled": false,
79+
// The name of the main branch for the repository.
80+
"default_branch": "main",
81+
// Whether the repository is empty (has a size of 0kB).
82+
"empty": false,
83+
// Whether the repository is a template which can be used to create new repositories.
84+
"template": false,
85+
// The number of times this repository has been forked.
86+
"forks": 0,
87+
// The number of people who have starred this repository.
88+
"stargazers": 501
89+
},
90+
91+
// Describes a specific release associated with a repository
92+
"release": {
93+
// The name of the release as it appears in the GitHub UI
94+
"name": "v1.0.0",
95+
// The tag name pointing at the commit which generated the release
96+
"tag": "v1.0.0",
97+
// Whether the release is a pre-release
98+
"prerelease": false,
99+
// Whether the release is a draft (inverse of published)
100+
"draft": false,
101+
/// Whether the release has been published yet or not (inverse of draft)
102+
"published": true
103+
},
104+
105+
// Describes a specific artifact which is part of a release
106+
"asset": {
107+
// The name of the release asset
108+
"name": "github-backup-darwin-arm64",
109+
// The size of the release asset in kilobytes
110+
"size": 1024,
111+
// Whether the asset has been downloaded at least once
112+
"downloaded": true
113+
}
112114
}
113115
```

0 commit comments

Comments
 (0)