You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Note:** {% data reusables.repositories.auto-gen-release-public-beta %}
19
-
20
-
{% endnote %}
21
-
22
16
## About automatically generated release notes
23
17
24
18
Automatically generated release notes provide an automated alternative to manually writing release notes for your {% data variables.product.prodname_dotcom %} releases. With automatically generated release notes, you can quickly generate an overview of the contents of a release. You can also customize your automated release notes, using labels to create custom categories to organize pull requests you want to include, and exclude certain labels and users from appearing in the output.
4. {% ifversion fpt or ghec %}Click **Choose a tag** and type{% else %}Type{% endif %} a version number for your release. Alternatively, select an existing tag.
45
+
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %}{% else %}{% endif %}
46
+
4. {% ifversion fpt or ghec %}Click **Choose a tag**, type{% else %}Type{% endif %} a version number for your release{% ifversion fpt or ghec %}, and press **Enter**{% endif %}. Alternatively, select an existing tag.
47
47
{% ifversion fpt or ghec %}
48
48
49
-
1. If you are creating a new tag, click **Create new tag**.
49
+
5. If you are creating a new tag, click **Create new tag**.
50
50
{%- ifversion fpt or ghes > 3.2 or ghae-issue-4972 %}
59
+
{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4972 %}
60
60
If you @mention any {% data variables.product.product_name %} users in the description, the published release will include a **Contributors** section with an avatar list of all the mentioned users.
61
61
{%- endif %}
62
62
{% ifversion fpt or ghec %} Alternatively, you can automatically generate your release notes by clicking **Auto-generate release notes**.
@@ -66,17 +66,21 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da
66
66
67
67
8. To notify users that the release is not ready for production and may be unstable, select **This is a pre-release**.
68
68
69
-
{%- ifversion fpt %}
70
-
1. Optionally, select **Create a discussion for this release**, then select the **Category** drop-down menu and click a category for the release discussion.
69
+
{%- ifversion fpt or ghec %}
70
+
1. Optionally, if {% data variables.product.prodname_discussions %} are enabled in the repository, select **Create a discussion for this release**, then select the **Category** drop-down menu and click a category for the release discussion.
71
71
72
72
{%- endif %}
73
73
9. If you're ready to publicize your release, click **Publish release**. To work on the release later, click **Save draft**.
74
74
75
75
76
-
{%- ifversion fpt or ghes > 3.2 or ghae-issue-4972 %}
76
+
{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4972 or ghae-issue-4974 %}
77
77
You can then view your published or draft releases in the releases feed for your repository. For more information, see "[Viewing your repository's releases and tags](/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags)."
78
78
79
+
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %}
80
+
81
+
{% else %}
79
82
83
+
{% endif %}
80
84
{%- endif %}
81
85
82
86
{% endwebui %}
@@ -110,9 +114,14 @@ If you @mention any {% data variables.product.product_name %} users in the notes
110
114
111
115
{% data reusables.repositories.navigate-to-repo %}
112
116
{% data reusables.repositories.releases %}
117
+
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %}
118
+
3. On the right side of the page, next to the release you want to edit, click {% octicon "pencil" aria-label="The edit icon" %}.
119
+
120
+
{% else %}
113
121
3. On the right side of the page, next to the release you want to edit, click **Edit release**.
114
122
115
-
4. Edit the details for the release in the form, then click **Update release**.{% ifversion fpt or ghes > 3.2 or ghae-issue-4972 or ghec %} If you add or remove any @mentions of GitHub users in the description, those users will be added or removed from the avatar list in the **Contributors** section of the release.{% endif %}
123
+
{% endif %}
124
+
4. Edit the details for the release in the form, then click **Update release**.{% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4972 %} If you add or remove any @mentions of GitHub users in the description, those users will be added or removed from the avatar list in the **Contributors** section of the release.{% endif %}
116
125
117
126
118
127
{% endwebui %}
@@ -131,10 +140,15 @@ Releases cannot currently be edited with {% data variables.product.prodname_cli
131
140
132
141
{% data reusables.repositories.navigate-to-repo %}
133
142
{% data reusables.repositories.releases %}
143
+
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %}
144
+
3. On the right side of the page, next to the release you want to delete, click {% octicon "trash" aria-label="The trash icon" %}.
145
+
146
+
{% else %}
134
147
3. Click the name of the release you wish to delete.
135
148
136
149
4. In the upper-right corner of the page, click **Delete**.
## Search syntax for searching releases in a repository
23
+
24
+
You can provide text in your search query which will be matched against the title, body, and tag of the repository's releases. You can also combine the following qualifiers to target specific releases.
25
+
26
+
| Qualifier | Example
27
+
| ------------- | -------------
28
+
| `draft:true` | **draft:true** will only match draft releases.
29
+
| `draft:false` | **draft:false** will only match published releases.
30
+
| <code>tag:<em>TAG</em></code> | **tag:v1** matches a release with the v1 tag and any minor or patch versions within v1, such as v1.0, v1.2, and v1.2.5.
31
+
| <code>created:<em>DATE</em></code> | **created:2021** will match releases created during 2021. You can also provide date ranges. For more information, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
0 commit comments