1
0
mirror of synced 2025-12-22 03:16:52 -05:00

Merge branch 'main' into patch-1

This commit is contained in:
Felicity Chapman
2020-10-21 23:10:03 +01:00
committed by GitHub
9005 changed files with 82960 additions and 119490 deletions

View File

@@ -1,388 +0,0 @@
{
"files": [
"README.md"
],
"imageSize": 64,
"commit": false,
"badgeTemplate": "",
"contributors": [
{
"login": "alebourne",
"name": "Alexandra Bourne",
"avatar_url": "https://avatars1.githubusercontent.com/u/24581915?v=4",
"profile": "https://github.com/alebourne",
"contributions": [
"content",
"bug"
]
},
{
"login": "crichID",
"name": "Cynthia Rich",
"avatar_url": "https://avatars0.githubusercontent.com/u/9950121?v=4",
"profile": "http://cynthiarich.me/",
"contributions": [
"content",
"bug"
]
},
{
"login": "emilyistoofunky",
"name": "Emily Gould",
"avatar_url": "https://avatars1.githubusercontent.com/u/4822039?v=4",
"profile": "https://github.com/emilyistoofunky",
"contributions": [
"content",
"bug"
]
},
{
"login": "felicitymay",
"name": "Felicity Chapman",
"avatar_url": "https://avatars1.githubusercontent.com/u/1877141?v=4",
"profile": "https://github.com/felicitymay",
"contributions": [
"content",
"bug"
]
},
{
"login": "heiskr",
"name": "Kevin Heis",
"avatar_url": "https://avatars2.githubusercontent.com/u/1221423?v=4",
"profile": "https://heiskr.com/",
"contributions": [
"bug",
"code"
]
},
{
"login": "hubwriter",
"name": "Alistair Christie",
"avatar_url": "https://avatars1.githubusercontent.com/u/54933897?v=4",
"profile": "https://github.com/hubwriter",
"contributions": [
"content",
"bug"
]
},
{
"login": "JamesMGreene",
"name": "James M. Greene",
"avatar_url": "https://avatars2.githubusercontent.com/u/417751?v=4",
"profile": "https://jamesmgreene.github.io/",
"contributions": [
"bug",
"code"
]
},
{
"login": "janiceilene",
"name": "Janice",
"avatar_url": "https://avatars3.githubusercontent.com/u/9817819?v=4",
"profile": "https://github.com/janiceilene",
"contributions": [
"content",
"bug"
]
},
{
"login": "jasonetco",
"name": "Jason Etcovitch",
"avatar_url": "https://avatars1.githubusercontent.com/u/10660468?v=4",
"profile": "https://jasonet.co",
"contributions": [
"bug",
"code"
]
},
{
"login": "jf205",
"name": "James Fletcher",
"avatar_url": "https://avatars2.githubusercontent.com/u/42464962?v=4",
"profile": "https://github.com/jf205",
"contributions": [
"content",
"bug"
]
},
{
"login": "jleaver",
"name": "Jenn Leaver",
"avatar_url": "https://avatars2.githubusercontent.com/u/4453117?v=4",
"profile": "https://github.com/jleaver",
"contributions": [
"content",
"bug"
]
},
{
"login": "jmarlena",
"name": "jmarlena",
"avatar_url": "https://avatars3.githubusercontent.com/u/6732600?v=4",
"profile": "https://github.com/jmarlena",
"contributions": [
"content",
"bug"
]
},
{
"login": "jwargo",
"name": "John M. Wargo",
"avatar_url": "https://avatars0.githubusercontent.com/u/30843404?v=4",
"profile": "https://johnwargo.com/",
"contributions": [
"content",
"bug"
]
},
{
"login": "lecoursen",
"name": "Laura Coursen",
"avatar_url": "https://avatars3.githubusercontent.com/u/14935376?v=4",
"profile": "https://github.com/lecoursen",
"contributions": [
"content",
"bug"
]
},
{
"login": "lucascosti",
"name": "Lucas Costi",
"avatar_url": "https://avatars3.githubusercontent.com/u/4434330?v=4",
"profile": "https://lucascosti.com/",
"contributions": [
"content",
"bug"
]
},
{
"login": "martin389",
"name": "Martin Lopes",
"avatar_url": "https://avatars3.githubusercontent.com/u/54248166?v=4",
"profile": "https://github.com/martin389",
"contributions": [
"content",
"bug"
]
},
{
"login": "mattpollard",
"name": "Matt Pollard",
"avatar_url": "https://avatars0.githubusercontent.com/u/1894408?v=4",
"profile": "https://github.com/mattpollard",
"contributions": [
"content",
"bug"
]
},
{
"login": "mchammer01",
"name": "mc",
"avatar_url": "https://avatars3.githubusercontent.com/u/42146119?v=4",
"profile": "https://github.com/mchammer01",
"contributions": [
"content",
"bug"
]
},
{
"login": "megbird",
"name": "Meg Bird",
"avatar_url": "https://avatars2.githubusercontent.com/u/5658046?v=4",
"profile": "http://meaganbird.com/",
"contributions": [
"content",
"bug"
]
},
{
"login": "myarb",
"name": "Melanie Yarbrough",
"avatar_url": "https://avatars2.githubusercontent.com/u/11952755?v=4",
"profile": "https://github.com/myarb",
"contributions": [
"content",
"bug"
]
},
{
"login": "rachmari",
"name": "Rachael Sewell",
"avatar_url": "https://avatars2.githubusercontent.com/u/9831992?v=4",
"profile": "https://github.com/rachmari",
"contributions": [
"content",
"bug"
]
},
{
"login": "runleonarun",
"name": "Leona B. Campbell",
"avatar_url": "https://avatars1.githubusercontent.com/u/3880403?v=4",
"profile": "https://github.com/runleonarun",
"contributions": [
"content",
"bug"
]
},
{
"login": "sarahs",
"name": "Sarah Schneider",
"avatar_url": "https://avatars3.githubusercontent.com/u/821071?v=4",
"profile": "https://github.com/sarahs",
"contributions": [
"bug",
"code"
]
},
{
"login": "shati-patel",
"name": "Shati Patel",
"avatar_url": "https://avatars3.githubusercontent.com/u/42641846?v=4",
"profile": "https://github.com/shati-patel",
"contributions": [
"content",
"bug"
]
},
{
"login": "simpsoka",
"name": "Kathy Korevec",
"avatar_url": "https://avatars3.githubusercontent.com/u/704152?v=4",
"profile": "http://kathy.pm/",
"contributions": [
"content",
"bug"
]
},
{
"login": "timeyoutakeit",
"name": "Amy Burns",
"avatar_url": "https://avatars3.githubusercontent.com/u/5012825?v=4",
"profile": "https://github.com/timeyoutakeit",
"contributions": [
"content",
"bug"
]
},
{
"login": "vanessayuenn",
"name": "Vanessa Yuen",
"avatar_url": "https://avatars3.githubusercontent.com/u/6842965?v=4",
"profile": "https://github.com/vanessayuenn",
"contributions": [
"bug",
"code"
]
},
{
"login": "zeke",
"name": "Zeke Sikelianos",
"avatar_url": "https://avatars1.githubusercontent.com/u/2289?v=4",
"profile": "http://zeke.sikelianos.com/",
"contributions": [
"bug",
"code"
]
},
{
"login": "BenJam",
"name": "Benjamin Nickolls",
"avatar_url": "https://avatars2.githubusercontent.com/u/158833?v=4",
"profile": "https://github.com/BenJam",
"contributions": [
"doc"
]
},
{
"login": "jeffmcaffer",
"name": "Jeff McAffer",
"avatar_url": "https://avatars2.githubusercontent.com/u/10070956?v=4",
"profile": "https://mcaffer.com",
"contributions": [
"doc"
]
},
{
"login": "tjenkinson",
"name": "Tom Jenkinson",
"avatar_url": "https://avatars0.githubusercontent.com/u/3259993?v=4",
"profile": "https://tjenkinson.me",
"contributions": [
"code"
]
},
{
"login": "casals",
"name": "Arthur Casals",
"avatar_url": "https://avatars0.githubusercontent.com/u/785860?v=4",
"profile": "https://github.com/casals",
"contributions": [
"content",
"doc"
]
},
{
"login": "Simran-B",
"name": "Simran",
"avatar_url": "https://avatars3.githubusercontent.com/u/7819991?v=4",
"profile": "https://www.arangodb.com/",
"contributions": [
"doc"
]
},
{
"login": "Ruth",
"name": "Ruth",
"avatar_url": "https://avatars0.githubusercontent.com/u/85029?v=4",
"profile": "https://github.com/ruth",
"contributions": [
"content"
]
},
{
"login": "wi5nia",
"name": "Tomasz Wisniewski",
"avatar_url": "https://avatars2.githubusercontent.com/u/12593852?v=4",
"profile": "http://tomaszwisniewski.com",
"contributions": [
"doc"
]
},
{
"login": "chiedo",
"name": "Chiedo John",
"avatar_url": "https://avatars2.githubusercontent.com/u/2156688?v=4",
"profile": "https://chiedojohn.com/",
"contributions": [
"code"
]
},
{
"login": "paulyhedral",
"name": "Paul Schifferer",
"avatar_url": "https://avatars1.githubusercontent.com/u/419457?v=4",
"profile": "https://wanderingmonster.org",
"contributions": [
"content"
]
},
{
"login": "Protectator",
"name": "Kewin Dousse",
"avatar_url": "https://avatars3.githubusercontent.com/u/1529017?v=4",
"profile": "https://www.kewindousse.ch",
"contributions": [
"content"
]
},
{
"contributorsPerLine": 7,
"projectName": "docs",
"projectOwner": "github",
"repoType": "github",
"repoHost": "https://github.com",
"skipCi": true,
"commitConvention": "none"
}

View File

@@ -4,34 +4,34 @@
// can be added it this list. // can be added it this list.
module.exports = [ module.exports = [
'actions/cache@v1', 'actions/cache@70655ec8323daeeaa7ef06d7c56e1b9191396cbe',
'actions/cache@v2', 'actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16',
'actions/checkout@v2', 'actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675',
'actions/github-script@0.9.0', 'actions/github-script@5d03ada4b0a753e9460b312e61cc4f8fdeacf163',
'actions/github-script@v2.0.0', 'actions/github-script@6e5ee1dc1cb3740e5e5e76ad668e3f526edbfe45',
'actions/github-script@v2', 'actions/github-script@44b873bc975058192f5279ebe7579496381f575d',
'actions/github-script@v3', 'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9',
'actions/labeler@v2', 'actions/labeler@5f867a63be70efff62b767459b009290364495eb',
'actions/setup-node@v1', 'actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d',
'actions/setup-ruby@v1', 'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526',
'actions/stale@v3', 'actions/stale@44f9eae0adddf72dbf3eedfacc999f70afcec1a8',
'crowdin/github-action@1.0.10', 'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688',
'dawidd6/action-delete-branch@v3', 'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911',
'docker://chinthakagodawita/autoupdate-action:v1', 'docker://chinthakagodawita/autoupdate-action:v1',
'fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289',
'github/codeql-action/analyze@v1', 'github/codeql-action/analyze@v1',
'github/codeql-action/init@v1', 'github/codeql-action/init@v1',
'ianwalter/puppeteer@3.0.0', 'ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb',
'juliangruber/approve-pull-request-action@v1', 'juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8',
'juliangruber/find-pull-request-action@v1', 'juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b',
'juliangruber/read-file-action@v1', 'juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512',
'pascalgn/automerge-action@c9bd182', 'pascalgn/automerge-action@c9bd182',
'peter-evans/create-issue-from-file@v2', 'peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5',
'peter-evans/create-pull-request@v2', 'peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8',
'rachmari/actions-add-new-issue-to-column@v1.1.1', 'rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9',
'rachmari/labeler@v1.0.4', 'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',
'repo-sync/github-sync@v2', 'repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88',
'repo-sync/pull-request@v2', 'repo-sync/pull-request@ea6773388b83b337e4da9a223293309f2c3670e7',
'rtCamp/action-slack-notify@master', 'rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815',
'rtCamp/action-slack-notify@v2.1.0',
'tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0' 'tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0'
] ]

View File

@@ -7,7 +7,7 @@ jobs:
stale: stale:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/stale@v3 - uses: actions/stale@44f9eae0adddf72dbf3eedfacc999f70afcec1a8
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.' stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'

View File

@@ -7,6 +7,6 @@ jobs:
if: github.repository == 'github/docs-internal' if: github.repository == 'github/docs-internal'
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/labeler@v2 - uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb
with: with:
repo-token: "${{ secrets.GITHUB_TOKEN }}" repo-token: "${{ secrets.GITHUB_TOKEN }}"

View File

@@ -13,4 +13,4 @@ jobs:
GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
PR_FILTER: labelled PR_FILTER: labelled
PR_LABELS: autoupdate PR_LABELS: autoupdate
MERGE_MSG: "Branch was updated using the 'autoupdate branch' Actions workflow." MERGE_MSG: "Branch was updated using the 'autoupdate branch' Actions workflow."

View File

@@ -1,18 +1,41 @@
name: Browser Tests name: Browser Tests
on: [push] on:
workflow_dispatch:
push:
jobs: jobs:
see_if_should_skip:
continue-on-error: true
runs-on: ubuntu-latest
# Map a step output to a job output
outputs:
should_skip: ${{ steps.skip_check.outputs.should_skip }}
steps:
- id: skip_check
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
with:
cancel_others: 'false'
github_token: ${{ github.token }}
paths: '[".github/workflows/browser-test.yml","assets/**", "content/**", "data/**", "includes/**", "javascripts/**", "jest-puppeteer.config.js", "jest.config.js", "layouts/**", "lib/**", "middleware/**", "package-lock.json", "package.json", "server.js", "translations/**", "webpack.config.js"]'
build: build:
needs: see_if_should_skip
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout # Each of these ifs needs to be repeated at each step to make sure the required check still runs
uses: actions/checkout@v2 # Even if if doesn't do anything
- name: Install - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
uses: ianwalter/puppeteer@3.0.0 name: Checkout
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Install
uses: ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb
with: with:
args: npm ci args: npm ci
- name: Test
uses: ianwalter/puppeteer@3.0.0 - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Test
uses: ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb
with: with:
args: npm run browser-test args: npm run browser-test

View File

@@ -10,7 +10,7 @@ jobs:
if: github.repository == 'github/docs-internal' if: github.repository == 'github/docs-internal'
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: npm ci - name: npm ci
run: npm ci run: npm ci
- name: npm run build - name: npm run build
@@ -28,7 +28,7 @@ jobs:
fi fi
- if: ${{ steps.check.outputs.continue == 'yes' }} - if: ${{ steps.check.outputs.continue == 'yes' }}
name: Create issue from file name: Create issue from file
uses: peter-evans/create-issue-from-file@v2 uses: peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5
with: with:
token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
title: ${{ steps.check.outputs.title }} title: ${{ steps.check.outputs.title }}

View File

@@ -15,7 +15,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- uses: github/codeql-action/init@v1 - uses: github/codeql-action/init@v1
with: with:
languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!) languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!)

