Skip to content
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.

Sign up for GitHub

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

Be sure to define 'description' #35804

Merged
merged 3 commits into from
Jan 6, 2025
Merged

Be sure to define 'description' #35804

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76652e8
Be sure to define 'description'
MichaelChirico Jan 1, 2025
ba3fc5c
Move note and definition of description into first section
felicitymay Jan 2, 2025
6ceaf50
Merge branch 'main' into patch-1
nguyenalex836 Jan 6, 2025
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
2 changes: 1 addition & 1 deletion ...acking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Linking a pull request to an issue
intro: 'You can link a pull request {% ifversion link-existing-branches-to-issue %}or branch {% endif %}to an issue to show that a fix is in progress and to automatically close the issue when the pull request {% ifversion link-existing-branches-to-issue %}or branch {% endif %} is merged.'

Check warning on line 3 in content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true 

The Liquid ifversion condition 'link-existing-branches-to-issue' includes all possible versions and will always be true.

Check warning on line 3 in content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true 

The Liquid ifversion condition 'link-existing-branches-to-issue' includes all possible versions and will always be true.
redirect_from:
- /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/linking-a-pull-request-to-an-issue
- /articles/closing-issues-via-commit-message
Expand All @@ -20,7 +20,7 @@
---

> [!NOTE]
> The special keywords in a pull request description are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.**
> The special keywords in a pull request description, i.e. the text comment accompanying the title written by the PR author, are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.**
MichaelChirico marked this conversation as resolved.
Show resolved Hide resolved

## About linked issues and pull requests

Expand Down Expand Up @@ -70,7 +70,7 @@
{% data reusables.pull_requests.click-development-in-pull-request %}
1. Click the issue you want to link to the pull request.

{% ifversion link-existing-branches-to-issue %}

Check warning on line 73 in content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true 

The Liquid ifversion condition 'link-existing-branches-to-issue' includes all possible versions and will always be true.

## Manually linking a pull request or branch to an issue using the issue sidebar

Expand Down
Loading