diff --git a/assets/images/help/releases/delete-release-trash.png b/assets/images/help/releases/delete-release-trash.png new file mode 100644 index 000000000000..f8aa8c037e58 Binary files /dev/null and b/assets/images/help/releases/delete-release-trash.png differ diff --git a/assets/images/help/releases/draft-release-button-with-search.png b/assets/images/help/releases/draft-release-button-with-search.png new file mode 100644 index 000000000000..b2fe77167cf3 Binary files /dev/null and b/assets/images/help/releases/draft-release-button-with-search.png differ diff --git a/assets/images/help/releases/edit-release-pencil.png b/assets/images/help/releases/edit-release-pencil.png new file mode 100644 index 000000000000..b716ca48a023 Binary files /dev/null and b/assets/images/help/releases/edit-release-pencil.png differ diff --git a/assets/images/help/releases/refreshed-compare-tags-menu-options.png b/assets/images/help/releases/refreshed-compare-tags-menu-options.png new file mode 100644 index 000000000000..03f0d523dc16 Binary files /dev/null and b/assets/images/help/releases/refreshed-compare-tags-menu-options.png differ diff --git a/assets/images/help/releases/refreshed-compare-tags.png b/assets/images/help/releases/refreshed-compare-tags.png new file mode 100644 index 000000000000..d4795b44c49e Binary files /dev/null and b/assets/images/help/releases/refreshed-compare-tags.png differ diff --git a/assets/images/help/releases/refreshed-release-latest.png b/assets/images/help/releases/refreshed-release-latest.png new file mode 100644 index 000000000000..cf471d217783 Binary files /dev/null and b/assets/images/help/releases/refreshed-release-latest.png differ diff --git a/assets/images/help/releases/refreshed-releases-overview-with-contributors.png b/assets/images/help/releases/refreshed-releases-overview-with-contributors.png new file mode 100644 index 000000000000..57b2709fb5d6 Binary files /dev/null and b/assets/images/help/releases/refreshed-releases-overview-with-contributors.png differ diff --git a/assets/images/help/releases/release-compare-button.png b/assets/images/help/releases/release-compare-button.png new file mode 100644 index 000000000000..d66e6c2fed31 Binary files /dev/null and b/assets/images/help/releases/release-compare-button.png differ diff --git a/assets/images/help/releases/release-compare-menu.png b/assets/images/help/releases/release-compare-menu.png new file mode 100644 index 000000000000..6f5765bd66fd Binary files /dev/null and b/assets/images/help/releases/release-compare-menu.png differ diff --git a/assets/images/help/releases/release-link.png b/assets/images/help/releases/release-link.png index a218ada8a8af..3fa4942d6da3 100644 Binary files a/assets/images/help/releases/release-link.png and b/assets/images/help/releases/release-link.png differ diff --git a/assets/images/help/releases/release-title-old.png b/assets/images/help/releases/release-title-old.png new file mode 100644 index 000000000000..1691f79edcb2 Binary files /dev/null and b/assets/images/help/releases/release-title-old.png differ diff --git a/assets/images/help/releases/release-title.png b/assets/images/help/releases/release-title.png new file mode 100644 index 000000000000..14bd4efcb762 Binary files /dev/null and b/assets/images/help/releases/release-title.png differ diff --git a/assets/images/help/releases/search-releases.png b/assets/images/help/releases/search-releases.png new file mode 100644 index 000000000000..cd4e1c63c941 Binary files /dev/null and b/assets/images/help/releases/search-releases.png differ diff --git a/content/repositories/releasing-projects-on-github/about-releases.md b/content/repositories/releasing-projects-on-github/about-releases.md index 2f46b8ccea2a..0cce977a1cea 100644 --- a/content/repositories/releasing-projects-on-github/about-releases.md +++ b/content/repositories/releasing-projects-on-github/about-releases.md @@ -19,7 +19,9 @@ topics: --- ## About releases -{% ifversion fpt or ghes > 3.2 or ghae-issue-4972 or ghec %} +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} +![An overview of releases](/assets/images/help/releases/refreshed-releases-overview-with-contributors.png) +{% elsif ghes > 3.2 or ghae-issue-4972 %} ![An overview of releases](/assets/images/help/releases/releases-overview-with-contributors.png) {% else %} ![An overview of releases](/assets/images/help/releases/releases-overview.png) diff --git a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md index c053b1e30573..97a16747e556 100644 --- a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md +++ b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md @@ -13,12 +13,6 @@ communityRedirect: href: 'https://github.com/github/feedback/discussions/categories/releases-feedback' --- -{% note %} - -**Note:** {% data reusables.repositories.auto-gen-release-public-beta %} - -{% endnote %} - ## About automatically generated release notes 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. diff --git a/content/repositories/releasing-projects-on-github/comparing-releases.md b/content/repositories/releasing-projects-on-github/comparing-releases.md index 6f65df2eaaa7..3e9c13d4e9d4 100644 --- a/content/repositories/releasing-projects-on-github/comparing-releases.md +++ b/content/repositories/releasing-projects-on-github/comparing-releases.md @@ -16,6 +16,14 @@ redirect_from: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} 3. Next to the release you want to use as your base, click **Compare**. + {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} + ![Compare release tags menu](/assets/images/help/releases/refreshed-compare-tags.png) + {% else %} ![Compare release tags menu](/assets/images/help/releases/compare-tags-menu.png) + {% endif %} 4. Use the "Compare" drop-down menu and select the tags you want to compare. + {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} + ![Compare release tags menu](/assets/images/help/releases/refreshed-compare-tags-menu-options.png) + {% else %} ![Compare release tags menu options](/assets/images/help/releases/compare-tags-menu-options.png) + {% endif %} \ No newline at end of file diff --git a/content/repositories/releasing-projects-on-github/index.md b/content/repositories/releasing-projects-on-github/index.md index 2966855a2c90..ede9b1807a5d 100644 --- a/content/repositories/releasing-projects-on-github/index.md +++ b/content/repositories/releasing-projects-on-github/index.md @@ -16,6 +16,7 @@ children: - /about-releases - /managing-releases-in-a-repository - /viewing-your-repositorys-releases-and-tags + - /searching-a-repositorys-releases - /linking-to-releases - /comparing-releases - /automatically-generated-release-notes diff --git a/content/repositories/releasing-projects-on-github/linking-to-releases.md b/content/repositories/releasing-projects-on-github/linking-to-releases.md index de215394643b..9d24722a6ff5 100644 --- a/content/repositories/releasing-projects-on-github/linking-to-releases.md +++ b/content/repositories/releasing-projects-on-github/linking-to-releases.md @@ -15,9 +15,16 @@ topics: --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} -3. Find the release you want to link to and click the version number. - ![Releases tag information](/assets/images/help/releases/release_tag_name.png) -3. Alternatively, right click **Latest Release** and copy the URL to share it. The suffix of this URL is always `/releases/latest`. +3. To copy a unique URL to your clipboard, find the release you want to link to, right click the title, and copy the URL. +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} + ![Release title](/assets/images/help/releases/release-title.png) +{% else %} + ![Release title](/assets/images/help/releases/release-title-old.png) +{% endif %} +1. Alternatively, right click **Latest Release** and copy the URL to share it. The suffix of this URL is always `/releases/latest`. + {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} + ![Compare release tags menu](/assets/images/help/releases/refreshed-release-latest.png) + {% else %} ![Latest release tag](/assets/images/help/releases/release_latest_release_tag.png) - + {% endif %} To link directly to a download of your latest release asset that was manually uploaded, link to `/owner/name/releases/latest/download/asset-name.zip`. diff --git a/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index c4f734a804b4..733b51afe04e 100644 --- a/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -42,11 +42,11 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} 3. Click **Draft a new release**. - ![Releases draft button](/assets/images/help/releases/draft_release_button.png) -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. + {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %}![Releases draft button](/assets/images/help/releases/draft-release-button-with-search.png){% else %}![Releases draft button](/assets/images/help/releases/draft_release_button.png){% endif %} +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. {% ifversion fpt or ghec %} ![Enter a tag](/assets/images/help/releases/releases-tag-create.png) -1. If you are creating a new tag, click **Create new tag**. +5. If you are creating a new tag, click **Create new tag**. ![Confirm you want to create a new tag](/assets/images/help/releases/releases-tag-create-confirm.png) {% else %} ![Releases tagged version](/assets/images/enterprise/releases/releases-tag-version.png) @@ -56,7 +56,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da {% else %}![Releases tagged branch](/assets/images/enterprise/releases/releases-tag-branch.png) {% endif %} 6. Type a title and description for your release. - {%- ifversion fpt or ghes > 3.2 or ghae-issue-4972 %} + {%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4972 %} 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. {%- endif %} {% 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 ![Providing a DMG with the Release](/assets/images/help/releases/releases_adding_binary.gif) 8. To notify users that the release is not ready for production and may be unstable, select **This is a pre-release**. ![Checkbox to mark a release as prerelease](/assets/images/help/releases/prerelease_checkbox.png) -{%- ifversion fpt %} -1. Optionally, select **Create a discussion for this release**, then select the **Category** drop-down menu and click a category for the release discussion. +{%- ifversion fpt or ghec %} +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. ![Checkbox to create a release discussion and drop-down menu to choose a category](/assets/images/help/releases/create-release-discussion.png) {%- endif %} 9. If you're ready to publicize your release, click **Publish release**. To work on the release later, click **Save draft**. ![Publish release and Draft release buttons](/assets/images/help/releases/release_buttons.png) - {%- ifversion fpt or ghes > 3.2 or ghae-issue-4972 %} + {%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4972 or ghae-issue-4974 %} 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)." + {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} + ![Published release with @mentioned contributors](/assets/images/help/releases/refreshed-releases-overview-with-contributors.png) + {% else %} ![Published release with @mentioned contributors](/assets/images/help/releases/releases-overview-with-contributors.png) + {% endif %} {%- endif %} {% endwebui %} @@ -110,9 +114,14 @@ If you @mention any {% data variables.product.product_name %} users in the notes {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} +3. On the right side of the page, next to the release you want to edit, click {% octicon "pencil" aria-label="The edit icon" %}. + ![Edit a release](/assets/images/help/releases/edit-release-pencil.png) +{% else %} 3. On the right side of the page, next to the release you want to edit, click **Edit release**. ![Edit a release](/assets/images/help/releases/edit-release.png) -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 %} +{% endif %} +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 %} ![Update a release](/assets/images/help/releases/update-release.png) {% endwebui %} @@ -131,10 +140,15 @@ Releases cannot currently be edited with {% data variables.product.prodname_cli {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-4974 %} +3. On the right side of the page, next to the release you want to delete, click {% octicon "trash" aria-label="The trash icon" %}. + ![Delete a release](/assets/images/help/releases/delete-release-trash.png) +{% else %} 3. Click the name of the release you wish to delete. ![Link to view release](/assets/images/help/releases/release-name-link.png) 4. In the upper-right corner of the page, click **Delete**. ![Delete release button](/assets/images/help/releases/delete-release.png) +{% endif %} 5. Click **Delete this release**. ![Confirm delete release](/assets/images/help/releases/confirm-delete-release.png) diff --git a/content/repositories/releasing-projects-on-github/searching-a-repositorys-releases.md b/content/repositories/releasing-projects-on-github/searching-a-repositorys-releases.md new file mode 100644 index 000000000000..e4cc02c231d5 --- /dev/null +++ b/content/repositories/releasing-projects-on-github/searching-a-repositorys-releases.md @@ -0,0 +1,31 @@ +--- +title: Searching a repository's releases +intro: You can use keywords, tags, and other qualifiers to search for particular releases in a repository. +permissions: Anyone with read access to a repository can search that repository's releases. +shortTitle: Searching releases +versions: + fpt: '*' + ghec: '*' + ghes: '>3.2' + ghae-issue-4974: '*' +topics: + - Repositories +--- + +## Searching for releases in a repository + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.releases %} +1. To search the repository's releases, in the search field at the top of the Releases page, type your query and press **Enter**. +![Releases search field](/assets/images/help/releases/search-releases.png) + +## Search syntax for searching releases in a repository + +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. + +| Qualifier | Example +| ------------- | ------------- +| `draft:true` | **draft:true** will only match draft releases. +| `draft:false` | **draft:false** will only match published releases. +| tag:TAG | **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. +| created:DATE | **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)." \ No newline at end of file diff --git a/data/reusables/repositories/releases.md b/data/reusables/repositories/releases.md index db1c67ed596b..6f578222c94a 100644 --- a/data/reusables/repositories/releases.md +++ b/data/reusables/repositories/releases.md @@ -1,2 +1,2 @@ -1. To the right of the list of files, click **Releases** or **Latest release**. +1. To the right of the list of files, click **Releases**. ![Releases section in right-hand sidebar](/assets/images/help/releases/release-link.png)