View File

@@ -1,12 +1,9 @@
# Please ping @github/docs-localization in the PR whenever you update this file!
name: Crowdin Sync name: Crowdin Sync
on: on:
workflow_dispatch: workflow_dispatch:
push: schedule:
branches: - cron: "33 2 * * *" # every day at 2:33 UTC at least until automerge is working
- main
jobs: jobs:
sync_with_crowdin: sync_with_crowdin:
@@ -15,10 +12,10 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Sync - name: Sync
uses: crowdin/github-action@1.0.10 uses: crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688
with: with:
upload_translations: false upload_translations: false
download_translations: true download_translations: true
@@ -26,19 +23,21 @@ jobs:
# Using a custom config temporarily to avoid clobbering the existing crowdin.yml # Using a custom config temporarily to avoid clobbering the existing crowdin.yml
# that is used by the github-help-docs OAuth integration. # that is used by the github-help-docs OAuth integration.
config: 'crowdin-actions-config.yml' config: 'crowdin.yml'
# This is the name of the git branch that Crowdin will create when opening a pull request. # This is the name of the git branch that Crowdin will create when opening a pull request.
# This branch does NOT need to be manually created. It will be created automatically by the action. # This branch does NOT need to be manually created. It will be created automatically by the action.
localization_branch_name: automated-crowdin-translations localization_branch_name: translations
# This is the name of the top-level directory that Crowdin will use for files. # This is the name of the top-level directory that Crowdin will use for files.
# Note that this is not a "branch" in the git sense, but more like a top-level directory in your Crowdin project. # Note that this is not a "branch" in the git sense, but more like a top-level directory in your Crowdin project.
# This branch does NOT need to be manually created. It will be created automatically by the action. # This branch does NOT need to be manually created. It will be created automatically by the action.
crowdin_branch_name: crowdin-main crowdin_branch_name: main
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Using an @octoglot token instead of the default Actions-provided GITHUB_TOKEN here
# so that subsequent workflows will be able to run on the pull request created by this workflow.
GITHUB_TOKEN: ${{ secrets.OCTOGLOT_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
# This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string # This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string
# See "API v2" on https://crowdin.com/project/<your-project>/settings#api # See "API v2" on https://crowdin.com/project/<your-project>/settings#api

View File

@@ -0,0 +1,85 @@
name: First responder docs-content
on:
pull_request:
types: [reopened, opened, ready_for_review, closed, unlabeled]
jobs:
first-responder-triage-pr:
name: Triage PR to FR project board
if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.event.action != 'unlabeled' && github.event.action != 'closed'
runs-on: ubuntu-latest
steps:
- name: Check if the event originated from a team member
uses: actions/github-script@44b873bc975058192f5279ebe7579496381f575d
id: set-result
with:
github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
result-encoding: string
script: |
const repoName = context.payload.repository.name
const ownerName = context.payload.repository.owner.login
const issueNumber = (context.eventName === "issues") ? context.payload.issue.number : context.payload.number
const updatedIssueInformation = await github.issues.get({
owner: ownerName,
repo: repoName,
issue_number: issueNumber
})
const teamMembers = await github.request(
`/orgs/github/teams/docs/members`
)
const logins = teamMembers.data.map(member => member.login)
// ignore PRs opened by docs bot accounts
logins.push('Octomerger', 'octoglot')
if (logins.some(login => login === updatedIssueInformation.data.user.login)) {
console.log(`This issue or pull request was authored by a member of the github/docs team.`)
return 'true'
}
console.log(`This issue or pull request was authored by an external contributor.`)
return 'false'
- name: Label external contributor pull requests with docs-content-fr
uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e
if: steps.set-result.outputs.result == 'false'
with:
repo-token: "${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}"
add-labels: "docs-content-fr"
- name: Triage to FR PR project column
uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9
if: steps.set-result.outputs.result == 'false'
with:
action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
project-url: "https://github.com/orgs/github/projects/1367"
column-name: "Docs-internal external contributor PRs"
first-responder-remove-pr:
name: Remove PR from FR project board
if: github.repository == 'github/docs-internal' && (github.event.label.name == 'docs-content-fr' && github.event.action == 'unlabeled') || github.event.action == 'closed'
runs-on: ubuntu-latest
steps:
- name: Remove card from project
uses: actions/github-script@44b873bc975058192f5279ebe7579496381f575d
with:
github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
result-encoding: string
script: |
const issueToRemove = context.payload.number
const cards = await github.projects.listCards({
column_id: 11130889
})
cards.data.forEach(card => {
if (card.content_url) {
const cardIssueNumber = parseInt(card.content_url.split('/').pop(), 10)
if (cardIssueNumber === issueToRemove) {
const cards = github.projects.deleteCard({
card_id: card.id
})
}
}
})
- name: Remove docs-content-fr label if not already removed
if: github.event.action == 'closed'
uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e
with:
repo-token: "${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}"
remove-labels: "docs-content-fr"

View File

@@ -7,13 +7,11 @@ jobs:
if: github.event.repository.private == false && github.event.pull_request.merged && github.event.pull_request.base.ref == github.event.repository.default_branch if: github.event.repository.private == false && github.event.pull_request.merged && github.event.pull_request.base.ref == github.event.repository.default_branch
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/github-script@v3 - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
with: with:
script: | script: |
github.issues.createComment({ github.issues.createComment({
...context.repo, ...context.repo,
issue_number: context.payload.pull_request.number, issue_number: context.payload.pull_request.number,
body: `Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. body: 'Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.'
If you haven't already, you can add yourself to [the list of contributors](https://github.com/github/docs#contributors-) by creating a new comment in this PR using [these instructions](https://allcontributors.org/docs/en/bot/usage#commands). Thanks again! :sparkles:`
}) })

View File

@@ -1,11 +1,14 @@
name: "Pa11y" name: "Pa11y"
on: [push] on:
workflow_dispatch:
schedule:
- cron: "25 17 * * *" # once a day at 17:25 UTC / 11:50 PST
jobs: jobs:
test: test:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Check out repo - name: Check out repo
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Get npm cache directory - name: Get npm cache directory
id: npm-cache id: npm-cache
@@ -13,7 +16,7 @@ jobs:
echo "::set-output name=dir::$(npm config get cache)" echo "::set-output name=dir::$(npm config get cache)"
- name: Cache node modules - name: Cache node modules
uses: actions/cache@v2 uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
with: with:
path: ${{ steps.npm-cache.outputs.dir }} path: ${{ steps.npm-cache.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

View File

@@ -12,10 +12,10 @@ jobs:
env: env:
HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }} HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }}
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: npm ci - name: npm ci
run: npm ci run: npm ci
- name: npm run build - name: npm run build
run: npm run build run: npm run build
- name: Run script - name: Run script
run: script/ping-staging-apps.js run: script/ping-staging-apps.js

View File

@@ -5,8 +5,7 @@ env:
on: on:
schedule: schedule:
# - cron: "20 15 * * 0" # run every Sunday at 20:15 UTC / 12:15 PST - cron: "20 15 * * 0" # run every Sunday at 20:15 UTC / 12:15 PST
- cron: 0 0 1 1 * # run next January 1st, aka temporarily disabled
jobs: jobs:
remove_unused_assets: remove_unused_assets:
@@ -19,7 +18,7 @@ jobs:
echo 'The repo is currently frozen! Exiting this workflow.' echo 'The repo is currently frozen! Exiting this workflow.'
exit 1 # prevents further steps from running exit 1 # prevents further steps from running
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: npm ci - name: npm ci
run: npm ci run: npm ci
- name: Run scripts - name: Run scripts
@@ -28,13 +27,13 @@ jobs:
script/remove-extraneous-translation-files.js script/remove-extraneous-translation-files.js
- name: Get script results to use in PR body - name: Get script results to use in PR body
id: results id: results
uses: juliangruber/read-file-action@v1 uses: juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512
with: with:
path: ./results.md path: ./results.md
- name: Remove script results file - name: Remove script results file
run: rm -rf ./results.md run: rm -rf ./results.md
- name: Create pull request - name: Create pull request
uses: peter-evans/create-pull-request@v2 uses: peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8
with: with:
# need to use a token with repo and workflow scopes for this step # need to use a token with repo and workflow scopes for this step
token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
@@ -49,7 +48,7 @@ jobs:
branch: remove-unused-assets branch: remove-unused-assets
- if: ${{ failure() }} - if: ${{ failure() }}
name: Delete remote branch (if previous steps failed) name: Delete remote branch (if previous steps failed)
uses: dawidd6/action-delete-branch@v3 uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} github_token: ${{ secrets.GITHUB_TOKEN }}
branches: remove-unused-assets branches: remove-unused-assets

