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.
Check repository references (github#16680)
* Check repository references * Remove "foundRepoNames" that I used to find all the unique names * A little speed up with Set * Ignore a few files * Remove remaining references * Update README.md
- Loading branch information
Showing
33 changed files
with
140 additions
and
94 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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +0,0 @@ | ||
## Importing Aftermarket Octicons | ||
|
||
#### Background | ||
Some octicons are missing from the project's current version of the `octicons` gem. Because this project is being replaced soon and updating `octicons` would require [significant changes](https://github.com/github/docs-internal/issues/6250#issuecomment-339730405), new octicons should be added manually as needed, via the following process: | ||
|
||
#### How to add | ||
|
||
1. Locate the missing octicon `.svg` in [primer/octions](https://github.com/primer/octicons/tree/master/lib/svg) and download it to your local `app/assets/images/octions` folder | ||
1. Add a line to `app/assets/stylesheets/shared/_octicons.scss` for the new octicon, like so: | ||
```apple css | ||
.octicon-<YOUR OCTICON NAME>:before { | ||
content: url("#{$new-octicons-path}/<YOUR OCTICON FILENAME>.svg") | ||
} | ||
``` | ||
|
||
You may now use the new octicon in your content as normal! :tada: | ||
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 |
---|---|---|
|
@@ -44,11 +44,11 @@ Scanning code when someone pushes a change, and whenever a pull request is creat | |
|
||
#### Scanning on push | ||
|
||
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)." | ||
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)." | ||
|
||
#### Scanning pull requests | ||
|
||
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "[email protected]" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} | ||
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "[email protected]" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} | ||
|
||
For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)." | ||
|
||
|
@@ -148,14 +148,14 @@ jobs: | |
matrix: | ||
language: ['javascript', 'python'] | ||
``` | ||
|
||
If your workflow does not contain a matrix called `language`, then {% data variables.product.prodname_codeql %} is configured to run analysis sequentially. If you don't specify languages in the workflow, {% data variables.product.prodname_codeql %} automatically detects, and attempts to analyze, any supported languages in the repository. If you want to choose which languages to analyze, without using a matrix, you can use the `languages` parameter under the `init` action. | ||
|
||
```yaml | ||
- uses: github/codeql-action/init@v1 | ||
with: | ||
languages: cpp, csharp, python | ||
``` | ||
``` | ||
{% if currentVersion == "free-pro-team@latest" %} | ||
### Analyzing Python dependencies | ||
|
||
|
@@ -183,7 +183,7 @@ jobs: | |
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
if [ -f requirements.txt ]; | ||
if [ -f requirements.txt ]; | ||
then pip install -r requirements.txt; | ||
fi | ||
# Set the `CODEQL-PYTHON` environment variable to the Python executable | ||
|
@@ -193,10 +193,10 @@ jobs: | |
uses: github/codeql-action/init@v1 | ||
with: | ||
languages: python | ||
# Override the default behavior so that the action doesn't attempt | ||
# Override the default behavior so that the action doesn't attempt | ||
# to auto-install Python dependencies | ||
setup-python-dependencies: false | ||
``` | ||
``` | ||
{% endif %} | ||
### Running additional queries | ||
|
@@ -239,7 +239,7 @@ In the workflow file, use the `config-file` parameter of the `init` action to sp | |
``` | ||
|
||
The configuration file can be located within the local repository, or in a public, remote repository. For remote repositories, you can use the _owner/repository/file.yml@branch_ syntax. The settings in the file are written in YAML format. | ||
|
||
#### Specifying additional queries | ||
|
||
You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file. | ||
|
@@ -265,15 +265,15 @@ For the interpreted languages that {% data variables.product.prodname_codeql %} | |
|
||
``` yaml | ||
paths: | ||
- src | ||
paths-ignore: | ||
- src | ||
paths-ignore: | ||
- src/node_modules | ||
- '**/*.test.js' | ||
``` | ||
|
||
{% note %} | ||
|
||
**Note**: | ||
**Note**: | ||
|
||
* The `paths` and `paths-ignore` keywords, used in the context of the {% data variables.product.prodname_code_scanning %} configuration file, should not be confused with the same keywords when used for `on.<push|pull_request>.paths` in a workflow. When they are used to modify `on.<push|pull_request>` in a workflow, they determine whether the actions will be run when someone modifies code in the specified directories. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)." | ||
* `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. For example, `foo/**`, `**/foo`, and `foo/**/bar` are all allowed syntax, but `**foo` isn't. However you can use single stars along with other characters, as shown in the example. You'll need to quote anything that contains a `*` character. | ||
|
@@ -298,7 +298,7 @@ You can quickly analyze small portions of a monorepo when you modify code in spe | |
|
||
If your workflow for {% data variables.product.prodname_code_scanning %} accesses a private repository, other than the repository that contains the workflow, you'll need to configure Git to authenticate with a personal access token. Define the secret in the runner environment by using `jobs.<job_id>.steps.env` in your workflow before any {% data variables.product.prodname_codeql %} actions. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)" and "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)." | ||
|
||
For example, the following configuration has Git replace the full URLs to the `github/foo`, `github/bar`, and `github/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable. | ||
For example, the following configuration has Git replace the full URLs to the `ghost/foo`, `ghost/bar`, and `ghost/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable. | ||
|
||
{% raw %} | ||
```yaml | ||
|
@@ -307,9 +307,9 @@ steps: | |
env: | ||
TOKEN: ${{ secrets.ACCESS_TOKEN }} | ||
run: | | ||
git config --global url."https://${TOKEN}@github.com/github/foo".insteadOf "https://github.com/github/foo" | ||
git config --global url."https://${TOKEN}@github.com/github/bar".insteadOf "https://github.com/github/bar" | ||
git config --global url."https://${TOKEN}@github.com/github/baz".insteadOf "https://github.com/github/baz" | ||
git config --global url."https://${TOKEN}@github.com/ghost/foo".insteadOf "https://github.com/ghost/foo" | ||
git config --global url."https://${TOKEN}@github.com/ghost/bar".insteadOf "https://github.com/ghost/bar" | ||
git config --global url."https://${TOKEN}@github.com/ghost/baz".insteadOf "https://github.com/ghost/baz" | ||
``` | ||
{% endraw %} | ||
|
||
|
Oops, something went wrong.