Update branch name (#35446)
Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
This commit is contained in:
@@ -105,7 +105,7 @@ This procedure demonstrates how to create a workflow template and metadata file.
|
|||||||
* An icon from {% data variables.product.prodname_dotcom %}'s set of [Octicons](https://primer.style/octicons/). To reference an octicon, the value must be `octicon <icon name>`. For example, `octicon smiley`.
|
* An icon from {% data variables.product.prodname_dotcom %}'s set of [Octicons](https://primer.style/octicons/). To reference an octicon, the value must be `octicon <icon name>`. For example, `octicon smiley`.
|
||||||
* `categories` - **Optional.** Defines the categories that the workflow is shown under. You can use category names from the following lists:
|
* `categories` - **Optional.** Defines the categories that the workflow is shown under. You can use category names from the following lists:
|
||||||
* General category names from the [starter-workflows](https://github.com/actions/starter-workflows/blob/main/README.md#categories) repository.
|
* General category names from the [starter-workflows](https://github.com/actions/starter-workflows/blob/main/README.md#categories) repository.
|
||||||
* Linguist languages from the list in the [linguist](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml) repository.
|
* Linguist languages from the list in the [linguist](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml) repository.
|
||||||
* Supported tech stacks from the list in the [starter-workflows](https://github.com/github-starter-workflows/repo-analysis-partner/blob/main/tech_stacks.yml) repository.
|
* Supported tech stacks from the list in the [starter-workflows](https://github.com/github-starter-workflows/repo-analysis-partner/blob/main/tech_stacks.yml) repository.
|
||||||
|
|
||||||
* `filePatterns` - **Optional.** Allows the workflow to be used if the user's repository has a file in its root directory that matches a defined regular expression.
|
* `filePatterns` - **Optional.** Allows the workflow to be used if the user's repository has a file in its root directory that matches a defined regular expression.
|
||||||
|
|||||||
@@ -87,7 +87,7 @@ Next, in _views/index.erb_, paste this content:
|
|||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide](https://github.com/sinatra/sinatra-book/blob/master/book/Introduction.markdown#hello-world-application).)
|
(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide](https://github.com/sinatra/sinatra-book/blob/main/book/Introduction.markdown#hello-world-application).)
|
||||||
|
|
||||||
Also, notice that the URL uses the `scope` query parameter to define the
|
Also, notice that the URL uses the `scope` query parameter to define the
|
||||||
[scopes](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) requested by the application. For our application, we're
|
[scopes](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) requested by the application. For our application, we're
|
||||||
|
|||||||
@@ -118,7 +118,7 @@ You can use a `textarea` element to add a multi-line text field to your form. Co
|
|||||||
| `description` | A description of the text area to provide context or guidance, which is displayed in the form. | {% octicon "x" aria-label="Optional" %} | String | Empty String | {% octicon "dash" aria-label="Not applicable" %} |
|
| `description` | A description of the text area to provide context or guidance, which is displayed in the form. | {% octicon "x" aria-label="Optional" %} | String | Empty String | {% octicon "dash" aria-label="Not applicable" %} |
|
||||||
| `placeholder` | A semi-opaque placeholder that renders in the text area when empty. | {% octicon "x" aria-label="Optional" %} | String | Empty String | {% octicon "dash" aria-label="Not applicable" %} |
|
| `placeholder` | A semi-opaque placeholder that renders in the text area when empty. | {% octicon "x" aria-label="Optional" %} | String | Empty String | {% octicon "dash" aria-label="Not applicable" %} |
|
||||||
| `value` | Text that is pre-filled in the text area. | {% octicon "x" aria-label="Optional" %} | String | {% octicon "dash" aria-label="Not applicable" %} | {% octicon "dash" aria-label="Not applicable" %} |
|
| `value` | Text that is pre-filled in the text area. | {% octicon "x" aria-label="Optional" %} | String | {% octicon "dash" aria-label="Not applicable" %} | {% octicon "dash" aria-label="Not applicable" %} |
|
||||||
| `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | {% octicon "x" aria-label="Optional" %} | String | {% octicon "dash" aria-label="Not applicable" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml). |
|
| `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | {% octicon "x" aria-label="Optional" %} | String | {% octicon "dash" aria-label="Not applicable" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml). |
|
||||||
|
|
||||||
#### Validations for `textarea`
|
#### Validations for `textarea`
|
||||||
|
|
||||||
|
|||||||
@@ -66,7 +66,7 @@ This will display the code block with syntax highlighting:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
We use [Linguist](https://github.com/github-linguist/linguist) to perform language detection and to select [third-party grammars](https://github.com/github-linguist/linguist/blob/master/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml).
|
We use [Linguist](https://github.com/github-linguist/linguist) to perform language detection and to select [third-party grammars](https://github.com/github-linguist/linguist/blob/main/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml).
|
||||||
|
|
||||||
## Creating diagrams
|
## Creating diagrams
|
||||||
|
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ When you publish a package that is scoped to a personal account or an organizati
|
|||||||
LABEL org.opencontainers.image.source=https://{% ifversion fpt or ghec %}github.com{% else %}{% data reusables.package_registry.container-registry-example-hostname %}{% endif %}/octocat/my-repo
|
LABEL org.opencontainers.image.source=https://{% ifversion fpt or ghec %}github.com{% else %}{% data reusables.package_registry.container-registry-example-hostname %}{% endif %}/octocat/my-repo
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, see "[LABEL](https://docs.docker.com/engine/reference/builder/#label)" in the official Docker documentation and "[Pre-defined Annotation Keys](https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys)" in the `opencontainers/image-spec` repository.
|
For more information, see "[LABEL](https://docs.docker.com/engine/reference/builder/#label)" in the official Docker documentation and "[Pre-defined Annotation Keys](https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys)" in the `opencontainers/image-spec` repository.
|
||||||
|
|
||||||
1. Build your container image. This example builds an image from the Dockerfile in the current directory and assigns the image name `hello_docker`.
|
1. Build your container image. This example builds an image from the Dockerfile in the current directory and assigns the image name `hello_docker`.
|
||||||
|
|
||||||
|
|||||||
@@ -186,7 +186,7 @@ Replace `NAMESPACE` with the name of the personal account or organization to whi
|
|||||||
|
|
||||||
{% data reusables.package_registry.about-annotation-keys %} Values for supported keys will appear on the package page for the image.
|
{% data reusables.package_registry.about-annotation-keys %} Values for supported keys will appear on the package page for the image.
|
||||||
|
|
||||||
For most images, you can use Docker labels to add the annotation keys to an image. For more information, see [LABEL](https://docs.docker.com/engine/reference/builder/#label) in the official Docker documentation and [Pre-Defined Annotation Keys](https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys) in the `opencontainers/image-spec` repository.
|
For most images, you can use Docker labels to add the annotation keys to an image. For more information, see [LABEL](https://docs.docker.com/engine/reference/builder/#label) in the official Docker documentation and [Pre-Defined Annotation Keys](https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys) in the `opencontainers/image-spec` repository.
|
||||||
|
|
||||||
For multi-arch images, you can add a description to the image by adding the appropriate annotation key to the `annotations` field in the image's manifest. For more information, see "[Adding a description to multi-arch images](#adding-a-description-to-multi-arch-images)."
|
For multi-arch images, you can add a description to the image by adding the appropriate annotation key to the `annotations` field in the image's manifest. For more information, see "[Adding a description to multi-arch images](#adding-a-description-to-multi-arch-images)."
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ shortTitle: Repository languages
|
|||||||
{% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github-linguist/linguist) to
|
{% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github-linguist/linguist) to
|
||||||
determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch.
|
determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch.
|
||||||
|
|
||||||
Some files are hard to identify, and sometimes projects contain more library and vendor files than their primary code. If you're receiving incorrect results, please consult the Linguist [troubleshooting guide](https://github.com/github-linguist/linguist/blob/master/docs/troubleshooting.md) for help. Note that Linguist only works for repositories with fewer than 100,000 files.
|
Some files are hard to identify, and sometimes projects contain more library and vendor files than their primary code. If you're receiving incorrect results, please consult the Linguist [troubleshooting guide](https://github.com/github-linguist/linguist/blob/main/docs/troubleshooting.md) for help. Note that Linguist only works for repositories with fewer than 100,000 files.
|
||||||
|
|
||||||
## Markup languages
|
## Markup languages
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ You're under no obligation to choose a license. However, without a license, the
|
|||||||
|
|
||||||
## Determining the location of your license
|
## Determining the location of your license
|
||||||
|
|
||||||
Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md` or `LICENSE.rst`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md).
|
Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md` or `LICENSE.rst`) in the root of the repository; [here's an example from Hubot](https://github.com/hubotio/hubot/blob/main/LICENSE.md).
|
||||||
|
|
||||||
Some projects include information about their license in their README. For example, a project's README may include a note saying "This project is licensed under the terms of the MIT license."
|
Some projects include information about their license in their README. For example, a project's README may include a note saying "This project is licensed under the terms of the MIT license."
|
||||||
|
|
||||||
|
|||||||
@@ -26,5 +26,5 @@ Use a _.gitattributes_ file to mark files that match a given "pattern" with the
|
|||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
* "[Generated code](https://github.com/github-linguist/linguist/blob/master/docs/overrides.md#generated-code)" in the Linguist documentation
|
* "[Generated code](https://github.com/github-linguist/linguist/blob/main/docs/overrides.md#generated-code)" in the Linguist documentation
|
||||||
* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||||
|
|||||||
@@ -148,7 +148,7 @@ To narrow down to a specific languages, use the `language:` qualifier. For examp
|
|||||||
language:ruby OR language:cpp OR language:csharp
|
language:ruby OR language:cpp OR language:csharp
|
||||||
```
|
```
|
||||||
|
|
||||||
For a complete list of supported language names, see [languages.yaml](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml) in [github-linguist/linguist](https://github.com/github-linguist/linguist). If your preferred language is not on the list, you can open a pull request to add it.
|
For a complete list of supported language names, see [languages.yaml](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml) in [github-linguist/linguist](https://github.com/github-linguist/linguist). If your preferred language is not on the list, you can open a pull request to add it.
|
||||||
|
|
||||||
### Path qualifier
|
### Path qualifier
|
||||||
|
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ By default, file finder results do not include files in the following directorie
|
|||||||
|
|
||||||
You can override these default exclusions using a `.gitattributes` file.
|
You can override these default exclusions using a `.gitattributes` file.
|
||||||
|
|
||||||
To do this, create or update a file called `.gitattributes` in your repository root, setting the [`linguist-generated`](https://github.com/github-linguist/linguist/blob/master/docs/overrides.md) attribute to `false` for each directory that should be included in file finder results.
|
To do this, create or update a file called `.gitattributes` in your repository root, setting the [`linguist-generated`](https://github.com/github-linguist/linguist/blob/main/docs/overrides.md) attribute to `false` for each directory that should be included in file finder results.
|
||||||
|
|
||||||
For example, the following `.gitattributes` file would cause files in the `build/` directory to be available to the file finder:
|
For example, the following `.gitattributes` file would cause files in the `build/` directory to be available to the file finder:
|
||||||
|
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ You can use the `path` qualifier to search for source code that appears at a spe
|
|||||||
|
|
||||||
## Search by language
|
## Search by language
|
||||||
|
|
||||||
You can search for code based on what language it's written in. The `language` qualifier can be the language name or alias. For a full list of supported languages with their names and aliases, see the [github-linguist/linguist repository](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml).
|
You can search for code based on what language it's written in. The `language` qualifier can be the language name or alias. For a full list of supported languages with their names and aliases, see the [github-linguist/linguist repository](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml).
|
||||||
|
|
||||||
| Qualifier | Example
|
| Qualifier | Example
|
||||||
| ------------- | -------------
|
| ------------- | -------------
|
||||||
|
|||||||
Reference in New Issue
Block a user