View File

@@ -17,7 +17,6 @@ jobs:
repo-sync: repo-sync:
name: Repo Sync name: Repo Sync
runs-on: ubuntu-latest runs-on: ubuntu-latest
continue-on-error: true
steps: steps:
- name: Exit if repo is frozen - name: Exit if repo is frozen
@@ -27,10 +26,10 @@ jobs:
exit 1 # prevents further steps from running exit 1 # prevents further steps from running
- name: Check out repo - name: Check out repo
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Sync repo to branch - name: Sync repo to branch
uses: repo-sync/github-sync@v2 uses: repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88
env: env:
GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
with: with:
@@ -40,7 +39,7 @@ jobs:
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
- name: Create pull request - name: Create pull request
uses: repo-sync/pull-request@v2 uses: repo-sync/pull-request@ea6773388b83b337e4da9a223293309f2c3670e7
env: env:
GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
with: with:
@@ -52,7 +51,7 @@ jobs:
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
- name: Find pull request - name: Find pull request
uses: juliangruber/find-pull-request-action@v1 uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b
id: find-pull-request id: find-pull-request
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -60,13 +59,13 @@ jobs:
- name: Approve pull request - name: Approve pull request
if: ${{ steps.find-pull-request.outputs.number }} if: ${{ steps.find-pull-request.outputs.number }}
uses: juliangruber/approve-pull-request-action@v1 uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
number: ${{ steps.find-pull-request.outputs.number }} number: ${{ steps.find-pull-request.outputs.number }}
- name: Send Slack notification if workflow fails - name: Send Slack notification if workflow fails
uses: rtCamp/action-slack-notify@master uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
if: failure() if: failure()
env: env:
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}

View File

@@ -12,7 +12,7 @@ jobs:
steps: steps:
- name: Add issues with engineering label to project board - name: Add issues with engineering label to project board
if: contains(github.event.issue.labels.*.name, 'engineering') || contains(github.event.issue.labels.*.name, 'design') || contains(github.event.issue.labels.*.name, 'Design') if: contains(github.event.issue.labels.*.name, 'engineering') || contains(github.event.issue.labels.*.name, 'design') || contains(github.event.issue.labels.*.name, 'Design')
uses: actions/github-script@v2 uses: actions/github-script@44b873bc975058192f5279ebe7579496381f575d
with: with:
github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
script: | script: |

View File

@@ -13,7 +13,7 @@ jobs:
REGULAR_COLUMN_ID: 10095779 REGULAR_COLUMN_ID: 10095779
steps: steps:
- name: - name:
uses: actions/github-script@v2 uses: actions/github-script@44b873bc975058192f5279ebe7579496381f575d
continue-on-error: true continue-on-error: true
with: with:
github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}

View File

@@ -12,12 +12,12 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- uses: actions/setup-node@v1 - uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with: with:
node-version: 14.x node-version: 14.x
- name: cache node modules - name: cache node modules
uses: actions/cache@v1 uses: actions/cache@70655ec8323daeeaa7ef06d7c56e1b9191396cbe
with: with:
path: ~/.npm path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -32,7 +32,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: npm run sync-search run: npm run sync-search
- name: Send slack notification if workflow run fails - name: Send slack notification if workflow run fails
uses: rtCamp/action-slack-notify@v2.1.0 uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
if: failure() if: failure()
env: env:
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}

View File

