1
0
mirror of synced 2026-01-05 03:06:35 -05:00

Merge pull request #8456 from github/repo-sync

repo sync
This commit is contained in:
Octomerger Bot
2021-07-23 08:45:35 +10:00
committed by GitHub
24 changed files with 2417 additions and 2076 deletions

View File

@@ -31,3 +31,7 @@ jobs:
# The message for the commit
message: 'Run script/i18n/homogenize-frontmatter.js'
env:
# Disable pre-commit hooks; they don't play nicely with add-and-commit
HUSKY: 0

View File

@@ -41,3 +41,7 @@ jobs:
# The message for the commit
message: 'Add decorated OpenAPI schema files'
env:
# Disable pre-commit hooks; they don't play nicely with add-and-commit
HUSKY: 0

Binary file not shown.

After

Width:  |  Height:  |  Size: 438 KiB

View File

@@ -0,0 +1,43 @@
---
title: About CITATION files
intro: 'You can add a CITATION file to your repository to help users correctly cite your software.'
versions:
fpt: '*'
ghes: '>=3.3'
ghae: '>=M3'
topics:
- Repositories
---
## About CITATION files
You can add a `CITATION.cff` file to the root of a repository to let others know how you would like them to cite your work. The citation file format is plain text with human- and machine-readable citation information.
Example CITATION.cff:
```
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Lisa
given-names: Mona
orcid: https://orcid.org/0000-0000-0000-0000
- family-names: Bot
given-names: Hew
orcid: https://orcid.org/0000-0000-0000-0000
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: https://github.com/github/linguist
```
For more information, see the [Citation File Format](https://citation-file-format.github.io/) website.
When you add a `CITATION.cff` file to the default branch of your repository, it is automatically linked from the repository landing page. This makes it easy for other users to cite your software project, using the information you've provided.
![Citation link on repository landing page](/assets/images/help/repository/citation-link.png)
## Citation formats
We currently support APA and BibTex file formats.
Are you looking for additional citation formats? GitHub uses a Ruby library, to parse the `CITATION.cff` files. You can request additional formats in the [ruby-cff](https://github.com/citation-file-format/ruby-cff) repository, or contribute them yourself.

View File

@@ -15,7 +15,7 @@ topics:
---
## About READMEs
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt or ghes > 3.1 or ghae-issue-4651 %}, citation file{% endif %}{% ifversion fpt %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
For more information about providing guidelines for your project, see {% ifversion fpt %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."

View File

@@ -18,6 +18,7 @@ children:
- /about-code-owners
- /about-repository-languages
- /licensing-a-repository
- /about-citation-files
- /creating-a-template-repository
- /creating-an-issues-only-repository
- /limits-for-viewing-content-and-diffs-in-a-repository

File diff suppressed because one or more lines are too long

View File

@@ -52549,6 +52549,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
@@ -52571,8 +52572,8 @@
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
}
],
"summary": "Upload a release asset",

View File

@@ -53385,6 +53385,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
@@ -53407,8 +53408,8 @@
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
}
],
"summary": "Upload a release asset",

View File

@@ -54045,6 +54045,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
@@ -54067,8 +54068,8 @@
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
}
],
"summary": "Upload a release asset",

View File

@@ -58110,6 +58110,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
@@ -58132,8 +58133,8 @@
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
}
],
"summary": "Upload a release asset",

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -127108,6 +127108,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -138565,6 +138574,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -172040,6 +172058,17 @@
"error"
]
},
"security_severity_level": {
"nullable": true,
"type": "string",
"description": "The security severity of the alert.",
"enum": [
"low",
"medium",
"high",
"critical"
]
},
"description": {
"type": "string",
"description": "A short description of the rule used to detect the alert."
@@ -172208,6 +172237,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -172628,6 +172658,17 @@
"error"
]
},
"security_severity_level": {
"nullable": true,
"type": "string",
"description": "The security severity of the alert.",
"enum": [
"low",
"medium",
"high",
"critical"
]
},
"description": {
"type": "string",
"description": "A short description of the rule used to detect the alert."
@@ -172796,6 +172837,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -291884,6 +291926,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -297993,6 +298036,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -301343,6 +301387,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -325120,6 +325165,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -212792,6 +212792,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -218546,6 +218547,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -221741,6 +221743,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -244392,6 +244395,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -216486,6 +216486,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -222240,6 +222241,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -225435,6 +225437,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -248086,6 +248089,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -219021,6 +219021,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -224916,6 +224917,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -228111,6 +228113,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -251302,6 +251305,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -231463,6 +231463,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -237420,6 +237421,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -240615,6 +240617,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -263841,6 +263844,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -109523,6 +109523,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -119176,6 +119185,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -150959,6 +150977,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -151481,6 +151500,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -263629,6 +263649,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -269585,6 +269606,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -272782,6 +272804,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -296011,6 +296034,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -115655,6 +115655,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -125432,6 +125441,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -157263,6 +157281,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -157851,6 +157870,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -270468,6 +270488,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -276424,6 +276445,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -279621,6 +279643,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -302850,6 +302873,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -142,7 +142,7 @@
],
"servers": [
{
"url": "{protocol}://{hostname}",
"url": "{protocol}://{hostname}/api/v3",
"variables": {
"hostname": {
"description": "Self-hosted Enterprise Server or Enterprise Cloud hostname",
@@ -115975,6 +115975,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -125752,6 +125761,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -159175,6 +159193,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -159763,6 +159782,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -273619,6 +273639,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -279728,6 +279749,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -283078,6 +283100,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -306765,6 +306788,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}

View File

@@ -86135,6 +86135,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -96055,6 +96064,15 @@
"type": "integer",
"default": 1
}
},
{
"name": "created",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
@@ -127840,6 +127858,17 @@
"error"
]
},
"security_severity_level": {
"nullable": true,
"type": "string",
"description": "The security severity of the alert.",
"enum": [
"low",
"medium",
"high",
"critical"
]
},
"description": {
"type": "string",
"description": "A short description of the rule used to detect the alert."
@@ -128008,6 +128037,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -128428,6 +128458,17 @@
"error"
]
},
"security_severity_level": {
"nullable": true,
"type": "string",
"description": "The security severity of the alert.",
"enum": [
"low",
"medium",
"high",
"critical"
]
},
"description": {
"type": "string",
"description": "A short description of the rule used to detect the alert."
@@ -128596,6 +128637,7 @@
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
@@ -242602,6 +242644,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -248711,6 +248754,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -252061,6 +252105,7 @@
},
"repo": {
"type": "object",
"nullable": true,
"properties": {
"archive_url": {
"type": "string"
@@ -275778,6 +275823,7 @@
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}