forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of github.com:github/docs-internal into refactor-…
…site-tree
- Loading branch information
Showing
89 changed files
with
969 additions
and
527 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: Send pull_request to How We Work Boards | ||
|
||
# **What it does**: This sends pull requests with the feature label to the Docs Engineering feature board | ||
# **Why we have it**: If we use PRs to track features this automates them ending up on the feature board | ||
# **Who does it impact**: Docs Engineering team members | ||
|
||
on: | ||
pull_request: | ||
types: | ||
- labeled | ||
- opened | ||
- reopened | ||
|
||
jobs: | ||
triage: | ||
runs-on: ubuntu-latest | ||
continue-on-error: true | ||
steps: | ||
- if: (github.repository == 'github/docs-internal' || github.repository == 'github/docs') && (contains(github.event.pull_request.labels.*.name, 'engineering') && contains(github.event.pull_request.labels.*.name, 'feature')) | ||
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 | ||
with: | ||
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} | ||
script: | | ||
// Only do this for work by the engineering folks since multiple teams do work | ||
// in the docs repos | ||
try { | ||
await github.teams.getMembershipForUserInOrg({ | ||
org: 'github', | ||
team_slug: 'docs-engineering', | ||
username: context.payload.sender.login, | ||
}); | ||
} catch(err) { | ||
return | ||
} | ||
var column_id = 13445681; | ||
try { | ||
github.projects.createCard({ | ||
column_id: column_id, | ||
content_id: context.payload.pull_request.id, | ||
content_type: "PullRequest" | ||
}); | ||
} catch (error) { | ||
console.log(error); | ||
} |
Binary file added
BIN
+38.6 KB
assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-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
BIN
+46.4 KB
assets/images/enterprise/3.1/help/repository/code-scanning-branch-dropdown.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
BIN
+184 KB
assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.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
BIN
+43.9 KB
assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.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
BIN
+230 KB
assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png
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
BIN
-31.7 KB
(82%)
assets/images/help/notifications-v2/mobile-watch-settings.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 modified
BIN
+11.1 KB
(130%)
assets/images/help/repository/code-scanning-alerts-found-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 modified
BIN
-27 KB
(51%)
assets/images/help/repository/code-scanning-branch-dropdown.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 modified
BIN
-46.9 KB
(50%)
assets/images/help/repository/code-scanning-branch-filter.png
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
BIN
-72.4 KB
(41%)
assets/images/help/repository/code-scanning-filter-by-rule.png
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,8 +45,15 @@ You need write permission to view a summary of all the alerts for a repository o | |
{% data reusables.repositories.navigate-to-repo %} | ||
{% data reusables.repositories.sidebar-security %} | ||
{% data reusables.repositories.sidebar-code-scanning-alerts %} | ||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]"%} | ||
1. Optionally, use the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. | ||
![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} | ||
1. Under "{% data variables.product.prodname_code_scanning_capc %}," click the alert you'd like to explore. | ||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]"%} | ||
![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) | ||
{% else %} | ||
![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) | ||
{% endif %} | ||
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. | ||
![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) | ||
1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code. | ||
|
@@ -60,7 +67,11 @@ If you have write permission for a repository, you can view fixed alerts by view | |
|
||
Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. | ||
|
||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]"%} | ||
![Filtering alerts by branch](/assets/images/help/repository/code-scanning-branch-filter.png) | ||
{% else %} | ||
![Filtering alerts by branch](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) | ||
{% endif %} | ||
|
||
{% if currentVersion == "[email protected]" %} | ||
|
||
|
@@ -113,11 +124,19 @@ To dismiss or delete alerts: | |
|
||
Optionally, you can use the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. | ||
|
||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]"%} | ||
![Filter alerts by rule](/assets/images/help/repository/code-scanning-filter-by-rule.png) | ||
{% else %} | ||
![Filter alerts by rule](/assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png) | ||
{% endif %} | ||
|
||
1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore. | ||
|
||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]"%} | ||
![Open an alert from the summary list](/assets/images/help/repository/code-scanning-click-alert.png) | ||
{% else %} | ||
![List of alerts from {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) | ||
{% endif %} | ||
|
||
1. Review the alert, then click **Dismiss** and choose a reason for closing the alert. | ||
![Choosing a reason for dismissing an alert](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -76,7 +76,11 @@ After setting up {% data variables.product.prodname_code_scanning %} for your re | |
|
||
**Note:** If you raised a pull request to add the {% data variables.product.prodname_code_scanning %} workflow to the repository, alerts from that pull request aren't displayed directly on the {% data variables.product.prodname_code_scanning_capc %} page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the **_n_ alerts found** link in the banner on the {% data variables.product.prodname_code_scanning_capc %} page. | ||
|
||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]"%} | ||
![Click the "n alerts found" link](/assets/images/help/repository/code-scanning-alerts-found-link.png) | ||
{% else %} | ||
![Click the "n alerts found" link](/assets/images/enterprise/3.1/help/repository/code-scanning-alerts-found-link.png) | ||
{% endif %} | ||
|
||
{% endnote %} | ||
|
||
|
@@ -102,7 +106,11 @@ There are other situations where there may be no analysis for the latest commit | |
|
||
To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. | ||
|
||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]"%} | ||
![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) | ||
{% else %} | ||
![Choose a branch from the Branch drop-down menu](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-dropdown.png) | ||
{% endif %} | ||
|
||
The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 23 additions & 0 deletions
23
.../contributing-and-collaborating-using-github-desktop/cherry-picking-a-commit.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: Cherry-picking a commit | ||
intro: You can pick a specific commit on one branch and copy the commit to another branch. | ||
versions: | ||
free-pro-team: '*' | ||
--- | ||
|
||
### About Git cherry-pick | ||
|
||
You can cherry-pick a commit on one branch to create a copy of the commit with the same changes on another branch. If you commit changes to the wrong branch or want to make the same changes to another branch, you can cherry-pick the commit to apply the changes to another branch. You can also use cherry-picking to apply specific changes before you are ready to create or merge a pull request. For example, if you commit a bug fix to a feature branch, you can cherry-pick the commit with the bug fix to other branches of your project. | ||
|
||
You can also use cherry-picking when collaborating with a team. Some projects incorporate contributions by cherry-picking commits. For more information, see [Distributed Git - Maintaining a Project](https://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#_rebase_cherry_pick) in the Git documentation. | ||
|
||
### Cherry-picking a commit | ||
|
||
{% data reusables.desktop.current-branch-menu %} | ||
2. In the list of branches, click the branch that has the commit that you want to cherry-pick. | ||
{% data reusables.desktop.history-tab %} | ||
4. Drag the commit that you want to cherry-pick to the {% octicon "git-branch" aria-label="The branch icon" %} **Current Branch** menu and drop the commit on the branch that you want to copy the commit to. | ||
![Dragging a commit to another branch in the Current Branch menu](/assets/images/help/desktop/cherry-picking.png) | ||
|
||
### Further reading | ||
- [git-cherry-pick](https://git-scm.com/docs/git-cherry-pick) in the Git documentation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.