Skip to content

Commit fe9ccfd

Browse files
lecoursenlecoursen
authored
Release discussions (#18515)
1 parent f678289 commit fe9ccfd

7 files changed

Lines changed: 158 additions & 0 deletions

File tree

‎assets/images/help/releases/create-release-discussion.png‎

13.6 KB
Loading

‎assets/images/help/releases/prerelease_checkbox.png‎

-7.71 KB
Loading

‎assets/images/help/releases/update-release.png‎

-23.2 KB
Loading

‎content/github/administering-a-repository/managing-releases-in-a-repository.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da
5252
![Providing a DMG with the Release](/assets/images/help/releases/releases_adding_binary.gif)
5353
8. To notify users that the release is not ready for production and may be unstable, select **This is a pre-release**.
5454
![Checkbox to mark a release as prerelease](/assets/images/help/releases/prerelease_checkbox.png)
55+
{%- if currentVersion == "free-pro-team@latest" %}
56+
1. Optionally, select **Create a discussion for this release**, then select the **Category** drop-down menu and click a category for the release discussion.
57+
![Checkbox to create a release discussion and drop-down menu to choose a category](/assets/images/help/releases/create-release-discussion.png)
58+
{%- endif %}
5559
9. If you're ready to publicize your release, click **Publish release**. To work on the release later, click **Save draft**.
5660
![Publish release and Draft release buttons](/assets/images/help/releases/release_buttons.png)
5761

‎lib/rest/static/decorated/api.github.com.json‎

Lines changed: 46 additions & 0 deletions
Large diffs are not rendered by default.

‎lib/rest/static/dereferenced/api.github.com.deref.json‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263621,6 +263621,11 @@
263621263621
},
263622263622
"body_text": {
263623263623
"type": "string"
263624+
},
263625+
"discussion_url": {
263626+
"description": "The URL of the release discussion.",
263627+
"type": "string",
263628+
"format": "uri"
263624263629
}
263625263630
},
263626263631
"required": [
@@ -263826,6 +263831,10 @@
263826263831
"type": "boolean",
263827263832
"description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
263828263833
"default": false
263834+
},
263835+
"discussion_category_name": {
263836+
"type": "string",
263837+
"description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
263829263838
}
263830263839
},
263831263840
"required": [
@@ -264228,6 +264237,11 @@
264228264237
},
264229264238
"body_text": {
264230264239
"type": "string"
264240+
},
264241+
"discussion_url": {
264242+
"description": "The URL of the release discussion.",
264243+
"type": "string",
264244+
"format": "uri"
264231264245
}
264232264246
},
264233264247
"required": [
@@ -264339,6 +264353,26 @@
264339264353
}
264340264354
}
264341264355
},
264356+
"404": {
264357+
"description": "Response if the discussion category name is invalid",
264358+
"content": {
264359+
"application/json": {
264360+
"schema": {
264361+
"title": "Basic Error",
264362+
"description": "Basic Error",
264363+
"type": "object",
264364+
"properties": {
264365+
"message": {
264366+
"type": "string"
264367+
},
264368+
"documentation_url": {
264369+
"type": "string"
264370+
}
264371+
}
264372+
}
264373+
}
264374+
}
264375+
},
264342264376
"422": {
264343264377
"description": "Validation failed",
264344264378
"content": {
@@ -265527,6 +265561,11 @@
265527265561
},
265528265562
"body_text": {
265529265563
"type": "string"
265564+
},
265565+
"discussion_url": {
265566+
"description": "The URL of the release discussion.",
265567+
"type": "string",
265568+
"format": "uri"
265530265569
}
265531265570
},
265532265571
"required": [
@@ -266067,6 +266106,11 @@
266067266106
},
266068266107
"body_text": {
266069266108
"type": "string"
266109+
},
266110+
"discussion_url": {
266111+
"description": "The URL of the release discussion.",
266112+
"type": "string",
266113+
"format": "uri"
266070266114
}
266071266115
},
266072266116
"required": [
@@ -266626,6 +266670,11 @@
266626266670
},
266627266671
"body_text": {
266628266672
"type": "string"
266673+
},
266674+
"discussion_url": {
266675+
"description": "The URL of the release discussion.",
266676+
"type": "string",
266677+
"format": "uri"
266629266678
}
266630266679
},
266631266680
"required": [
@@ -266827,6 +266876,10 @@
266827266876
"prerelease": {
266828266877
"type": "boolean",
266829266878
"description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release."
266879+
},
266880+
"discussion_category_name": {
266881+
"type": "string",
266882+
"description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
266830266883
}
266831266884
}
266832266885
},
@@ -267226,6 +267279,11 @@
267226267279
},
267227267280
"body_text": {
267228267281
"type": "string"
267282+
},
267283+
"discussion_url": {
267284+
"description": "The URL of the release discussion.",
267285+
"type": "string",
267286+
"format": "uri"
267229267287
}
267230267288
},
267231267289
"required": [
@@ -267328,6 +267386,26 @@
267328267386
}
267329267387
}
267330267388
}
267389+
},
267390+
"404": {
267391+
"description": "Response if the discussion category name is invalid",
267392+
"content": {
267393+
"application/json": {
267394+
"schema": {
267395+
"title": "Basic Error",
267396+
"description": "Basic Error",
267397+
"type": "object",
267398+
"properties": {
267399+
"message": {
267400+
"type": "string"
267401+
},
267402+
"documentation_url": {
267403+
"type": "string"
267404+
}
267405+
}
267406+
}
267407+
}
267408+
}
267331267409
}
267332267410
},
267333267411
"x-github": {

‎lib/rest/static/dereferenced/github.ae.deref.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227795,6 +227795,11 @@
227795227795
},
227796227796
"body_text": {
227797227797
"type": "string"
227798+
},
227799+
"discussion_url": {
227800+
"description": "The URL of the release discussion.",
227801+
"type": "string",
227802+
"format": "uri"
227798227803
}
227799227804
},
227800227805
"required": [
@@ -228402,6 +228407,11 @@
228402228407
},
228403228408
"body_text": {
228404228409
"type": "string"
228410+
},
228411+
"discussion_url": {
228412+
"description": "The URL of the release discussion.",
228413+
"type": "string",
228414+
"format": "uri"
228405228415
}
228406228416
},
228407228417
"required": [
@@ -229701,6 +229711,11 @@
229701229711
},
229702229712
"body_text": {
229703229713
"type": "string"
229714+
},
229715+
"discussion_url": {
229716+
"description": "The URL of the release discussion.",
229717+
"type": "string",
229718+
"format": "uri"
229704229719
}
229705229720
},
229706229721
"required": [
@@ -230241,6 +230256,11 @@
230241230256
},
230242230257
"body_text": {
230243230258
"type": "string"
230259+
},
230260+
"discussion_url": {
230261+
"description": "The URL of the release discussion.",
230262+
"type": "string",
230263+
"format": "uri"
230244230264
}
230245230265
},
230246230266
"required": [
@@ -230800,6 +230820,11 @@
230800230820
},
230801230821
"body_text": {
230802230822
"type": "string"
230823+
},
230824+
"discussion_url": {
230825+
"description": "The URL of the release discussion.",
230826+
"type": "string",
230827+
"format": "uri"
230803230828
}
230804230829
},
230805230830
"required": [
@@ -231400,6 +231425,11 @@
231400231425
},
231401231426
"body_text": {
231402231427
"type": "string"
231428+
},
231429+
"discussion_url": {
231430+
"description": "The URL of the release discussion.",
231431+
"type": "string",
231432+
"format": "uri"
231403231433
}
231404231434
},
231405231435
"required": [

0 commit comments

Comments
 (0)