Skip to content

repo sync #11304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/releases/release-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/releases/release-title-old.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/releases/release-title.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/releases/search-releases.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
1 change: 1 addition & 0 deletions content/repositories/releasing-projects-on-github/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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**.
Expand All @@ -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 %}
Expand Down Expand Up @@ -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 %}
Expand All @@ -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)

Expand Down
Original file line number Diff line number Diff line change
@@ -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.
| <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.
| <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)."
2 changes: 1 addition & 1 deletion data/reusables/repositories/releases.md
Original file line number Diff line number Diff line change
@@ -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)