зеркало из https://github.com/github/docs.git
Merge branch 'main' into repo-sync
This commit is contained in:
Коммит
bf383bfb87
|
@ -28,3 +28,5 @@ versions:
|
|||
{% link_with_intro /packages %}
|
||||
|
||||
{% link_with_intro /enterprise-support %}
|
||||
|
||||
{% link_with_intro /release-notes %}
|
||||
|
|
|
@ -4,7 +4,7 @@ versions:
|
|||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
Version Effective Date: December 7, 2020
|
||||
Version Effective Date: December 14, 2020
|
||||
|
||||
When you create an Account, you're given access to lots of different features and products that are all a part of the Service. Because many of these features and products offer different functionality, they may require additional terms and conditions specific to that feature or product. Below, we've listed those features and products, along with the corresponding additional terms that apply to your use of them.
|
||||
|
||||
|
@ -46,13 +46,11 @@ GitHub Pages are subject to some specific bandwidth and usage limits, and may no
|
|||
### 5. Actions and Packages
|
||||
|
||||
#### a. Actions Usage
|
||||
GitHub Actions enables you to create custom software development lifecycle workflows directly in your GitHub repository. Each Account comes with included compute and storage quantities for use with Actions, depending on your Account plan, which can be found in the [Actions documentation](/actions). Your Actions compute usage is displayed within [your account settings](https://github.com/settings/billing), and you will be notified by email in advance of reaching the limit of your included quantities. If you want to use Actions beyond your included quantities, then you may [enable overages](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions).
|
||||
GitHub Actions is billed on a usage basis. The [Actions documentation](/actions) includes details, including compute and storage quantities (depending on your Account plan), and how to monitor your Actions minutes usage and set usage limits.
|
||||
|
||||
Compute usage for included and paid quantities is calculated in minutes based on the type of Actions you execute (e.g. Linux, Windows, macOS). The minutes used for each Action's job or task will be rounded up to the nearest minute. For included quantities and depending on the type of Action, a multiplier may be applied to the amount of time used to execute each job or task, prior to being rounded up to the nearest minute. Overage minutes are charged at the [stated per minute price](https://github.com/features/actions) based on the type of Actions you execute. Actions and Packages share storage, and your storage usage is displayed within your [account settings](https://github.com/settings/billing). For additional details about included quantity usage calculations, see the [Actions documentation](/actions).
|
||||
|
||||
Actions and any elements of the Action service may not be used in violation of the Agreement, the [Acceptable Use Policy](/github/site-policy/github-acceptable-use-policies), or the GitHub Actions [service limitations](/actions/reference/usage-limits-billing-and-administration/#usage-limits). Additionally, Actions should not be used for:
|
||||
Actions and any elements of the Actions service may not be used in violation of the Agreement, the [GitHub Acceptable Use Polices](/github/site-policy/github-acceptable-use-policies), or the GitHub Actions service limitations set forth in the [Actions documentation](/actions). Additionally, Actions should not be used for:
|
||||
- cryptomining;
|
||||
- using our servers to disrupt, or to gain or to attempt to gain unauthorized access to, any service, device, data, account or network (other than those authorized by the [GitHub Bug Bounty program](https://bounty.github.com))
|
||||
- using our servers to disrupt, or to gain or to attempt to gain unauthorized access to, any service, device, data, account, or network (other than those authorized by the [GitHub Bug Bounty program](https://bounty.github.com));
|
||||
- the provision of a stand-alone or integrated application or service offering Actions or any elements of Actions for commercial purposes;
|
||||
- any activity that places a burden on our servers, where that burden is disproportionate to the benefits provided to users (for example, don't use Actions as a content delivery network or as part of a serverless application, but a low benefit Action could be ok if it’s also low burden); or
|
||||
- any other activity unrelated to the production, testing, deployment, or publication of the software project associated with the repository where GitHub Actions are used.
|
||||
|
@ -60,16 +58,7 @@ Actions and any elements of the Action service may not be used in violation of t
|
|||
In order to prevent violations of these limitations and abuse of GitHub Actions, GitHub may monitor your use of GitHub Actions. Misuse of GitHub Actions may result in termination of jobs, or restrictions in your ability to use GitHub Actions.
|
||||
|
||||
#### b. Packages Usage
|
||||
GitHub Packages may be used to download, publish, and manage packages of Content. Each Account plan comes with included bandwidth and storage quantities for use with Packages, which can be found in the [Packages documentation](/github/managing-packages-with-github-package-registry/about-github-package-registry). Actions and Packages share storage between the two Service features. Storage and bandwidth usage are displayed within your [account settings](https://github.com/settings/billing), and you will be notified by email in advance of reaching the limit of your included quantities. If you want to use Packages beyond your included bandwidth and storage quantities, then you may [enable overages](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages).
|
||||
|
||||
Bandwidth usage is calculated based on the amount of data transferred out of your repositories through Packages, but package transfers through Actions will not count toward your included or paid quantities. Packages bandwidth usage is limited by the [Acceptable Use Policy](/github/site-policy/github-acceptable-use-policies#7-excessive-bandwidth-use), and included bandwidth quantities are determined by your [account plan](https://github.com/pricing).
|
||||
|
||||
Actions and Packages storage usage is shared between the two Service features. Storage usage is calculated as a weighted average over the course of the month and does not reset each month. Public and private repositories have different included storage quantities, and the included quantities for private repositories depend on your [account plan](https://github.com/pricing).
|
||||
|
||||
#### c. Payment and Billing for Actions and Packages
|
||||
Billing for Actions and Packages is usage-based. Additional quantities of Actions or Packages cannot be purchased separately. For monthly-billed customers, you must have a payment method on file to choose to pay for additional quantities of these Service features. You will be charged on a monthly, recurring basis based on your usage in the preceding month, unless you are billed by invoice. For invoiced customers, you must pay the fees within thirty (30) days of the GitHub invoice date. For customers paying for Service feature overages in advance, unused prepaid minutes will not roll over to the next billing period and will not be refunded.
|
||||
|
||||
You can set a monthly spending limit in your [account settings](https://github.com/settings/billing/cost_management). You will be notified by email in advance of reaching the limit of your included quantities and the designated spending limit of your paid additional quantities.
|
||||
GitHub Packages is billed on a usage basis. The [Packages documentation](/packages) includes details, including bandwidth and storage quantities (depending on your Account plan), and how to monitor your Packages usage and set usage limits. Packages bandwidth usage is limited by the [GitHub Acceptable Use Polices](/github/site-policy/github-acceptable-use-policies).
|
||||
|
||||
### 6. Learning Lab
|
||||
|
||||
|
|
|
@ -13418,6 +13418,11 @@ type MarketplaceListing implements Node {
|
|||
"""
|
||||
hasTermsOfService: Boolean!
|
||||
|
||||
"""
|
||||
Whether the creator of the app is a verified org
|
||||
"""
|
||||
hasVerifiedOwner: Boolean!
|
||||
|
||||
"""
|
||||
A technical description of how this app works with GitHub.
|
||||
"""
|
||||
|
|
|
@ -109,7 +109,7 @@ sections:
|
|||
- Starting with GitHub Enterprise Server 2.21.0 the legacy GitHub Apps endpoint for creating installation access tokens was deprecated and will be removed in GitHub Enterprise Server 2.25.0. More information is available in the [deprecation announcement blog post](https://developer.github.com/changes/2020-04-15-replacing-create-installation-access-token-endpoint/). {% comment %} https://github.com/github/enterprise-web/pull/6419#issuecomment-668303461 {% endcomment %}
|
||||
- heading: Deprecation of OAuth Application API
|
||||
notes:
|
||||
- GitHub [no longer supports the OAuth application endpoints](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/) and have replaced them with a version that moves the access token to the request body for improved security. Brownouts will start in March 2021 and all calls to the old version of the OAuth application endpoints will return a status code of 404 starting on May 5, 2021 at 16:00 UTC.
|
||||
- GitHub no longer supports the OAuth application endpoints that contain `access_token` as a path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. While deprecated, the endpoints are still accessible in this version. We intend to remove these endpoints on GitHub Enterprise Server 3.4. For more information, see the [deprecation announcement blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).
|
||||
|
||||
# - type: Backup and Disaster recovery
|
||||
# note: GitHub Enterprise Server 2.22 requires at least [GitHub Enterprise Backup Utilities](https://github.com/github/backup-utils) 2.22.0 for [Backups and Disaster Recovery](https://help.github.com/enterprise/2.22/admin/guides/installation/backups-and-disaster-recovery/).
|
||||
|
|
|
@ -1,14 +1,14 @@
|
|||
import { sendEvent } from './events'
|
||||
|
||||
export default function () {
|
||||
const printButton = document.querySelector('.js-print')
|
||||
const printButtons = document.querySelectorAll('.js-print')
|
||||
|
||||
if (printButton) {
|
||||
Array.from(printButtons).forEach(btn => {
|
||||
// Open the print dialog when the button is clicked
|
||||
printButton.addEventListener('click', () => {
|
||||
btn.addEventListener('click', () => {
|
||||
window.print()
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
// Track print events
|
||||
window.onbeforeprint = function () {
|
||||
|
|
|
@ -95,8 +95,11 @@
|
|||
</div>
|
||||
</article>
|
||||
|
||||
<aside class="markdown-body d-none d-md-block border-left no-print bg-white flex-shrink-0" style="width: 300px">
|
||||
<nav class="position-sticky top-0">
|
||||
<aside
|
||||
class="markdown-body position-sticky top-0 d-none d-md-block border-left no-print bg-white flex-shrink-0"
|
||||
style="width: 300px; height: 100vh;"
|
||||
>
|
||||
<nav class="height-full overflow-auto">
|
||||
<ul class="list-style-none pl-0 text-bold">
|
||||
{% for release in releases %}
|
||||
<li class="border-bottom">
|
||||
|
|
|
@ -92,7 +92,7 @@
|
|||
"deprecationDate": "2021-09-23"
|
||||
},
|
||||
"3.0": {
|
||||
"releaseDate": "2020-12-08",
|
||||
"releaseDate": "2020-12-16",
|
||||
"deprecationDate": "2021-12-08"
|
||||
}
|
||||
}
|
|
@ -1,4 +1,17 @@
|
|||
[
|
||||
{
|
||||
"schemaChanges": [
|
||||
{
|
||||
"title": "The GraphQL schema includes these changes:",
|
||||
"changes": [
|
||||
"Field `hasVerifiedOwner` was added to object type `MarketplaceListing`"
|
||||
]
|
||||
}
|
||||
],
|
||||
"previewChanges": [],
|
||||
"upcomingChanges": [],
|
||||
"date": "2020-12-09"
|
||||
},
|
||||
{
|
||||
"date": "2020-11-13",
|
||||
"schemaChanges": [
|
||||
|
|
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
@ -21683,6 +21683,14 @@
|
|||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#boolean"
|
||||
},
|
||||
{
|
||||
"name": "hasVerifiedOwner",
|
||||
"description": "<p>Whether the creator of the app is a verified org.</p>",
|
||||
"type": "Boolean!",
|
||||
"id": "boolean",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#boolean"
|
||||
},
|
||||
{
|
||||
"name": "howItWorks",
|
||||
"description": "<p>A technical description of how this app works with GitHub.</p>",
|
||||
|
|
|
@ -56,7 +56,7 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren
|
|||
|
||||
// ------ BEGIN MODERN VERSION FORMAT REPLACEMENTS ------//
|
||||
if (currentlySupportedVersions.includes(currentVersion) || versionSatisfiesRange(currentVersion, `>${lastReleaseWithLegacyFormat}`)) {
|
||||
oldPaths.forEach(oldPath => {
|
||||
(new Set(oldPaths)).forEach(oldPath => {
|
||||
// create old path /github from new path /free-pro-team@latest/github
|
||||
oldPaths.add(oldPath
|
||||
.replace(`/${nonEnterpriseDefaultVersion}`, ''))
|
||||
|
@ -107,19 +107,22 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren
|
|||
// ------ END MODERN VERSION FORMAT REPLACEMENTS ------//
|
||||
|
||||
// For each old path added to the set above, do the following...
|
||||
(new Set(oldPaths)).forEach(oldPath => {
|
||||
// for English only, remove language code
|
||||
if (languageCode === 'en') {
|
||||
oldPaths.add(getPathWithoutLanguage(oldPath))
|
||||
}
|
||||
|
||||
// add language code
|
||||
oldPaths.forEach(oldPath => oldPaths.add(getPathWithLanguage(oldPath, languageCode)))
|
||||
// add language code
|
||||
oldPaths.add(getPathWithLanguage(oldPath, languageCode))
|
||||
|
||||
// for English only, remove language code
|
||||
if (languageCode === 'en') {
|
||||
oldPaths.forEach(oldPath => oldPaths.add(getPathWithoutLanguage(oldPath)))
|
||||
}
|
||||
// create /enterprise from /enterprise/latest
|
||||
oldPaths.add(oldPath.replace(`/enterprise/${latest}`, '/enterprise'))
|
||||
})
|
||||
|
||||
// create /enterprise from /enterprise/latest
|
||||
oldPaths.forEach(oldPath => oldPaths.add(oldPath.replace(`/enterprise/${latest}`, '/enterprise')))
|
||||
// exclude any empty old paths that may have been derived
|
||||
oldPaths.delete('')
|
||||
oldPaths.delete('/')
|
||||
|
||||
return Array.from(oldPaths)
|
||||
// exclude any empty old paths that may have been derived
|
||||
.filter(oldPath => oldPath !== '' && oldPath !== '/')
|
||||
return oldPaths
|
||||
}
|
||||
|
|
|
@ -25,6 +25,7 @@
|
|||
"account":{
|
||||
"type":"Organization",
|
||||
"id":28536653,
|
||||
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
|
||||
"login":"organizationUsername",
|
||||
"organization_billing_email":"organizationusername@gmail.com"
|
||||
},
|
||||
|
|
|
@ -25,6 +25,7 @@
|
|||
"account":{
|
||||
"type":"Organization",
|
||||
"id":18404719,
|
||||
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
|
||||
"login":"username",
|
||||
"organization_billing_email":"username@email.com"
|
||||
},
|
||||
|
@ -52,6 +53,7 @@
|
|||
"account":{
|
||||
"type":"Organization",
|
||||
"id":18404719,
|
||||
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
|
||||
"login":"username",
|
||||
"organization_billing_email":"username@email.com"
|
||||
},
|
||||
|
|
|
@ -25,6 +25,7 @@
|
|||
"account":{
|
||||
"type":"Organization",
|
||||
"id":18404719,
|
||||
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
|
||||
"login":"username",
|
||||
"organization_billing_email":"username@email.com"
|
||||
},
|
||||
|
|
|
@ -1,79 +1,44 @@
|
|||
#!/usr/bin/env node
|
||||
|
||||
const github = require('../lib/github')
|
||||
const { getContents } = require('../lib/git-utils')
|
||||
const fs = require('fs')
|
||||
const path = require('path')
|
||||
const filename = path.join(__dirname, '../lib/enterprise-dates.json')
|
||||
const jsonFile = require(filename)
|
||||
const enterpriseDatesFile = path.join(__dirname, '../lib/enterprise-dates.json')
|
||||
const enterpriseDatesString = fs.readFileSync(enterpriseDatesFile, 'utf8')
|
||||
|
||||
// [start-readme]
|
||||
//
|
||||
// Run this script during Enterprise releases and deprecations.
|
||||
// It uses the GitHub API to get dates from enterprise-releases and updates `lib/enterprise-dates.json`.
|
||||
// The help site uses this JSON to display dates at the top of some Enterprise versions.
|
||||
//
|
||||
// This script requires that you have a GitHub Personal Access Token in a `.env` file.
|
||||
// If you don't have a token, get one [here](https://github.com/settings/tokens/new?scopes=repo&description=docs-dev).
|
||||
// If you don't have an `.env` file in your docs checkout, run this command in Terminal:
|
||||
//
|
||||
// `cp .env.example .env`
|
||||
//
|
||||
// Open the `.env` file in a text editor, and find the `GITHUB_TOKEN=` placeholder. Add your token after the equals sign.
|
||||
//
|
||||
// Do not commit the `.env` file; just leave it in your checkout.
|
||||
// This script fetches data from https://github.com/github/enterprise-releases/blob/master/releases.json
|
||||
// and updates `lib/enterprise-dates.json`, which the site uses for various functionality.
|
||||
//
|
||||
// [end-readme]
|
||||
|
||||
// check for required PAT
|
||||
if (!process.env.GITHUB_TOKEN) {
|
||||
console.error('Error! You must have a GITHUB_TOKEN set in an .env file to run this script.')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
main()
|
||||
|
||||
// GHE Release Lifecycle Dates
|
||||
async function main () {
|
||||
let raw
|
||||
try {
|
||||
raw = await getDataFromReleasesRepo()
|
||||
} catch (err) {
|
||||
console.log('error getting JSON from enterprise-releases repo')
|
||||
throw (err)
|
||||
}
|
||||
const json = prepareData(raw)
|
||||
if (json === prettify(jsonFile)) {
|
||||
// send owner, repo, ref, path
|
||||
const rawDates = JSON.parse(await getContents('github', 'enterprise-releases', 'master', 'releases.json'))
|
||||
|
||||
const formattedDates = {}
|
||||
Object.entries(rawDates).forEach(([releaseNumber, releaseObject]) => {
|
||||
formattedDates[releaseNumber] = {
|
||||
releaseDate: releaseObject.release_candidate || releaseObject.start,
|
||||
deprecationDate: releaseObject.end
|
||||
}
|
||||
})
|
||||
|
||||
const formattedDatesString = JSON.stringify(formattedDates, null, 2)
|
||||
|
||||
if (formattedDatesString === enterpriseDatesString) {
|
||||
console.log('This repo is already in sync with enterprise-releases!')
|
||||
} else {
|
||||
fs.writeFileSync(filename, json, 'utf8')
|
||||
console.log(`${filename} has been updated!`)
|
||||
fs.writeFileSync(enterpriseDatesFile, formattedDatesString)
|
||||
console.log(`${enterpriseDatesFile} has been updated!`)
|
||||
}
|
||||
}
|
||||
|
||||
// Uses https://octokit.github.io/rest.js/#api-Repos-getContents
|
||||
async function getDataFromReleasesRepo () {
|
||||
const octokit = github()
|
||||
const { data } = await octokit.repos.getContents({
|
||||
owner: 'github',
|
||||
repo: 'enterprise-releases',
|
||||
path: 'releases.json',
|
||||
ref: 'master',
|
||||
headers: { accept: 'application/vnd.github.v3.raw+json' }
|
||||
})
|
||||
return data
|
||||
}
|
||||
|
||||
// We only need some of the values from the source JSON
|
||||
// We use https://github.com/zeke/browser-date-formatter on the client side to reformat the dates
|
||||
function prepareData (raw) {
|
||||
const data = Object.entries(JSON.parse(raw))
|
||||
const obj = {}
|
||||
data.forEach(versions => {
|
||||
const datesObj = {}
|
||||
const version = versions[0]
|
||||
const releaseDate = versions[1].start
|
||||
const deprecationDate = versions[1].end
|
||||
datesObj.releaseDate = releaseDate
|
||||
datesObj.deprecationDate = deprecationDate
|
||||
obj[version] = datesObj
|
||||
})
|
||||
return prettify(obj)
|
||||
}
|
||||
|
||||
function prettify (json) {
|
||||
return JSON.stringify(json, null, 2)
|
||||
}
|
||||
|
|
|
@ -15,6 +15,7 @@ const ALLOW_LIST = new Set([
|
|||
'platform-samples',
|
||||
'github-services',
|
||||
'explore',
|
||||
'enterprise-releases',
|
||||
'markup',
|
||||
'hubot',
|
||||
'VisualStudio',
|
||||
|
|
Загрузка…
Ссылка в новой задаче