@@ -12,12 +12,12 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Check out repo - name: Check out repo
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
with: with:
ref: translations # check out the 'translations' branch ref: translations # check out the 'translations' branch
- name: Setup node - name: Setup node
uses: actions/setup-node@v1 uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with: with:
node-version: 14.x node-version: 14.x
@@ -27,7 +27,7 @@ jobs:
echo "::set-output name=dir::$(npm config get cache)" echo "::set-output name=dir::$(npm config get cache)"
- name: Cache node modules - name: Cache node modules
uses: actions/cache@v2 uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
with: with:
path: ${{ steps.npm-cache.outputs.dir }} path: ${{ steps.npm-cache.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -52,10 +52,10 @@ jobs:
test-group: [content, meta, rendering, routing, unit, links-and-images] test-group: [content, meta, rendering, routing, unit, links-and-images]
steps: steps:
- name: Check out repo - name: Check out repo
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Setup node - name: Setup node
uses: actions/setup-node@v1 uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with: with:
node-version: 14.x node-version: 14.x
@@ -65,7 +65,7 @@ jobs:
echo "::set-output name=dir::$(npm config get cache)" echo "::set-output name=dir::$(npm config get cache)"
- name: Cache node modules - name: Cache node modules
uses: actions/cache@v2 uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
with: with:
path: ${{ steps.npm-cache.outputs.dir }} path: ${{ steps.npm-cache.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

View File

@@ -11,39 +11,6 @@ env:
CI: true CI: true
jobs: jobs:
lint:
runs-on: windows-latest
steps:
- name: Check out repo
uses: actions/checkout@v2
- name: Setup node
uses: actions/setup-node@v1
with:
node-version: 14.x
- name: Get npm cache directory
id: npm-cache
run: |
echo "::set-output name=dir::$(npm config get cache)"
- name: Cache node modules
uses: actions/cache@v2
with:
path: ${{ steps.npm-cache.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- name: Install dependencies
run: npm ci
- name: Run linter
run: npx standard
- name: Check dependencies
run: npm run check-deps
test: test:
runs-on: windows-latest runs-on: windows-latest
strategy: strategy:
@@ -52,10 +19,10 @@ jobs:
test-group: [content, meta, rendering, routing, unit, links-and-images] test-group: [content, meta, rendering, routing, unit, links-and-images]
steps: steps:
- name: Check out repo - name: Check out repo
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Setup node - name: Setup node
uses: actions/setup-node@v1 uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with: with:
node-version: 14.x node-version: 14.x
@@ -65,7 +32,7 @@ jobs:
echo "::set-output name=dir::$(npm config get cache)" echo "::set-output name=dir::$(npm config get cache)"
- name: Cache node modules - name: Cache node modules
uses: actions/cache@v2 uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
with: with:
path: ${{ steps.npm-cache.outputs.dir }} path: ${{ steps.npm-cache.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

View File

@@ -3,6 +3,7 @@
name: Node.js Tests name: Node.js Tests
on: on:
workflow_dispatch:
push: push:
branches: branches:
- main - main
@@ -14,79 +15,111 @@ env:
CI: true CI: true
jobs: jobs:
see_if_should_skip:
continue-on-error: true
runs-on: ubuntu-latest
# Map a step output to a job output
outputs:
should_skip: ${{ steps.skip_check.outputs.should_skip }}
steps:
- id: skip_check
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
with:
cancel_others: 'false'
github_token: ${{ github.token }}
paths: '[".github/workflows/test.yml",".node-version", ".npmrc", "app.json", "content/**", "data/**","lib/**", "Dockerfile", "feature-flags.json", "Gemfile", "Gemfile.lock", "middleware/**", "node_modules/**","package.json", "package-lock.json", "server.js", "tests/**", "translations/**", "Procfile", "webpack.config.js"]'
lint: lint:
needs: see_if_should_skip
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Check out repo # Each of these ifs needs to be repeated at each step to make sure the required check still runs
uses: actions/checkout@v2 # Even if if doesn't do anything
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Setup node - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
uses: actions/setup-node@v1 name: Setup node
uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with: with:
node-version: 14.x node-version: 14.x
- name: Get npm cache directory - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Get npm cache directory
id: npm-cache id: npm-cache
run: | run: |
echo "::set-output name=dir::$(npm config get cache)" echo "::set-output name=dir::$(npm config get cache)"
- name: Cache node modules - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
uses: actions/cache@v2 name: Cache node modules
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
with: with:
path: ${{ steps.npm-cache.outputs.dir }} path: ${{ steps.npm-cache.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: | restore-keys: |
${{ runner.os }}-node- ${{ runner.os }}-node-
- name: Install dependencies - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Install dependencies
run: npm ci run: npm ci
- name: Run linter - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Run linter
run: npx standard run: npx standard
- name: Check dependencies - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Check dependencies
run: npm run check-deps run: npm run check-deps
test: test:
needs: see_if_should_skip
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
test-group: [content, meta, rendering, routing, unit, links-and-images] test-group: [content, meta, rendering, routing, unit, links-and-images]
steps: steps:
- name: Check out repo # Each of these ifs needs to be repeated at each step to make sure the required check still runs
uses: actions/checkout@v2 # Even if if doesn't do anything
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Setup node - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
uses: actions/setup-node@v1 name: Setup node
uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with: with:
node-version: 14.x node-version: 14.x
- name: Get npm cache directory - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Get npm cache directory
id: npm-cache id: npm-cache
run: | run: |
echo "::set-output name=dir::$(npm config get cache)" echo "::set-output name=dir::$(npm config get cache)"
- name: Cache node modules - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
uses: actions/cache@v2 name: Cache node modules
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
with: with:
path: ${{ steps.npm-cache.outputs.dir }} path: ${{ steps.npm-cache.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: | restore-keys: |
${{ runner.os }}-node- ${{ runner.os }}-node-
- name: Install dependencies - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Install dependencies
run: npm ci run: npm ci
- name: Run build script - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Run build script
run: npm run build run: npm run build
- name: Run tests - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Run tests
run: npx jest tests/${{ matrix.test-group }}/ run: npx jest tests/${{ matrix.test-group }}/
- name: Send Slack notification if workflow fails - name: Send Slack notification if workflow fails
uses: rtCamp/action-slack-notify@master uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
if: failure() && github.ref == 'early-access' if: failure() && github.ref == 'early-access'
env: env:
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }} SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
SLACK_MESSAGE: "Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access" SLACK_MESSAGE: "Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access"

View File

@@ -17,14 +17,14 @@ jobs:
echo 'The repo is currently frozen! Exiting this workflow.' echo 'The repo is currently frozen! Exiting this workflow.'
exit 1 # prevents further steps from running exit 1 # prevents further steps from running
- name: Find original Pull Request - name: Find original Pull Request
uses: juliangruber/find-pull-request-action@v1 uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b
id: pr id: pr
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
branch: translations branch: translations
- if: ${{ steps.pr.outputs.number }} - if: ${{ steps.pr.outputs.number }}
name: Check if already labeled name: Check if already labeled
uses: actions/github-script@0.9.0 uses: actions/github-script@5d03ada4b0a753e9460b312e61cc4f8fdeacf163
id: has-label id: has-label
with: with:
script: | script: |
@@ -38,13 +38,13 @@ jobs:
} }
- if: ${{ !steps.has-label.outputs.result }} - if: ${{ !steps.has-label.outputs.result }}
name: Approve Pull Request name: Approve Pull Request
uses: juliangruber/approve-pull-request-action@v1 uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
number: ${{ steps.pr.outputs.number }} number: ${{ steps.pr.outputs.number }}
- if: ${{ !steps.has-label.outputs.result }} - if: ${{ !steps.has-label.outputs.result }}
name: Add automerge label name: Add automerge label
uses: actions/github-script@0.9.0 uses: actions/github-script@5d03ada4b0a753e9460b312e61cc4f8fdeacf163
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
script: | script: |

View File

@@ -10,7 +10,7 @@ jobs:
steps: steps:
- name: Check if the event originated from a team member - name: Check if the event originated from a team member
uses: actions/github-script@v2.0.0 uses: actions/github-script@6e5ee1dc1cb3740e5e5e76ad668e3f526edbfe45
id: is-internal-contributor id: is-internal-contributor
with: with:
github-token: ${{secrets.GITHUB_TOKEN}} github-token: ${{secrets.GITHUB_TOKEN}}
@@ -33,13 +33,13 @@ jobs:
return 'false' return 'false'
} }
- name: Label issues with new comments with 'triage' - name: Label issues with new comments with 'triage'
uses: rachmari/labeler@v1.0.4 uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e
if: (steps.is-internal-contributor.outputs.result == 'false') if: (steps.is-internal-contributor.outputs.result == 'false')
with: with:
repo-token: "${{ secrets.GITHUB_TOKEN }}" repo-token: "${{ secrets.GITHUB_TOKEN }}"
add-labels: "triage" add-labels: "triage"
- name: Triage to project board - name: Triage to project board
uses: rachmari/actions-add-new-issue-to-column@v1.1.1 uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9
with: with:
action-token: ${{ secrets.GITHUB_TOKEN }} action-token: ${{ secrets.GITHUB_TOKEN }}
project-url: "https://github.com/github/docs/projects/1" project-url: "https://github.com/github/docs/projects/1"

View File

@@ -10,12 +10,12 @@ jobs:
steps: steps:
- name: Label new issues with 'triage' - name: Label new issues with 'triage'
uses: rachmari/labeler@v1.0.4 uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e
with: with:
repo-token: "${{ secrets.GITHUB_TOKEN }}" repo-token: "${{ secrets.GITHUB_TOKEN }}"
add-labels: "triage" add-labels: "triage"
- name: Triage to project board - name: Triage to project board
uses: rachmari/actions-add-new-issue-to-column@v1.1.1 uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9
with: with:
action-token: ${{ secrets.GITHUB_TOKEN }} action-token: ${{ secrets.GITHUB_TOKEN }}
project-url: "https://github.com/github/docs/projects/1" project-url: "https://github.com/github/docs/projects/1"

View File

@@ -10,12 +10,12 @@ jobs:
steps: steps:
- name: Label new pull requests with 'triage' - name: Label new pull requests with 'triage'
uses: rachmari/labeler@v1.0.4 uses: rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e
with: with:
repo-token: "${{ secrets.GITHUB_TOKEN }}" repo-token: "${{ secrets.GITHUB_TOKEN }}"
add-labels: "triage" add-labels: "triage"
- name: Triage to project board - name: Triage to project board
uses: rachmari/actions-add-new-issue-to-column@v1.1.1 uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9
with: with:
action-token: ${{ secrets.GITHUB_TOKEN }} action-token: ${{ secrets.GITHUB_TOKEN }}
project-url: "https://github.com/github/docs/projects/1" project-url: "https://github.com/github/docs/projects/1"

View File

@@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/stale@v3 - uses: actions/stale@44f9eae0adddf72dbf3eedfacc999f70afcec1a8
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-message: 'This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.' stale-pr-message: 'This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.'

View File

@@ -22,9 +22,9 @@ jobs:
echo 'The repo is currently frozen! Exiting this workflow.' echo 'The repo is currently frozen! Exiting this workflow.'
exit 1 # prevents further steps from running exit 1 # prevents further steps from running
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- name: Set up Ruby - name: Set up Ruby
uses: actions/setup-ruby@v1 uses: actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526
with: with:
ruby-version: '2.4' ruby-version: '2.4'
- name: Install Ruby dependencies - name: Install Ruby dependencies
@@ -46,7 +46,7 @@ jobs:
script/graphql/build-changelog-from-markdown.js script/graphql/build-changelog-from-markdown.js
- name: Create pull request - name: Create pull request
id: create-pull-request id: create-pull-request
uses: peter-evans/create-pull-request@v2 uses: peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8
with: with:
# need to use a token with repo and workflow scopes for this step # need to use a token with repo and workflow scopes for this step
token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
@@ -60,13 +60,13 @@ jobs:
branch: graphql-schema-update branch: graphql-schema-update
- if: ${{ failure() }} - if: ${{ failure() }}
name: Delete remote branch (if previous steps failed) name: Delete remote branch (if previous steps failed)
uses: dawidd6/action-delete-branch@v3 uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} github_token: ${{ secrets.GITHUB_TOKEN }}
branches: graphql-schema-update branches: graphql-schema-update
- if: ${{ steps.create-pull-request.outputs.pr_number }} - if: ${{ steps.create-pull-request.outputs.pr_number }}
name: Approve name: Approve
uses: juliangruber/approve-pull-request-action@v1 uses: juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8
with: with:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
number: ${{ steps.create-pull-request.outputs.pr_number }} number: ${{ steps.create-pull-request.outputs.pr_number }}

View File

@@ -8,7 +8,6 @@ In this article:
- [Contributing](#contributing) - [Contributing](#contributing)
- [READMEs](#readmes) - [READMEs](#readmes)
- [License](#license) - [License](#license)
- [Contributors ✨](#contributors-)
## Contributing ## Contributing
@@ -70,69 +69,3 @@ The GitHub product documentation in the assets, content, and data folders are li
All other code in this repository is licensed under a [MIT license](LICENSE-CODE). All other code in this repository is licensed under a [MIT license](LICENSE-CODE).
When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/alebourne"><img src="https://avatars1.githubusercontent.com/u/24581915?v=4" width="64px;" alt=""/><br /><sub><b>Alexandra Bourne</b></sub></a><br /><a href="#content-alebourne" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Aalebourne" title="Bug reports">🐛</a></td>
<td align="center"><a href="http://cynthiarich.me/"><img src="https://avatars0.githubusercontent.com/u/9950121?v=4" width="64px;" alt=""/><br /><sub><b>Cynthia Rich</b></sub></a><br /><a href="#content-crichID" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3AcrichID" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/emilyistoofunky"><img src="https://avatars1.githubusercontent.com/u/4822039?v=4" width="64px;" alt=""/><br /><sub><b>Emily Gould</b></sub></a><br /><a href="#content-emilyistoofunky" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Aemilyistoofunky" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/felicitymay"><img src="https://avatars1.githubusercontent.com/u/1877141?v=4" width="64px;" alt=""/><br /><sub><b>Felicity Chapman</b></sub></a><br /><a href="#content-felicitymay" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Afelicitymay" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://heiskr.com/"><img src="https://avatars2.githubusercontent.com/u/1221423?v=4" width="64px;" alt=""/><br /><sub><b>Kevin Heis</b></sub></a><br /><a href="https://github.com/github/docs/issues?q=author%3Aheiskr" title="Bug reports">🐛</a> <a href="https://github.com/github/docs/commits?author=heiskr" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/hubwriter"><img src="https://avatars1.githubusercontent.com/u/54933897?v=4" width="64px;" alt=""/><br /><sub><b>Alistair Christie</b></sub></a><br /><a href="#content-hubwriter" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Ahubwriter" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://jamesmgreene.github.io/"><img src="https://avatars2.githubusercontent.com/u/417751?v=4" width="64px;" alt=""/><br /><sub><b>James M. Greene</b></sub></a><br /><a href="https://github.com/github/docs/issues?q=author%3AJamesMGreene" title="Bug reports">🐛</a> <a href="https://github.com/github/docs/commits?author=JamesMGreene" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/janiceilene"><img src="https://avatars3.githubusercontent.com/u/9817819?v=4" width="64px;" alt=""/><br /><sub><b>Janice</b></sub></a><br /><a href="#content-janiceilene" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Ajaniceilene" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://jasonet.co"><img src="https://avatars1.githubusercontent.com/u/10660468?v=4" width="64px;" alt=""/><br /><sub><b>Jason Etcovitch</b></sub></a><br /><a href="https://github.com/github/docs/issues?q=author%3Ajasonetco" title="Bug reports">🐛</a> <a href="https://github.com/github/docs/commits?author=jasonetco" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/jf205"><img src="https://avatars2.githubusercontent.com/u/42464962?v=4" width="64px;" alt=""/><br /><sub><b>James Fletcher</b></sub></a><br /><a href="#content-jf205" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Ajf205" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/jleaver"><img src="https://avatars2.githubusercontent.com/u/4453117?v=4" width="64px;" alt=""/><br /><sub><b>Jenn Leaver</b></sub></a><br /><a href="#content-jleaver" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Ajleaver" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/jmarlena"><img src="https://avatars3.githubusercontent.com/u/6732600?v=4" width="64px;" alt=""/><br /><sub><b>jmarlena</b></sub></a><br /><a href="#content-jmarlena" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Ajmarlena" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://johnwargo.com/"><img src="https://avatars0.githubusercontent.com/u/30843404?v=4" width="64px;" alt=""/><br /><sub><b>John M. Wargo</b></sub></a><br /><a href="#content-jwargo" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Ajwargo" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/lecoursen"><img src="https://avatars3.githubusercontent.com/u/14935376?v=4" width="64px;" alt=""/><br /><sub><b>Laura Coursen</b></sub></a><br /><a href="#content-lecoursen" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Alecoursen" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://lucascosti.com/"><img src="https://avatars3.githubusercontent.com/u/4434330?v=4" width="64px;" alt=""/><br /><sub><b>Lucas Costi</b></sub></a><br /><a href="#content-lucascosti" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Alucascosti" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/martin389"><img src="https://avatars3.githubusercontent.com/u/54248166?v=4" width="64px;" alt=""/><br /><sub><b>Martin Lopes</b></sub></a><br /><a href="#content-martin389" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Amartin389" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/mattpollard"><img src="https://avatars0.githubusercontent.com/u/1894408?v=4" width="64px;" alt=""/><br /><sub><b>Matt Pollard</b></sub></a><br /><a href="#content-mattpollard" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Amattpollard" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/mchammer01"><img src="https://avatars3.githubusercontent.com/u/42146119?v=4" width="64px;" alt=""/><br /><sub><b>mc</b></sub></a><br /><a href="#content-mchammer01" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Amchammer01" title="Bug reports">🐛</a></td>
<td align="center"><a href="http://meaganbird.com/"><img src="https://avatars2.githubusercontent.com/u/5658046?v=4" width="64px;" alt=""/><br /><sub><b>Meg Bird</b></sub></a><br /><a href="#content-megbird" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Amegbird" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/myarb"><img src="https://avatars2.githubusercontent.com/u/11952755?v=4" width="64px;" alt=""/><br /><sub><b>Melanie Yarbrough</b></sub></a><br /><a href="#content-myarb" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Amyarb" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/rachmari"><img src="https://avatars2.githubusercontent.com/u/9831992?v=4" width="64px;" alt=""/><br /><sub><b>Rachael Sewell</b></sub></a><br /><a href="#content-rachmari" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Arachmari" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/runleonarun"><img src="https://avatars1.githubusercontent.com/u/3880403?v=4" width="64px;" alt=""/><br /><sub><b>Leona B. Campbell</b></sub></a><br /><a href="#content-runleonarun" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Arunleonarun" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/sarahs"><img src="https://avatars3.githubusercontent.com/u/821071?v=4" width="64px;" alt=""/><br /><sub><b>Sarah Schneider</b></sub></a><br /><a href="https://github.com/github/docs/issues?q=author%3Asarahs" title="Bug reports">🐛</a> <a href="https://github.com/github/docs/commits?author=sarahs" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/shati-patel"><img src="https://avatars3.githubusercontent.com/u/42641846?v=4" width="64px;" alt=""/><br /><sub><b>Shati Patel</b></sub></a><br /><a href="#content-shati-patel" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Ashati-patel" title="Bug reports">🐛</a></td>
<td align="center"><a href="http://kathy.pm/"><img src="https://avatars3.githubusercontent.com/u/704152?v=4" width="64px;" alt=""/><br /><sub><b>Kathy Korevec</b></sub></a><br /><a href="#content-simpsoka" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Asimpsoka" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/timeyoutakeit"><img src="https://avatars3.githubusercontent.com/u/5012825?v=4" width="64px;" alt=""/><br /><sub><b>Amy Burns</b></sub></a><br /><a href="#content-timeyoutakeit" title="Content">🖋</a> <a href="https://github.com/github/docs/issues?q=author%3Atimeyoutakeit" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/vanessayuenn"><img src="https://avatars3.githubusercontent.com/u/6842965?v=4" width="64px;" alt=""/><br /><sub><b>Vanessa Yuen</b></sub></a><br /><a href="https://github.com/github/docs/issues?q=author%3Avanessayuenn" title="Bug reports">🐛</a> <a href="https://github.com/github/docs/commits?author=vanessayuenn" title="Code">💻</a></td>
<td align="center"><a href="http://zeke.sikelianos.com/"><img src="https://avatars1.githubusercontent.com/u/2289?v=4" width="64px;" alt=""/><br /><sub><b>Zeke Sikelianos</b></sub></a><br /><a href="https://github.com/github/docs/issues?q=author%3Azeke" title="Bug reports">🐛</a> <a href="https://github.com/github/docs/commits?author=zeke" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/BenJam"><img src="https://avatars2.githubusercontent.com/u/158833?v=4" width="64px;" alt=""/><br /><sub><b>Benjamin Nickolls</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=BenJam" title="Documentation">📖</a></td>
<td align="center"><a href="https://mcaffer.com"><img src="https://avatars2.githubusercontent.com/u/10070956?v=4" width="64px;" alt=""/><br /><sub><b>Jeff McAffer</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=jeffmcaffer" title="Documentation">📖</a></td>
<td align="center"><a href="https://tjenkinson.me"><img src="https://avatars0.githubusercontent.com/u/3259993?v=4" width="64px;" alt=""/><br /><sub><b>Tom Jenkinson</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=tjenkinson" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/casals"><img src="https://avatars0.githubusercontent.com/u/785860?v=4" width="64px;" alt=""/><br /><sub><b>Arthur Casals</b></sub></a><br /><a href="#content-casals" title="Content">🖋</a> <a href="https://github.com/github/docs/commits?author=casals" title="Documentation">📖</a></td>
<td align="center"><a href="https://www.arangodb.com/"><img src="https://avatars3.githubusercontent.com/u/7819991?v=4" width="64px;" alt=""/><br /><sub><b>Simran</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=Simran-B" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/ruth"><img src="https://avatars0.githubusercontent.com/u/85029?v=4" width="64px;" alt=""/><br /><sub><b>Ruth</b></sub></a><br /><a href="#content-Ruth" title="Content">🖋</a></td>
<td align="center"><a href="http://tomaszwisniewski.com"><img src="https://avatars2.githubusercontent.com/u/12593852?v=4" width="64px;" alt=""/><br /><sub><b>Tomasz Wisniewski</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=wi5nia" title="Documentation">📖</a></td>
</tr>
<tr>
<td align="center"><a href="https://chiedojohn.com/"><img src="https://avatars2.githubusercontent.com/u/2156688?v=4" width="64px;" alt=""/><br /><sub><b>Chiedo John</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=chiedo" title="Code">💻</a></td>
<td align="center"><a href="https://wanderingmonster.org"><img src="https://avatars1.githubusercontent.com/u/419457?v=4" width="64px;" alt=""/><br /><sub><b>Paul Schifferer</b></sub></a><br /><a href="#content-paulyhedral" title="Content">🖋</a></td>
<td align="center"><a href="https://www.kewindousse.ch"><img src="https://avatars3.githubusercontent.com/u/1529017?v=4" width="64px;" alt=""/><br /><sub><b>Kewin Dousse</b></sub></a><br /><a href="#content-Protectator" title="Content">🖋</a></td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.0 KiB

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.5 KiB

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 298 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 268 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 230 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 167 KiB

After

Width:  |  Height:  |  Size: 554 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 181 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 219 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 274 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

View File

@@ -2,9 +2,9 @@
The `/content` directory is where all the site's (English) Markdown content lives! The `/content` directory is where all the site's (English) Markdown content lives!
See the [markup reference guide](contributing/content-markup-reference.md) for more information about supported Markdown features. See the [markup reference guide](/contributing/content-markup-reference.md) for more information about supported Markdown features.
See the [contributing docs](contributing) for general information about working with the docs. See the [contributing docs](/CONTRIBUTING.md) for general information about working with the docs.
- [Frontmatter](#frontmatter) - [Frontmatter](#frontmatter)
- [`versions`](#versions) - [`versions`](#versions)

View File

@@ -36,7 +36,7 @@ Before you begin, you'll create a {% data variables.product.product_name %} repo
echo "Goodbye" echo "Goodbye"
``` ```
1. From your terminal, make `goodbye.sh` executable and check it into your repository. 3. From your terminal, make `goodbye.sh` executable.
```shell ```shell
chmod +x goodbye.sh chmod +x goodbye.sh
@@ -85,14 +85,26 @@ Before you begin, you'll create a {% data variables.product.product_name %} repo
For more information about how to use `github.action_path`, see "[`github context`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)". For more information about how to use `github.action_path`, see "[`github context`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)".
1. Create a new label. This example uses a label called `v1` for the main branch. For more information, see "[Creating a label 1. From your terminal, check in your `action.yml` file.
](/github/managing-your-work-on-github/creating-a-label)."
```shell
git add action.yml
git commit -m "Add action"
git push
```
1. From your terminal, add a tag. This example uses a tag called `v1`. For more information, see "[About actions](/actions/creating-actions/about-actions#using-release-management-for-actions)."
```shell
git tag -a -m "Description of this release" v1
git push --follow-tags
```
### Testing out your action in a workflow ### Testing out your action in a workflow
The following workflow code uses the completed hello world action that you made in "[Creating an action metadata file](/actions/creating-actions/creating-a-composite-run-steps-action#creating-an-action-metadata-file)". The following workflow code uses the completed hello world action that you made in "[Creating an action metadata file](/actions/creating-actions/creating-a-composite-run-steps-action#creating-an-action-metadata-file)".
Copy the workflow code into a `.github/workflows/main.yml` file in another repository, but replace `actions/hello-world-composite-run-steps-action@v1` with the repository and label you created. You can also replace the `who-to-greet` input with your name. Copy the workflow code into a `.github/workflows/main.yml` file in another repository, but replace `actions/hello-world-composite-run-steps-action@v1` with the repository and tag you created. You can also replace the `who-to-greet` input with your name.
{% raw %} {% raw %}
**.github/workflows/main.yml** **.github/workflows/main.yml**

View File

@@ -263,4 +263,8 @@ jobs:
From your repository, click the **Actions** tab, and select the latest workflow run. You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. From your repository, click the **Actions** tab, and select the latest workflow run. You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png)
{% else %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png) ![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png)
{% endif %}

View File

@@ -33,7 +33,7 @@ We recommend that you have a basic understanding of Node.js, YAML, workflow conf
To get started quickly, add the template to the `.github/workflows` directory of your repository. To get started quickly, add the template to the `.github/workflows` directory of your repository.
{% raw %} {% raw %}
```yaml ```yaml{:copy}
name: Node.js CI name: Node.js CI
on: [push] on: [push]

View File

@@ -74,7 +74,7 @@ For example, your repository or a web application might contain SASS and TypeScr
| |
``` ```
This example shows you how to create a workflow for a Node.js project that `builds` the code in the `src` directory and runs the tests in the `tests` directory. You can assume that running `npm test` produces a code coverage report named `code-coverage.html` stored in the `output/test/` directory. This example shows you how to create a workflow for a Node.js project that builds the code in the `src` directory and runs the tests in the `tests` directory. You can assume that running `npm test` produces a code coverage report named `code-coverage.html` stored in the `output/test/` directory.
The workflow uploads the production artifacts in the `dist` directory, but excludes any markdown files. It also and uploads the `code-coverage.html` report as another artifact. The workflow uploads the production artifacts in the `dist` directory, but excludes any markdown files. It also and uploads the `code-coverage.html` report as another artifact.

View File

@@ -2,12 +2,15 @@
title: GitHub Actions Documentation title: GitHub Actions Documentation
shortTitle: GitHub Actions shortTitle: GitHub Actions
intro: 'Automate, customize, and execute your software development workflows right in your repository with {% data variables.product.prodname_actions %}. You can discover, create, and share actions to perform any job you''d like, including CI/CD, and combine actions in a completely customized workflow.' intro: 'Automate, customize, and execute your software development workflows right in your repository with {% data variables.product.prodname_actions %}. You can discover, create, and share actions to perform any job you''d like, including CI/CD, and combine actions in a completely customized workflow.'
introLinks:
quickstart: /actions/quickstart
learn: /actions/learn-github-actions
gettingStartedLinks: gettingStartedLinks:
- /actions/quickstart
- /actions/learn-github-actions
guideLinks:
- /actions/managing-workflow-runs - /actions/managing-workflow-runs
- /actions/hosting-your-own-runners - /actions/hosting-your-own-runners
guideLinks:
- /actions/guides/setting-up-continuous-integration-using-workflow-templates
- /actions/guides/about-packaging-with-github-actions
popularLinks: popularLinks:
- /actions/reference/workflow-syntax-for-github-actions - /actions/reference/workflow-syntax-for-github-actions
- /actions/reference/events-that-trigger-workflows - /actions/reference/events-that-trigger-workflows
@@ -36,10 +39,10 @@ versions:
<div class="d-lg-flex gutter my-6 py-6"> <div class="d-lg-flex gutter my-6 py-6">
<div class="col-12 col-lg-4 mb-4 mb-lg-0"> <div class="col-12 col-lg-4 mb-4 mb-lg-0">
<div class="featured-links-heading pb-4"> <div class="featured-links-heading pb-4">
<h3 class="f5 text-normal text-mono underline-dashed color-gray-5">{% data ui.toc.getting_started %}</h3> <h3 class="f5 text-normal text-mono underline-dashed color-gray-5">{% data ui.toc.guides %}</h3>
</div> </div>
<ul class="list-style-none"> <ul class="list-style-none">
{% for link in gettingStartedLinks %} {% for link in guideLinks %}
<li>{% include featured-link %}</li> <li>{% include featured-link %}</li>
{% endfor %} {% endfor %}
</ul> </ul>
@@ -61,40 +64,16 @@ versions:
<h3 class="f5 text-normal text-mono underline-dashed color-gray-5">Manage workflows</h3> <h3 class="f5 text-normal text-mono underline-dashed color-gray-5">Manage workflows</h3>
</div> </div>
<ul class="list-style-none"> <ul class="list-style-none">
{% for link in guideLinks %} {% for link in gettingStartedLinks %}
<li>{% include featured-link %}</li> <li>{% include featured-link %}</li>
{% endfor %} {% endfor %}
</ul> </ul>
</div> </div>
</div> </div>
<!-- Featured resources -->
<div class="d-lg-flex gutter-lg my-6 py-6 text-center flex-items-stretch">
<div class="col-12 col-lg-4 mb-2 mb-lg-0">
<a href="/actions/creating-actions" class="d-block text-gray-dark no-underline hover-grow Box p-5 bg-gray-light">
<div class="mb-4 d-flex flex-justify-center"><div class="circle p-3 bg-blue text-white">{% octicon "bookmark" width="24" %}</div></div>
<h4>Create actions</h4>
<p class="mb-0">A complete guide to creating and sharing actions with the community.</p>
</a>
</div>
<div class="col-12 col-lg-4 mb-2 mb-lg-0">
<a href="https://github.com/actions/starter-workflows" class="d-block text-gray-dark no-underline hover-grow Box p-5 bg-gray-light">
<div class="mb-4 d-flex flex-justify-center"><div class="circle p-3 bg-purple text-white">{% octicon "rocket" width="24" %}</div></div>
<h4>Starter workflows</h4>
<p class="mb-0">A collection of workflow files to help you get started with GitHub Actions.</p>
</a>
</div>
<div class="col-12 col-lg-4 mb-2 mb-lg-0">
<a href="https://github.com/marketplace?type=actions" class="d-block text-gray-dark no-underline hover-grow Box p-5 bg-gray-light">
<div class="mb-4 d-flex flex-justify-center"><div class="circle p-3 bg-orange text-white">{% octicon "light-bulb" width="24" %}</div></div>
<h4>GitHub Actions Marketplace</h4>
<p class="mb-0">Explore community actions and supercharge your workflow.</p>
</a>
</div>
</div>
<!-- Code examples --> <!-- Code examples -->
<div class="mt-6 pt-6"> <div class="mt-6 pt-6">
<h2 class="mb-2">Guides</h2> <h2 class="mb-2">More guides</h2>
<div class="d-flex flex-wrap gutter"> <div class="d-flex flex-wrap gutter">
<div class="col-12 col-lg-4 mb-4"> <div class="col-12 col-lg-4 mb-4">
@@ -195,5 +174,5 @@ versions:
</div> </div>
</div> </div>
<a href="/actions/guides" class="btn btn-outline mt-4">More guides {% octicon "arrow-right" %}</a> <a href="/actions/guides" class="btn btn-outline mt-4">Show all guides {% octicon "arrow-right" %}</a>
</div> </div>

View File

@@ -213,8 +213,13 @@ Once your job has started running, you can view each step's activity on {% data
![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png) ![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png)
1. Under "Workflow runs", click the name of the run you want to see. 1. Under "Workflow runs", click the name of the run you want to see.
![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png) ![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png)
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
1. Click on the job name to see the results of each step.
![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated.png)
{% else %}
1. Click on the job name to see the results of each step. 1. Click on the job name to see the results of each step.
![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result.png) ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result.png)
{% endif %}
### Next steps ### Next steps

View File

@@ -14,8 +14,6 @@ You can see whether a workflow run is in progress or complete from the workflow
If the run is complete, you can see whether the result was a success, failure, canceled, or neutral. If the run failed, you can view and search the build logs to diagnose the failure and re-run the workflow. You can also view billable job execution minutes, or download logs and build artifacts. If the run is complete, you can see whether the result was a success, failure, canceled, or neutral. If the run failed, you can view and search the build logs to diagnose the failure and re-run the workflow. You can also view billable job execution minutes, or download logs and build artifacts.
![Annotated workflow run image](/assets/images/help/repository/annotated-workflow.png)
{% data variables.product.prodname_actions %} use the Checks API to output statuses, results, and logs for a workflow. {% data variables.product.prodname_dotcom %} creates a new check suite for each workflow run. The check suite contains a check run for each job in the workflow, and each job includes steps. {% data variables.product.prodname_actions %} are run as a step in a workflow. For more information about the Checks API, see "[Checks](/v3/checks/)." {% data variables.product.prodname_actions %} use the Checks API to output statuses, results, and logs for a workflow. {% data variables.product.prodname_dotcom %} creates a new check suite for each workflow run. The check suite contains a check run for each job in the workflow, and each job includes steps. {% data variables.product.prodname_actions %} are run as a step in a workflow. For more information about the Checks API, see "[Checks](/v3/checks/)."
{% data reusables.github-actions.invalid-workflow-files %} {% data reusables.github-actions.invalid-workflow-files %}
@@ -30,13 +28,11 @@ For jobs run on {% data variables.product.prodname_dotcom %}-hosted runners, "Se
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %} {% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.navigate-to-workflow-superlinter %}
{% data reusables.repositories.view-run %} {% data reusables.repositories.view-run-superlinter %}
{% data reusables.repositories.navigate-to-job %} {% data reusables.repositories.navigate-to-job-superlinter %}
6. To expand the log for a failed step, click the step. {% data reusables.repositories.view-failed-job-results-superlinter %}
![Failed step name](/assets/images/help/repository/failed-check-step.png) {% data reusables.repositories.view-specific-line-superlinter %}
7. Optionally, to get a link to a specific line in the logs, click on the step's line number. You can copy the link from the address bar of your web browser.
![Button to copy link](/assets/images/help/repository/copy-link-button.png)
### Searching logs ### Searching logs
@@ -44,13 +40,18 @@ You can search the build logs for a particular step. When you search logs, only
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %} {% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.navigate-to-workflow-superlinter %}
{% data reusables.repositories.view-run %} {% data reusables.repositories.view-run-superlinter %}
{% data reusables.repositories.navigate-to-job %} {% data reusables.repositories.navigate-to-job-superlinter %}
6. To expand each step you want to include in your search, click the step. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query.
![Search box to search logs](/assets/images/help/repository/search-log-box-updated.png)
{% else %}
1. To expand each step you want to include in your search, click the step.
![Step name](/assets/images/help/repository/failed-check-step.png) ![Step name](/assets/images/help/repository/failed-check-step.png)
7. In the upper-right corner of the log output, in the **Search logs** search box, type a search query. 1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query.
![Search box to search logs](/assets/images/help/repository/search-log-box.png) ![Search box to search logs](/assets/images/help/repository/search-log-box.png)
{% endif %}
### Downloading logs ### Downloading logs
@@ -58,12 +59,16 @@ You can download the log files from your workflow run. You can also download a w
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %} {% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.navigate-to-workflow-superlinter %}
{% data reusables.repositories.view-run %} {% data reusables.repositories.view-run-superlinter %}
1. In the left sidebar, select any job. {% data reusables.repositories.navigate-to-job-superlinter %}
![Select a workflow job](/assets/images/help/repository/workflow-job.png) {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
2. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**. 1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**.
![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated.png)
{% else %}
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**.
![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down.png) ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down.png)
{% endif %}
### Deleting logs ### Deleting logs
@@ -71,10 +76,18 @@ You can delete the log files from your workflow run. {% data reusables.repositor
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %} {% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.navigate-to-workflow-superlinter %}
{% data reusables.repositories.view-run %} {% data reusables.repositories.view-run-superlinter %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated.png)
2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt.
![Delete all logs](/assets/images/help/repository/delete-all-logs-updated.png)
After deleting logs, the **Delete all logs** button is removed to indicate that no log files remain in the workflow run.
{% else %}
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. 1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon.png) ![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon.png)
2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt. 2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt.
![Delete all logs](/assets/images/help/repository/delete-all-logs.png) ![Delete all logs](/assets/images/help/repository/delete-all-logs.png)
After deleting logs, the **Delete all logs** button is removed to indicate that no log files remain in the workflow run. After the logs have been deleted, the **Delete all logs** button is removed to indicate that no log files remain in the workflow run.
{% endif %}

View File

@@ -21,7 +21,7 @@ You only need an existing {% data variables.product.prodname_dotcom %} repositor
1. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `superlinter.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)." 1. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `superlinter.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)."
2. Copy the following YAML contents into the `superlinter.yml` file. **Note:** If your default branch is not `main`, update the value of `DEFAULT_BRANCH` to match your repository's default branch name. 2. Copy the following YAML contents into the `superlinter.yml` file. **Note:** If your default branch is not `main`, update the value of `DEFAULT_BRANCH` to match your repository's default branch name.
{% raw %} {% raw %}
```yaml ```yaml{:copy}
name: Super-Linter name: Super-Linter
# Run this workflow every time a new commit pushed to your repository # Run this workflow every time a new commit pushed to your repository
@@ -56,15 +56,13 @@ Committing the workflow file in your repository triggers the `push` event and ru
### Viewing your workflow results ### Viewing your workflow results
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %} {% data reusables.repositories.actions-tab %}
1. In the left sidebar, click the workflow you want to see. {% data reusables.repositories.navigate-to-workflow-superlinter %}
![Workflow list in left sidebar](/assets/images/help/repository/superlinter-workflow-sidebar.png) {% data reusables.repositories.view-run-superlinter %}
1. From the list of workflow runs, click the name of the run you want to see.
![Name of workflow run](/assets/images/help/repository/superlinter-run-name.png)
1. In the left sidebar, click the **Lint code base** job. 1. In the left sidebar, click the **Lint code base** job.
![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job.png) ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job.png)
2. Expand the **Run Super-Linter** step to view the results. {% data reusables.repositories.view-failed-job-results-superlinter %}
![Super linter workflow results](/assets/images/help/repository/super-linter-workflow-results.png)
### More starter workflows ### More starter workflows

View File

@@ -93,7 +93,7 @@ The `github` context contains information about the workflow run and the event t
| `github.event_path` | `string` | The path to the full event webhook payload on the runner. | | `github.event_path` | `string` | The path to the full event webhook payload on the runner. |
| `github.head_ref` | `string` | The `head_ref` or source branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is a `pull_request`. | | `github.head_ref` | `string` | The `head_ref` or source branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is a `pull_request`. |
| `github.job` | `string` | The [`job_id`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. | | `github.job` | `string` | The [`job_id`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. |
| `github.ref` | `string` | The branch or tag ref that triggered the workflow run. | | `github.ref` | `string` | The branch or tag ref that triggered the workflow run. For branches this in the format `refs/heads/<branch_name>`, and for tags it is `refs/tags/<tag_name>`. |
| `github.repository` | `string` | The owner and repository name. For example, `Codertocat/Hello-World`. | | `github.repository` | `string` | The owner and repository name. For example, `Codertocat/Hello-World`. |
| `github.repository_owner` | `string` | The repository owner's name. For example, `Codertocat`. | | `github.repository_owner` | `string` | The repository owner's name. For example, `Codertocat`. |
| `github.run_id` | `string` | {% data reusables.github-actions.run_id_description %} | | `github.run_id` | `string` | {% data reusables.github-actions.run_id_description %} |

View File

@@ -50,6 +50,7 @@ Each virtual machine has the same hardware resources available.
{% data reusables.github-actions.supported-github-runners %} {% data reusables.github-actions.supported-github-runners %}
{% data reusables.github-actions.ubuntu-runner-preview %} {% data reusables.github-actions.ubuntu-runner-preview %}
{% data reusables.github-actions.macos-runner-preview %}
Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
@@ -63,8 +64,10 @@ The software tools included in {% data variables.product.prodname_dotcom %}-host
* [Windows Server 2019](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md) * [Windows Server 2019](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md)
* [Windows Server 2016](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2016-Readme.md) * [Windows Server 2016](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2016-Readme.md)
* [MacOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md) * [MacOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md)
* [MacOS 11.0](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11.0-Readme.md)
{% data reusables.github-actions.ubuntu-runner-preview %} {% data reusables.github-actions.ubuntu-runner-preview %}
{% data reusables.github-actions.macos-runner-preview %}
{% data variables.product.prodname_dotcom %}-hosted runners include the operating system's default built-in tools, in addition to the packages listed in the above references. For example, Ubuntu and macOS runners include `grep`, `find`, and `which`, among other default tools. {% data variables.product.prodname_dotcom %}-hosted runners include the operating system's default built-in tools, in addition to the packages listed in the above references. For example, Ubuntu and macOS runners include `grep`, `find`, and `which`, among other default tools.

View File

@@ -53,13 +53,15 @@ core.setOutput('SELECTED_COLOR', 'green');
You can use the `set-output` command in your workflow to set the same value: You can use the `set-output` command in your workflow to set the same value:
{% raw %}
``` yaml ``` yaml
- name: Set selected color - name: Set selected color
run: echo '::set-output name=SELECTED_COLOR::green' run: echo '::set-output name=SELECTED_COLOR::green'
id: random-color-generator id: random-color-generator
- name: Get color - name: Get color
run: echo 'The selected color is' ${steps.random-color-generator.outputs.SELECTED_COLOR} run: echo "The selected color is ${{ steps.random-color-generator.outputs.SELECTED_COLOR }}"
``` ```
{% endraw %}
The following table shows which toolkit functions are available within a workflow: The following table shows which toolkit functions are available within a workflow:

View File

@@ -21,7 +21,7 @@ versions:
### Recommendations ### Recommendations
- Include as few upgrades as possible in your upgrade process. For example, instead of upgrading from {% data variables.product.prodname_enterprise %} {{ enterpriseVersions.supported[2] }} to {{ enterpriseVersions.supported[1] }} to {{ enterpriseVersions.latest }}, you could upgrade from {% data variables.product.prodname_enterprise %} {{ enterpriseVersions.supported[2] }} to {{ enterpriseVersions.latest }}. - Include as few upgrades as possible in your upgrade process. For example, instead of upgrading from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.supported[1] }} to {{ enterpriseServerReleases.latest }}, you could upgrade from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.latest }}.
- If youre several versions behind, upgrade {% data variables.product.product_location_enterprise %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step. - If youre several versions behind, upgrade {% data variables.product.product_location_enterprise %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step.
- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} - Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %}
- Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)." - Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)."
@@ -29,7 +29,7 @@ versions:
### Requirements ### Requirements
- You must upgrade from a feature release that's **at most** two releases behind. For example, to upgrade to {% data variables.product.prodname_enterprise %} {{ enterpriseVersions.latest }}, you must be on {% data variables.product.prodname_enterprise %} {{ enterpriseVersions.supported[1] }} or {{ enterpriseVersions.supported[2] }}. - You must upgrade from a feature release that's **at most** two releases behind. For example, to upgrade to {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.latest }}, you must be on {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[1] }} or {{ enterpriseServerReleases.supported[2] }}.
- {% data reusables.enterprise_installation.hotpatching-explanation %} - {% data reusables.enterprise_installation.hotpatching-explanation %}
- A hotpatch may require downtime if the affected services (like kernel, MySQL, or Elasticsearch) require a VM reboot or a service restart. You'll be notified when a reboot or restart is required. You can complete the reboot or restart at a later time. - A hotpatch may require downtime if the affected services (like kernel, MySQL, or Elasticsearch) require a VM reboot or a service restart. You'll be notified when a reboot or restart is required. You can complete the reboot or restart at a later time.
- Additional root storage must be available when upgrading through hotpatching, as it installs multiple versions of certain services until the upgrade is complete. Pre-flight checks will notify you if you don't have enough root disk storage. - Additional root storage must be available when upgrading through hotpatching, as it installs multiple versions of certain services until the upgrade is complete. Pre-flight checks will notify you if you don't have enough root disk storage.

View File

@@ -59,7 +59,7 @@ For urgent issues, we can help you in English 24 hours per day, 7 days per week,
{% data variables.contact.enterprise_support %} observes these U.S. holidays, although our global support team is available to answer urgent tickets. {% data variables.contact.enterprise_support %} observes these U.S. holidays, although our global support team is available to answer urgent tickets.
| U.S. holiday | Date observed in {{ "now" | date: "%Y" }} | | U.S. holiday | Date observed |
| --- | --- | | --- | --- |
| New Year's Day | January 1 | | New Year's Day | January 1 |
| Martin Luther King, Jr. Day | Third Monday in January | | Martin Luther King, Jr. Day | Third Monday in January |

View File

@@ -99,9 +99,10 @@ You can use these steps to create and share a support bundle if you have SSH acc
#### Uploading a support bundle using your enterprise account #### Uploading a support bundle using your enterprise account
{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.enterprise-licensing-tab %} 3. In the left sidebar, click **Enterprise licensing**.
!["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png)
4. Under "{% data variables.product.prodname_enterprise %} Help", click **Upload a support bundle**. 4. Under "{% data variables.product.prodname_enterprise %} Help", click **Upload a support bundle**.
![Upload a support bundle link](/assets/images/enterprise/support/upload-support-bundle.png) ![Upload a support bundle link](/assets/images/enterprise/support/upload-support-bundle.png)
5. Under "Select an enterprise account", select the support bundle's associated account from the drop-down menu. 5. Under "Select an enterprise account", select the support bundle's associated account from the drop-down menu.

View File

@@ -23,9 +23,10 @@ After submitting your support request and optional diagnostic information, {% da
### Submitting a ticket using your enterprise account ### Submitting a ticket using your enterprise account
{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.enterprise-licensing-tab %} 3. In the left sidebar, click **Enterprise licensing**.
!["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png)
4. Under "{% data variables.product.prodname_enterprise %} Help", click **{% data variables.contact.enterprise_support %} Portal**. 4. Under "{% data variables.product.prodname_enterprise %} Help", click **{% data variables.contact.enterprise_support %} Portal**.
![Link to navigate to Enterprise support site](/assets/images/enterprise/support/enterprise-support-link.png) ![Link to navigate to Enterprise support site](/assets/images/enterprise/support/enterprise-support-link.png)
5. Click **Submit a Ticket** 5. Click **Submit a Ticket**

View File

@@ -30,9 +30,10 @@ After you purchase a new license or upgrade an existing license from {% data var
If you'd like to renew or add user licenses to {% data variables.product.prodname_enterprise %}, contact {% data variables.contact.contact_enterprise_sales %}. Your new license file will be available for download immediately after you complete your order. If you'd like to renew or add user licenses to {% data variables.product.prodname_enterprise %}, contact {% data variables.contact.contact_enterprise_sales %}. Your new license file will be available for download immediately after you complete your order.
{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.enterprise-licensing-tab %} 3. In the left sidebar, click **Enterprise licensing**.
!["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png)
4. Under "Enterprise Server Instances", click {% octicon "download" aria-label="The download icon" %} to download your license file. 4. Under "Enterprise Server Instances", click {% octicon "download" aria-label="The download icon" %} to download your license file.
![Download GitHub Enterprise Server license](/assets/images/help/business-accounts/download-ghes-license.png) ![Download GitHub Enterprise Server license](/assets/images/help/business-accounts/download-ghes-license.png)
5. Log into your {% data variables.product.prodname_ghe_server %} instance as a site administrator. 5. Log into your {% data variables.product.prodname_ghe_server %} instance as a site administrator.
@@ -49,9 +50,10 @@ If you'd like to renew or add user licenses to {% data variables.product.prodnam
### Viewing license usage ### Viewing license usage
{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.enterprise-licensing-tab %} 3. In the left sidebar, click **Enterprise licensing**.
!["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png)
4. Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses. 4. Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses.
### Automatically syncing user license usage with {% data variables.product.prodname_ghe_cloud %} ### Automatically syncing user license usage with {% data variables.product.prodname_ghe_cloud %}
@@ -68,10 +70,11 @@ You can download a JSON file from {% data variables.product.prodname_ghe_server
{% data reusables.enterprise-accounts.license-tab %} {% data reusables.enterprise-accounts.license-tab %}
5. Under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**. 5. Under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**.
![Export license usage link](/assets/images/enterprise/business-accounts/export-license-usage-link.png) ![Export license usage link](/assets/images/enterprise/business-accounts/export-license-usage-link.png)
6. Navigate to {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.enterprise-licensing-tab %} 8. In the left sidebar, click **Enterprise licensing**.
!["Enterprise licensing" tab in the enterprise account settings sidebar](/assets/images/help/enterprises/enterprise-licensing-tab.png)
{% data reusables.enterprise-accounts.license-tab %}
10. Under "Enterprise Server Instances", click **Add server usage**. 10. Under "Enterprise Server Instances", click **Add server usage**.
![Upload GitHub Enterprise Servers usage link](/assets/images/help/business-accounts/upload-ghe-server-usage-link.png) ![Upload GitHub Enterprise Servers usage link](/assets/images/help/business-accounts/upload-ghe-server-usage-link.png)
11. Upload the JSON file you downloaded from {% data variables.product.prodname_ghe_server %}. 11. Upload the JSON file you downloaded from {% data variables.product.prodname_ghe_server %}.

View File

@@ -38,7 +38,7 @@ To generate a private key:
{% endnote %} {% endnote %}
### Verifying private keys ### Verifying private keys
{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using a SHA-1 hash function. You can verify that your private key matches the public key stored on {% data variables.product.product_name %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.product_name %}. {% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the {% if currentVersion ver_lt "enterprise-server@2.23" %}SHA-1{% else %}SHA-256{% endif %} hash function. You can verify that your private key matches the public key stored on {% data variables.product.product_name %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.product_name %}.
To verify a private key: To verify a private key:
@@ -46,7 +46,7 @@ To verify a private key:
![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png) ![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png)
2. Generate the fingerprint of your private key (PEM) locally by using the following command: 2. Generate the fingerprint of your private key (PEM) locally by using the following command:
```shell ```shell
$ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha1 -c $ openssl rsa -in <em>PATH_TO_PEM_FILE</em> -pubout -outform DER | openssl {% if currentVersion ver_lt "enterprise-server@2.23" %}sha1 -c{% else %}sha256 -binary | openssl base64{% endif %}
``` ```
3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}. 3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}.

View File

@@ -71,7 +71,7 @@ Name | Description
**`admin:gpg_key`** | Fully manage GPG keys. **`admin:gpg_key`** | Fully manage GPG keys.
&emsp;`write:gpg_key`| Create, list, and view details for GPG keys. &emsp;`write:gpg_key`| Create, list, and view details for GPG keys.
&emsp;`read:gpg_key`| List and view details for GPG keys.{% if currentVersion == "free-pro-team@latest" %} &emsp;`read:gpg_key`| List and view details for GPG keys.{% if currentVersion == "free-pro-team@latest" %}
**`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository.{% endif %} **`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository. Workflow files can expose `GITHUB_TOKEN` which may have a different set of scopes, see https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token for details.{% endif %}
{% note %} {% note %}

View File

@@ -14,7 +14,7 @@ versions:
{% data reusables.actions.actions-not-verified %} {% data reusables.actions.actions-not-verified %}
To learn about publishing {% data variables.product.prodname_actions %} in the {% data variables.product.prodname_marketplace %}, see "[{% data variables.product.prodname_actions %} in the {% data variables.product.prodname_marketplace %}](/marketplace/actions/)." To learn about publishing {% data variables.product.prodname_actions %} in the {% data variables.product.prodname_marketplace %}, see "[Publishing actions in GitHub Marketplace](/actions/creating-actions/publishing-actions-in-github-marketplace)."
### Apps ### Apps

View File

@@ -15,7 +15,7 @@ view provides some tooling for testing your deployed payloads.
### Listing recent deliveries ### Listing recent deliveries
Every webhook has its own "Recent Deliveries" section, which lists, at a glance whether a deployment was successful (green check) or failed (red x). You can also identify when each delivery was attempted. Every webhook has its own "Recent Deliveries" section, which lists, at a glance whether a delivery was successful (green check) or failed (red x). You can also identify when each delivery was attempted.
{% data variables.product.product_name %} keeps a log of each webhook delivery for {% if currentVersion == "free-pro-team@latest" %} 30 {% else %} 8 {% endif %} days. {% data variables.product.product_name %} keeps a log of each webhook delivery for {% if currentVersion == "free-pro-team@latest" %} 30 {% else %} 8 {% endif %} days.

View File

@@ -973,13 +973,17 @@ Key | Type | Description
`before`|`string` | The SHA of the most recent commit on `ref` before the push. `before`|`string` | The SHA of the most recent commit on `ref` before the push.
`after`|`string` | The SHA of the most recent commit on `ref` after the push. `after`|`string` | The SHA of the most recent commit on `ref` after the push.
`commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/v3/repos/commits/) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.) `commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/v3/repos/commits/) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)
`commits[][sha]`|`string` | The SHA of the commit. `commits[][id]`|`string` | The SHA of the commit.
`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit.
`commits[][message]`|`string` | The commit message. `commits[][message]`|`string` | The commit message.
`commits[][author]`|`object` | The git author of the commit. `commits[][author]`|`object` | The git author of the commit.
`commits[][author][name]`|`string` | The git author's name. `commits[][author][name]`|`string` | The git author's name.
`commits[][author][email]`|`string` | The git author's email address. `commits[][author][email]`|`string` | The git author's email address.
`commits[][url]`|`url` | URL that points to the commit API resource. `commits[][url]`|`url` | URL that points to the commit API resource.
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before. `commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
`commits[][added]`|`array` | An array of files added in the commit.
`commits[][modified]`|`array` | An array of files modified by the commit.
`commits[][removed]`|`array` | An array of files removed in the commit.
`pusher` | `object` | The user who pushed the commits. `pusher` | `object` | The user who pushed the commits.
{% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.repo_desc %}
{% data reusables.webhooks.org_desc %} {% data reusables.webhooks.org_desc %}

View File

@@ -546,12 +546,6 @@ updates:
Use the `vendor` option to tell {% data variables.product.prodname_dependabot_short %} to vendor dependencies when updating them. Use the `vendor` option to tell {% data variables.product.prodname_dependabot_short %} to vendor dependencies when updating them.
{% note %}
Currently, {% data variables.product.prodname_dependabot_short %} only supports vendoring dependencies for Bundler.
{% endnote %}
```yaml ```yaml
# Configure version updates for both dependencies defined in manifests and vendored dependencies # Configure version updates for both dependencies defined in manifests and vendored dependencies
@@ -565,7 +559,13 @@ updates:
interval: "weekly" interval: "weekly"
``` ```
{% data variables.product.prodname_dependabot_short %} only updates the vendored dependencies located in specific directories in a repository. For Bundler, the dependencies must be in the _vendor/cache_ directory. Other file paths are not supported. For more information, see the [`bundle cache` documentation](https://bundler.io/man/bundle-cache.1.html). {% data variables.product.prodname_dependabot_short %} only updates the vendored dependencies located in specific directories in a repository.
| Package manager | Required file path for vendored dependencies | More information |
|------------------|-------------------------------|--------|
| `bundler` | The dependencies must be in the _vendor/cache_ directory.</br>Other file paths are not supported. | [`bundle cache` documentation](https://bundler.io/man/bundle-cache.1.html) |
| `gomod` | No path requirement (dependencies are usually located in the _vendor_ directory) | [`go mod vendor` documentation](https://golang.org/ref/mod#go-mod-vendor) |
### `versioning-strategy` ### `versioning-strategy`

View File

@@ -87,7 +87,7 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
$ sudo apt-get install xclip $ sudo apt-get install xclip
# Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`) # Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`)
$ xclip -sel clip &lt; ~/.ssh/id_rsa.pub $ xclip -selection clipboard &lt; ~/.ssh/id_rsa.pub
# Copies the contents of the id_rsa.pub file to your clipboard # Copies the contents of the id_rsa.pub file to your clipboard
``` ```
{% tip %} {% tip %}

View File

@@ -29,7 +29,7 @@ versions:
```shell ```shell
$ gpg --default-new-key-algo rsa4096 --gen-key $ gpg --default-new-key-algo rsa4096 --gen-key
``` ```
4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default `RSA and DSA`. 4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default `RSA and RSA`.
5. Enter the desired key size. Your key must be at least `4096` bits. 5. Enter the desired key size. Your key must be at least `4096` bits.
6. Enter the length of time the key should be valid. Press `Enter` to specify the default selection, indicating that the key doesn't expire. 6. Enter the length of time the key should be valid. Press `Enter` to specify the default selection, indicating that the key doesn't expire.
7. Verify that your selections are correct. 7. Verify that your selections are correct.

View File

@@ -134,7 +134,7 @@ To illustrate how `git filter-branch` works, we'll show you how to remove your f
{% endnote %} {% endnote %}
## Avoiding accidental commits in the future ### Avoiding accidental commits in the future
There are a few simple tricks to avoid committing things you don't want committed: There are a few simple tricks to avoid committing things you don't want committed:
@@ -145,5 +145,5 @@ There are a few simple tricks to avoid committing things you don't want committe
### Further reading ### Further reading
- [`git filter-branch` main page](https://git-scm.com/docs/git-filter-branch) - [`git filter-branch` man page](https://git-scm.com/docs/git-filter-branch)
- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History) - [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History)

View File

@@ -44,7 +44,7 @@ You cannot create a default license file. License files must be added to individ
![Owner drop-down menu](/assets/images/help/repository/create-repository-owner.png) ![Owner drop-down menu](/assets/images/help/repository/create-repository-owner.png)
3. Type **.github** as the name for your repository, and an optional description. 3. Type **.github** as the name for your repository, and an optional description.
![Create repository field](/assets/images/help/repository/default-file-repository-name.png) ![Create repository field](/assets/images/help/repository/default-file-repository-name.png)
4. Choose to make the repository public. 4. Make sure the repository status is set to **Public** (a repository for default files cannot be private).
![Radio buttons to select private or public status](/assets/images/help/repository/create-repository-public-private.png) ![Radio buttons to select private or public status](/assets/images/help/repository/create-repository-public-private.png)
{% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.initialize-with-readme %}
{% data reusables.repositories.create-repo %} {% data reusables.repositories.create-repo %}

View File

@@ -23,7 +23,7 @@ You can unblock a user in your account settings or from the user's profile page.
### Unblocking a user from their profile page ### Unblocking a user from their profile page
{% data reusables.profile.user_profile_page_navigation %} {% data reusables.profile.user_profile_page_navigation %}
2. In the left sidebar, under the user's profile picture, click **Unblock or report user**. 2. In the left sidebar, under the user's profile picture, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Unblock or report user**.
![Unblock or report user link](/assets/images/help/profile/profile-unblock-or-report-user.png) ![Unblock or report user link](/assets/images/help/profile/profile-unblock-or-report-user.png)
3. Click **Unblock user**. 3. Click **Unblock user**.
![Modal box with option to unblock user or report abuse](/assets/images/help/profile/profile-unblockuser.png) ![Modal box with option to unblock user or report abuse](/assets/images/help/profile/profile-unblockuser.png)

View File

@@ -53,6 +53,13 @@ When you create a pull request, you can choose to create a pull request that is
{% data reusables.pull_requests.mark-ready-review %} You can convert a pull request to a draft at any time. For more information, see "[Changing the stage of a pull request](/articles/changing-the-stage-of-a-pull-request)." {% data reusables.pull_requests.mark-ready-review %} You can convert a pull request to a draft at any time. For more information, see "[Changing the stage of a pull request](/articles/changing-the-stage-of-a-pull-request)."
### Differences between commits on compare and pull request pages
The compare and pull request pages use different methods to calculate the diff for changed files:
- Compare pages show the diff between the tip of the head ref and the current common ancestor (that is, the merge base) of the head and base ref.
- Pull request pages show the diff between the tip of the head ref and the common ancestor of the head and base ref at the time when the pull request was created. Consequently, the merge base used for the comparison might be different.
### Further reading ### Further reading
- "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary - "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary

View File

@@ -20,6 +20,12 @@ versions:
4. In the base branch drop-down menu, select the base branch you'd like to [compare changes against](/github/committing-changes-to-your-project/comparing-commits#comparing-branches). ![Base branch drop-down menu ](/assets/images/help/pull_requests/pull-request-edit-base-branch.png) 4. In the base branch drop-down menu, select the base branch you'd like to [compare changes against](/github/committing-changes-to-your-project/comparing-commits#comparing-branches). ![Base branch drop-down menu ](/assets/images/help/pull_requests/pull-request-edit-base-branch.png)
5. Read the information about changing the base branch and click **Change base**. ![Base branch change confirmation button ](/assets/images/help/pull_requests/pull-request-base-branch-confirm.png) 5. Read the information about changing the base branch and click **Change base**. ![Base branch change confirmation button ](/assets/images/help/pull_requests/pull-request-base-branch-confirm.png)
{% tip %}
**Tip:** When you open a pull request, {% data variables.product.product_name %} will set the base to the commit that branch references. If the branch is updated in the future, {% data variables.product.product_name %} will not update the base branch's commit.
{% endtip %}
### Further reading ### Further reading
- "[Creating a pull request](/articles/creating-a-pull-request)" - "[Creating a pull request](/articles/creating-a-pull-request)"

View File

@@ -78,7 +78,8 @@ docs/* docs@example.com
apps/ @octocat apps/ @octocat
# In this example, @doctocat owns any file in the `/docs` # In this example, @doctocat owns any file in the `/docs`
# directory in the root of your repository. # directory in the root of your repository and any of its
# subdirectories.
/docs/ @doctocat /docs/ @doctocat
``` ```

View File

@@ -1,6 +1,7 @@
--- ---
title: Creating a template repository title: Creating a template repository
intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}, branches,{% endif %} and files.' intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}, branches,{% endif %} and files.'
permissions: 'Anyone with admin permissions to a repository can make the repository a template.'
redirect_from: redirect_from:
- /articles/creating-a-template-repository - /articles/creating-a-template-repository
versions: versions:
@@ -8,7 +9,11 @@ versions:
enterprise-server: '*' enterprise-server: '*'
--- ---
Anyone with admin permissions to a repository can make the repository a template. {% note %}
**Note**: Your template repository cannot include files stored using {% data variables.large_files.product_name_short %}.
{% endnote %}
To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)." To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)."
@@ -16,5 +21,5 @@ After you make your repository a template, anyone with access to the repository
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.sidebar-settings %}
3. Select **Template repository**. 1. Select **Template repository**.
![Checkbox to make a repository a template](/assets/images/help/repository/template-repository-checkbox.png) ![Checkbox to make a repository a template](/assets/images/help/repository/template-repository-checkbox.png)

View File

@@ -10,7 +10,7 @@ versions:
### Editor tools ### Editor tools
To streamline your workflow, you can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and Visual Studio. You can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and Visual Studio.
#### {% data variables.product.product_name %} for Atom #### {% data variables.product.product_name %} for Atom
@@ -30,8 +30,12 @@ With the {% data variables.product.prodname_dotcom %} for Visual Studio Code ext
### Project management tools ### Project management tools
To streamline your workflow, you can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira. You can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira or Slack.
#### Jira Cloud and {% data variables.product.product_name %}.com integration #### Jira Cloud and {% data variables.product.product_name %}.com integration
You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace.
#### Slack and {% data variables.product.product_name %} integration
You can integrate Slack with your personal or organization account to subscribe for notifications, close or open issues, and provide rich references to issues and pull requests without leaving Slack. For more information, visit the [Slack integration app](https://github.com/marketplace/slack-github) in the marketplace.

Some files were not shown because too many files have changed in this diff Show More