diff --git a/.github/ISSUE_COMMENT_TEMPLATE/quick-status.yml b/.github/ISSUE_COMMENT_TEMPLATE/quick-status.yml index 8dd47930aa..ad29b79ce3 100644 --- a/.github/ISSUE_COMMENT_TEMPLATE/quick-status.yml +++ b/.github/ISSUE_COMMENT_TEMPLATE/quick-status.yml @@ -14,6 +14,8 @@ body: value: 'Status: YELLOW' - label: "RED \U0001F534 (BLOCKED)" value: 'Status: RED' + - label: "BLACK ⚫️ (We shipped it \U0001F389)" + value: 'Status: BLACK' - type: textarea attributes: label: Update Summary diff --git a/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md b/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md index a5af78515c..9f5120f6e2 100644 --- a/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md +++ b/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md @@ -34,12 +34,6 @@ ``` ☝️ This will run a workflow **on every push to the PR** that will sync **only** the English index for the new version to Algolia. This will make the GHES content searchable on staging throughout content creation, and will ensure the search updates go live at the same time the content is published. See [`contributing/search.md`](https://github.com/github/docs-internal/blob/main/contributing/search.md) for details. -- [ ] Create an OpenAPI topic branch - - This branch is used to avoid propagating the OpenAPI dev mode check CI test failure in all of the branches. All changes that affect the OpenAPI schema should branch off of this topic branch. The tests should all be passing before the OpenAPI topic branch is merged into the megabranch. - - For more information about how OpenAPI changes are published to docs.github.com, see [Publishing REST API changes to docs.github.com](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/publishing-documentation/publishing-REST-api-docs.md#publishing-rest-api-changes-to-docsgithubcom). - - [ ] In `github/github`, to create a new GHES release follow these steps: - [ ] Copy the previous release's root document to a new root document for this release `cp app/api/description/ghes-.yaml app/api/description/ghes-.yaml`. - [ ] Update the `externalDocs.url` property in that file to use the new GHES release number. @@ -47,6 +41,14 @@ - [ ] Update the `variables.externalDocsUrl`, `variables.ghesVersion`, and `patch.[].value.url` in that file to use the new GHES release number. - [ ] Update `published` in that file to `false`. **Note:** This is important to ensure that 3.1 OpenAPI changes are not made public until 3.1 is released. +#### Troubleshooting + +If the `OpenAPI dev mode check / check-schema-versions` check fails on the release branch, in your local checkout of the mega branch: + +- run `git checkout origin/main lib/rest/static/*` +- run `script/rest/update-files.js --decorate-only` +- push the resulting changes + ### Before shipping the release branch - [ ] Add the GHES release notes to `data/release-notes/` and update the versioning frontmatter in `content/admin/release-notes.md` to `enterprise-server: '<='` diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index 23a12cebbe..e8cce1d06d 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -4,13 +4,13 @@ // can be added it this list. module.exports = [ - "actions/cache@0781355a23dac32fd3bac414512f4b903437991a", //actions/cache@v2.1.3 - "actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f", //actions/checkout@v2.3.4 - "actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9", //actions/script@v3.0.0 - "actions/labeler@5f867a63be70efff62b767459b009290364495eb", //actions/labeler@v2.2.0 - "actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", //actions/setup-node@v2.1.4 - "ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/setup-ruby@vv1.64.1 - "actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", //actions/stale@v3.0.16 + "actions/cache@0781355a23dac32fd3bac414512f4b903437991a", // v2.1.3 + "actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f", // v2.3.4 + "actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9", // v3.0.0 + "actions/labeler@5f867a63be70efff62b767459b009290364495eb", // v2.2.0 + "actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", // v2.1.4 + "ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", // v1.64.1 + "actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", // v3.0.16 "alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9", "andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84", "archive/github-actions-slack@d368c5a4ad757515a9344918f84c490b05777d94", @@ -20,14 +20,14 @@ module.exports = [ "cschleiden/actions-linter@0ff16d6ac5103cca6c92e6cbc922b646baaea5be", "dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911", "docker://chinthakagodawita/autoupdate-action:v1", - "fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289", "github/codeql-action/analyze@v1", "github/codeql-action/init@v1", "juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8", - "juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9", + "juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51", // v1.5.0 "juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512", "lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8", - "pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0 + "lee-dohm/no-response@9bb0a4b5e6a45046f00353d5de7d90fb8bd773bb", + "pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", // v0.12.0 "peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326", "peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd", "peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43", diff --git a/.github/workflows/browser-test.yml b/.github/workflows/browser-test.yml index 53a74e6259..79dff097b1 100644 --- a/.github/workflows/browser-test.yml +++ b/.github/workflows/browser-test.yml @@ -12,44 +12,26 @@ on: pull_request: 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: - needs: see_if_should_skip runs-on: ubuntu-latest steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Checkout + - name: Checkout uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Setup Node + - name: Setup Node uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e with: node-version: 14.x - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Install + - name: Install uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e timeout-minutes: 5 with: args: npm ci - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Test + - name: Test timeout-minutes: 10 uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e with: diff --git a/.github/workflows/close-external-repo-sync-prs.yml b/.github/workflows/close-external-repo-sync-prs.yml deleted file mode 100644 index 40f95738a4..0000000000 --- a/.github/workflows/close-external-repo-sync-prs.yml +++ /dev/null @@ -1,65 +0,0 @@ -name: Check for External Repo Sync PR - -# **What it does**: If someone made a repo sync pull request other than Octomerger, close it. -# **Why we have it**: Another form of spam in the open-source repository. -# **Who does it impact**: Open-source contributors. - -on: - pull_request: - types: - - opened - - reopened - branches: - - main - -jobs: - invalid-repo-sync-check: - name: Close external Repo Sync PRs - if: ${{ github.repository == 'github/docs' && github.head_ref == 'repo-sync' }} - runs-on: ubuntu-latest - steps: - - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - with: - github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} - script: | - - const prCreator = context.payload.sender.login - - // If the PR creator is the expected account, stop now - if (prCreator === 'Octomerger') { - return - } - - try { - await github.teams.getMembershipForUserInOrg({ - org: 'github', - team_slug: 'employees', - username: prCreator - }) - - // If the PR creator is a GitHub employee, stop now - return - } catch (err) { - // An error will be thrown if the user is not a GitHub employee. - // That said, we still want to proceed anyway! - } - - const pr = context.payload.pull_request - const { owner, repo } = context.repo - - // Close the PR and add the invalid label - await github.issues.update({ - owner: owner, - repo: repo, - issue_number: pr.number, - labels: ['invalid'], - state: 'closed' - }) - - // Comment on the PR - await github.issues.createComment({ - owner: owner, - repo: repo, - issue_number: pr.number, - body: "Please leave this `repo-sync` branch to the robots!\n\nI'm going to close this pull request now, but feel free to open a new issue or ask any questions in [discussions](https://github.com/github/docs/discussions)!" - }) diff --git a/.github/workflows/confirm-internal-staff-work-in-docs.yml b/.github/workflows/confirm-internal-staff-work-in-docs.yml index 60dc9fa9bc..6edcebf2e2 100644 --- a/.github/workflows/confirm-internal-staff-work-in-docs.yml +++ b/.github/workflows/confirm-internal-staff-work-in-docs.yml @@ -17,7 +17,7 @@ jobs: check-team-membership: runs-on: ubuntu-latest continue-on-error: true - if: github.repository == 'github/docs' + if: github.repository == 'github/docs' && github.actor != 'docs-bot' steps: - id: membership_check uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 diff --git a/.github/workflows/link-check-dotcom.yml b/.github/workflows/link-check-dotcom.yml index 399655cf86..bb9f024ab1 100644 --- a/.github/workflows/link-check-dotcom.yml +++ b/.github/workflows/link-check-dotcom.yml @@ -12,53 +12,26 @@ on: pull_request: 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/link-check-dotcom.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: - needs: see_if_should_skip runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Checkout + - name: Checkout uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Setup node + - name: Setup node uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e with: node-version: 14.x - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Install + - name: Install run: npm ci - ## TODO - # - if: ${{ github.repository == 'github/docs-internal' && needs.see_if_should_skip.outputs.should_skip != 'true' }} - # name: Clone early access - # run: npm run heroku-postbuild - # env: - # DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} - # GIT_BRANCH: ${{ github.head_ref || github.ref }} - - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Build + - name: Build run: npm run build - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: 'Link check: Dotcom' + - name: 'Link check: Dotcom' env: DOCS_VERSION: 'dotcom' run: npm run link-check diff --git a/.github/workflows/link-check-ghae.yml b/.github/workflows/link-check-ghae.yml index e5dd16853b..3f466eae5d 100644 --- a/.github/workflows/link-check-ghae.yml +++ b/.github/workflows/link-check-ghae.yml @@ -12,53 +12,26 @@ on: pull_request: 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/link-check-ghae.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: - needs: see_if_should_skip runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Checkout + - name: Checkout uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Setup node + - name: Setup node uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e with: node-version: 14.x - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Install + - name: Install run: npm ci - ## TODO - # - if: ${{ github.repository == 'github/docs-internal' && needs.see_if_should_skip.outputs.should_skip != 'true' }} - # name: Clone early access - # run: npm run heroku-postbuild - # env: - # DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} - # GIT_BRANCH: ${{ github.head_ref || github.ref }} - - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Build + - name: Build run: npm run build - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: 'Link check: GitHub AE' + - name: 'Link check: GitHub AE' env: DOCS_VERSION: 'github-ae' run: npm run link-check diff --git a/.github/workflows/link-check-ghes.yml b/.github/workflows/link-check-ghes.yml index 4371f129fb..f26b9cfbe6 100644 --- a/.github/workflows/link-check-ghes.yml +++ b/.github/workflows/link-check-ghes.yml @@ -12,53 +12,26 @@ on: pull_request: 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/link-check-ghes.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: - needs: see_if_should_skip runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Checkout + - name: Checkout uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Setup node + - name: Setup node uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e with: node-version: 14.x - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Install + - name: Install run: npm ci - ## TODO - # - if: ${{ github.repository == 'github/docs-internal' && needs.see_if_should_skip.outputs.should_skip != 'true' }} - # name: Clone early access - # run: npm run heroku-postbuild - # env: - # DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} - # GIT_BRANCH: ${{ github.head_ref || github.ref }} - - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Build + - name: Build run: npm run build - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: 'Link check: Enterprise Server' + - name: 'Link check: Enterprise Server' env: DOCS_VERSION: 'enterprise-server' run: npm run link-check diff --git a/.github/workflows/move-reopened-issues-to-triage.yaml b/.github/workflows/move-reopened-issues-to-triage.yaml new file mode 100644 index 0000000000..415c97d8c8 --- /dev/null +++ b/.github/workflows/move-reopened-issues-to-triage.yaml @@ -0,0 +1,41 @@ +name: Move Reopened Issues to Triage + +# **What it does**: Moves issues that are reopened from the Done column to the Triage column. +# **Why we have it**: To prevent having to do this manually. +# **Who does it impact**: Open-source. + +on: + issues: + types: + - reopened + +jobs: + move-reopened-issue-to-triage: + if: github.repository == 'github/docs' + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ github.token }} + script: | + const issueNumber = context.issue.number; + const doneColumnId = 11167427; + const triageColumnId = 11007039; + + try { + const cards = await github.projects.listCards({ + column_id: doneColumnId + }); + + for (const card of cards) { + if (card.content_url.endsWith(`/${issueNumber}`)) { + await github.projects.moveCard({ + card_id: card.id, + position: 'position', + column_id: triageColumnId + }); + } + } + } catch(e) { + console.log(error); + } diff --git a/.github/workflows/no-response.yaml b/.github/workflows/no-response.yaml new file mode 100644 index 0000000000..59a5b8beef --- /dev/null +++ b/.github/workflows/no-response.yaml @@ -0,0 +1,32 @@ +name: No Response + +# **What it does**: Closes issues that don't have enough information to be +# actionable. +# **Why we have it**: To remove the need for maintainers to remember to check +# back on issues periodically to see if contributors have +# responded. +# **Who does it impact**: Everyone that works on docs or docs-internal. + +on: + issue_comment: + types: [created] + + schedule: + # Schedule for five minutes after the hour every hour + - cron: '5 * * * *' + +jobs: + noResponse: + runs-on: ubuntu-latest + steps: + - uses: lee-dohm/no-response@9bb0a4b5e6a45046f00353d5de7d90fb8bd773bb + with: + token: ${{ github.token }} + closeComment: > + This issue has been automatically closed because there has been no response + to our request for more information from the original author. With only the + information that is currently in the issue, we don't have enough information + to take action. Please reach out if you have or find the answers we need so + that we can investigate further. See [this blog post on bug reports and the + importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/) + for more information about the kind of information that may be helpful. diff --git a/.github/workflows/open-enterprise-issue.yml b/.github/workflows/open-enterprise-issue.yml index 4ec44ba564..5dfb0850cf 100644 --- a/.github/workflows/open-enterprise-issue.yml +++ b/.github/workflows/open-enterprise-issue.yml @@ -1,5 +1,9 @@ name: Open Enterprise release or deprecation issue +# **What it does**: Checks if there is an Enterprise release or deprecation upcoming, and if so, opens an issue with the tasks to be completed. +# **Why we have it**: GHES releases and deprecations run on a predictable schedule, so we can automate some of the project management aspects. +# **Who does it impact**: Docs engineering, docs content. + on: schedule: - cron: '49 14 * * *' # At 14:49 UTC daily diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index 7bb8872f5e..851e7d9161 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -1,13 +1,18 @@ # The docs.github.com project has two repositories: github/docs (public) and github/docs-internal (private) # -# This GitHub Actions workflow keeps the main branch of those two repos in sync. +# This GitHub Actions workflow keeps the `main` branch of those two repos in sync. # # For more details, see https://github.com/repo-sync/repo-sync#how-it-works name: Repo Sync -# **What it does**: Syncs docs and docs-internal. -# **Why we have it**: To keep the open-source repository up-to-date, while still having an internal repository for sensitive work. +# **What it does**: +# - close-invalid-repo-sync: Close repo sync pull requests not created by Octomerger or a Hubber. +# - repo-sync: Syncs docs and docs-internal. +# **Why we have it**: +# - close-invalid-repo-sync: Another form of spam prevention for the open-source repository. +# - repo-sync: To keep the open-source repository up-to-date, while still having an internal +# repository for sensitive work. # **Who does it impact**: Open-source. on: @@ -16,7 +21,74 @@ on: - cron: '*/15 * * * *' # every 15 minutes jobs: + close-invalid-repo-sync: + name: Close invalid Repo Sync PRs + runs-on: ubuntu-latest + steps: + - name: Find pull request + if: ${{ github.repository == 'github/docs' }} + uses: juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51 + id: find-pull-request + with: + github-token: ${{ secrets.DOCS_BOT_SPAM_VISION }} + branch: repo-sync + base: main + state: open + + - name: Close pull request if unwanted + if: ${{ github.repository == 'github/docs' && steps.find-pull-request.outputs.number }} + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCS_BOT_SPAM_VISION }} + script: | + const { owner, repo } = context.repo + + const { data: pr } = await github.pulls.get({ + owner, + repo, + pull_number: parseInt(${{ steps.find-pull-request.outputs.number }}) + }) + + const prCreator = pr.user.login + + // If the PR creator is the expected account, stop now + if (prCreator === 'Octomerger') { + return + } + + try { + await github.teams.getMembershipForUserInOrg({ + org: 'github', + team_slug: 'employees', + username: prCreator + }) + + // If the PR creator is a GitHub employee, stop now + return + } catch (err) { + // An error will be thrown if the user is not a GitHub employee. + // That said, we still want to proceed anyway! + } + + // Close the PR and add the invalid label + await github.issues.update({ + owner, + repo, + issue_number: pr.number, + labels: ['invalid'], + state: 'closed' + }) + + // Comment on the PR + await github.issues.createComment({ + owner, + repo, + issue_number: pr.number, + body: "Please leave this `repo-sync` branch to the robots!\n\nI'm going to close this pull request now, but feel free to open a new issue or ask any questions in [discussions](https://github.com/github/docs/discussions)!" + }) + repo-sync: + needs: close-invalid-repo-sync if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' name: Repo Sync runs-on: ubuntu-latest @@ -44,17 +116,18 @@ jobs: destination_branch: main pr_title: 'repo sync' pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!" - pr_label: automerge,autoupdate,automated-reposync-pr + pr_label: autoupdate,automated-reposync-pr github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - name: Find pull request - uses: juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9 + uses: juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51 id: find-pull-request with: github-token: ${{ secrets.GITHUB_TOKEN }} branch: repo-sync base: main author: Octomerger + state: open - name: Approve pull request if: ${{ steps.find-pull-request.outputs.number }} @@ -68,7 +141,7 @@ jobs: if: ${{ steps.find-pull-request.outputs.number }} uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 with: - github-token: ${{ secrets.GITHUB_TOKEN }} + github-token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} script: | const mainHeadSha = await github.git.getRef({ ...context.repo, @@ -92,6 +165,41 @@ jobs: console.log(`Branch is already up-to-date`) } + - name: Enable GitHub auto-merge + if: ${{ steps.find-pull-request.outputs.number }} + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} + script: | + const pull = await github.pulls.get({ + ...context.repo, + pull_number: parseInt(${{ steps.find-pull-request.outputs.number }}) + }) + + const pullNodeId = pull.data.node_id + console.log(`Pull request GraphQL Node ID: ${pullNodeId}`) + + const mutation = `mutation ($id: ID!) { + enablePullRequestAutoMerge(input: { + pullRequestId: $id, + mergeMethod: MERGE + }) { + clientMutationId + } + }` + const variables = { + id: pullNodeId + } + + const graph = await github.graphql(mutation, variables) + console.log('GraphQL mutation result:\n' + JSON.stringify(graph)) + + if (graph.errors && graph.errors.length > 0) { + console.error('ERROR! Failed to enable auto-merge:\n - ' + graph.errors.map(error => error.message).join('\n - ')) + } else { + console.log('Auto-merge enabled!') + } + - name: Send Slack notification if workflow fails uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd if: failure() diff --git a/.github/workflows/send-crowdin-prs-to-boards.yml b/.github/workflows/send-crowdin-prs-to-boards.yml index 568868b7c4..7d016122d1 100644 --- a/.github/workflows/send-crowdin-prs-to-boards.yml +++ b/.github/workflows/send-crowdin-prs-to-boards.yml @@ -1,5 +1,9 @@ name: Send Crowdin PRs to boards +# **What it does**: Sends PRs opened on the crowdin branch to the ready for work column in this board: https://github.com/orgs/github/projects/1269#column-13447153 +# **Why we have it**: To make sure the first responder sees crowdin translations that need to be merged as they review the Task board. +# **Who does it impact**: Docs localization and Docs Engineering + on: pull_request: types: @@ -14,7 +18,7 @@ jobs: with: github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} script: | - var squadBoardColumnId = 13447153; // Add to the team backlog/squad board + var squadBoardColumnId = 13447153; // Add to the team task board try { await github.projects.createCard({ @@ -25,14 +29,3 @@ jobs: } catch (error) { console.log(error); } - - var prBoardColumnId = 10095775; // Add to the pull requests board - try { - await github.projects.createCard({ - column_id: prBoardColumnId, - content_id: context.payload.pull_request.id, - content_type: "PullRequest" - }); - } catch (error) { - console.log(error); - } diff --git a/.github/workflows/send-issues-to-how-how-we-work-boards.yml b/.github/workflows/send-issues-to-how-how-we-work-boards.yml index 7b8b794b06..a6b831091c 100644 --- a/.github/workflows/send-issues-to-how-how-we-work-boards.yml +++ b/.github/workflows/send-issues-to-how-how-we-work-boards.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest continue-on-error: true steps: - - if: contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic') + - if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic') uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 with: github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} @@ -31,7 +31,7 @@ jobs: } catch (error) { console.log(error); } - - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature') + - if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature') uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 with: github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} @@ -46,7 +46,7 @@ jobs: } catch (error) { console.log(error); } - - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic') + - if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic') uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 with: github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} diff --git a/.github/workflows/send-prs-to-how-how-we-work-boards.yml b/.github/workflows/send-prs-to-how-how-we-work-boards.yml index 88e8d35b92..44e5e8d1a3 100644 --- a/.github/workflows/send-prs-to-how-how-we-work-boards.yml +++ b/.github/workflows/send-prs-to-how-how-we-work-boards.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest continue-on-error: true steps: - - if: (github.repository == 'github/docs-internal' || github.repository == 'github/docs') && contains(github.event.pull_request.labels.*.name, 'feature') + - if: (github.repository == 'github/docs-internal') && contains(github.event.pull_request.labels.*.name, 'feature') uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 with: github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} @@ -35,11 +35,15 @@ jobs: var column_id = 13445681; try { - github.projects.createCard({ + await github.projects.createCard({ column_id: column_id, content_id: context.payload.pull_request.id, content_type: "PullRequest" }); } catch (error) { - console.log(error); + if (error.includes('Project already has the associated issue')) { + return + } else { + console.log(error); + } } diff --git a/.github/workflows/site-policy-sync.yml b/.github/workflows/site-policy-sync.yml index e1a3a1d7b9..12bb02ffbf 100644 --- a/.github/workflows/site-policy-sync.yml +++ b/.github/workflows/site-policy-sync.yml @@ -1,8 +1,8 @@ name: site-policy-sync -# **What it does**: Updates our site policy docs when changes happen to site policy. -# **Why we have it**: We want up to date site policy docs. -# **Who does it impact**: Site policy team. +# **What it does**: Updates our site-policy repo when changes happen to site policy docs. +# **Why we have it**: We want keep site-policy repo up to date. +# **Who does it impact**: Site-policy team. # Controls when the action will run. on: @@ -30,6 +30,10 @@ jobs: steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + # Sets commit message + - name: custom message + run: | + echo "MESSAGE=${{github.event.pull_request.title}}" >> $GITHUB_ENV # Pushes to other repo - name: Push folder to another repository @@ -42,6 +46,6 @@ jobs: destination_branch: 'main' destination_branch_create: 'repo-sync' destination_folder: 'Policies' - user_email: 'pcihon@users.noreply.github.com' - user_name: 'pcihon' - commit_msg: 'Automatic sync from GitHub Docs.' + user_email: 'site-policy-bot@users.noreply.github.com' + user_name: 'site-policy-bot' + commit_msg: '${{ env.MESSAGE }}' diff --git a/.github/workflows/sync-single-english-algolia-index.yml b/.github/workflows/sync-single-english-algolia-index.yml index ebfe40eeed..790e218c4a 100644 --- a/.github/workflows/sync-single-english-algolia-index.yml +++ b/.github/workflows/sync-single-english-algolia-index.yml @@ -47,4 +47,6 @@ jobs: ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: npm run sync-search + run: | + npm run build + npm run sync-search diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index beb039ae6c..6a800b42ec 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -17,22 +17,7 @@ env: CI: true 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"]' - test: - needs: see_if_should_skip # Run on self-hosted if the private repo or ubuntu-latest if the public repo # See pull # 17442 in the private repo for context runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} @@ -44,27 +29,23 @@ jobs: steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Check out repo + - name: Check out repo uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f with: # Enables cloning the Early Access repo later with the relevant PAT persist-credentials: 'false' - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Setup node + - name: Setup node uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e with: node-version: 14.x - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Get npm cache directory + - name: Get npm cache directory id: npm-cache run: | echo "::set-output name=dir::$(npm config get cache)" - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Cache node modules + - name: Cache node modules uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a with: path: ${{ steps.npm-cache.outputs.dir }} @@ -72,23 +53,21 @@ jobs: restore-keys: | ${{ runner.os }}-node- - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Install dependencies + - name: Install dependencies run: npm ci - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository == 'github/docs-internal' }} + - if: ${{ github.repository == 'github/docs-internal' }} name: Clone early access run: npm run heroku-postbuild env: DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }} GIT_BRANCH: ${{ github.head_ref || github.ref }} - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository != 'github/docs-internal' }} + - if: ${{ github.repository != 'github/docs-internal' }} name: Run build script run: npm run build - - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} - name: Run tests + - name: Run tests run: npx jest tests/${{ matrix.test-group }}/ env: NODE_OPTIONS: '--max_old_space_size=4096' diff --git a/.github/workflows/translations.yml b/.github/workflows/translations.yml index b17ee503bf..9ed82ba41f 100644 --- a/.github/workflows/translations.yml +++ b/.github/workflows/translations.yml @@ -21,13 +21,14 @@ jobs: echo 'The repo is currently frozen! Exiting this workflow.' exit 1 # prevents further steps from running - name: Find original Pull Request - uses: juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9 + uses: juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51 id: pr with: github-token: ${{ secrets.GITHUB_TOKEN }} branch: translations base: main author: octoglot + state: open - if: ${{ steps.pr.outputs.number }} name: Check if already labeled uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 diff --git a/.pa11yci b/.pa11yci index d037f96c79..0c0c506c8a 100644 --- a/.pa11yci +++ b/.pa11yci @@ -59,7 +59,7 @@ "http://localhost:4001/en/packages", "http://localhost:4001/en/actions/configuring-and-managing-workflows/configuring-a-workflow", "http://localhost:4001/en/github/authenticating-to-github/managing-commit-signature-verification", - "http://localhost:4001/en/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions", + "http://localhost:4001/en/organizations/restricting-access-to-your-organizations-data/about-oauth-app-access-restrictions", "http://localhost:4001/en/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line", "http://localhost:4001/en/github/getting-started-with-github/access-permissions-on-github", "http://localhost:4001/en/github/getting-started-with-github/githubs-products", diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36f523c053..20fa5bdae0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Before you begin: ### Use the 'make a contribution' button -![](./assets/images/make-contribution.gif) + Navigating a new codebase can be challenging, so we're making that a little easier. As you're using docs.github.com, you may come across an article that you want to make an update to. You can click on the **make a contribution** button right on that article, which will take you to the file in this repo where you'll make your changes. @@ -19,6 +19,8 @@ Before you make your changes, check to see if an [issue exists](https://github.c If you spot something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. +**Note:** We cannot accept contributions to the [REST API reference documentation](https://docs.github.com/en/rest/reference). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [github/rest-api-description](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository. + ### Ready to make a change? Fork the repo Fork using GitHub Desktop: diff --git a/Dockerfile.openapi_decorator b/Dockerfile.openapi_decorator new file mode 100644 index 0000000000..a0e5a0c2e0 --- /dev/null +++ b/Dockerfile.openapi_decorator @@ -0,0 +1,19 @@ +FROM node:14-alpine + +RUN apk add --no-cache git python make g++ + +WORKDIR /openapi-check + +RUN chown node:node /openapi-check -R + +USER node + +COPY --chown=node:node package.json /openapi-check +COPY --chown=node:node package-lock.json /openapi-check +ADD --chown=node:node script /openapi-check/script +ADD --chown=node:node lib /openapi-check/lib +ADD --chown=node:node content /openapi-check/content + +RUN npm ci -D + +ENTRYPOINT ["node", "/openapi-check/script/rest/openapi-check.js"] diff --git a/Procfile b/Procfile index 6d92caa7fb..831822afef 100644 --- a/Procfile +++ b/Procfile @@ -1,3 +1,3 @@ web: NODE_ENV=production node server.js -release: NODE_ENV=production node script/purge-redis-pages.js +release: NODE_ENV=production script/release-heroku diff --git a/assets/images/enterprise/3.0/dependabot-alert-dismiss.png b/assets/images/enterprise/3.0/dependabot-alert-dismiss.png new file mode 100644 index 0000000000..81e8a60b62 Binary files /dev/null and b/assets/images/enterprise/3.0/dependabot-alert-dismiss.png differ diff --git a/assets/images/enterprise/3.0/dependabot-alert-info.png b/assets/images/enterprise/3.0/dependabot-alert-info.png new file mode 100644 index 0000000000..26982a4c28 Binary files /dev/null and b/assets/images/enterprise/3.0/dependabot-alert-info.png differ diff --git a/assets/images/enterprise/graphs/click-alert-in-alerts-list.png b/assets/images/enterprise/graphs/click-alert-in-alerts-list.png new file mode 100644 index 0000000000..b61ec2957d Binary files /dev/null and b/assets/images/enterprise/graphs/click-alert-in-alerts-list.png differ diff --git a/assets/images/enterprise/orgs-and-teams/edit-organization-settings.png b/assets/images/enterprise/orgs-and-teams/edit-organization-settings.png new file mode 100644 index 0000000000..8de8cc1898 Binary files /dev/null and b/assets/images/enterprise/orgs-and-teams/edit-organization-settings.png differ diff --git a/assets/images/enterprise/orgs-and-teams/jira/jira-applications.png b/assets/images/enterprise/orgs-and-teams/jira/jira-applications.png new file mode 100644 index 0000000000..3286309f18 Binary files /dev/null and b/assets/images/enterprise/orgs-and-teams/jira/jira-applications.png differ diff --git a/assets/images/enterprise/orgs-and-teams/jira/jira-integrations-dvcs.png b/assets/images/enterprise/orgs-and-teams/jira/jira-integrations-dvcs.png new file mode 100644 index 0000000000..b2f97f6461 Binary files /dev/null and b/assets/images/enterprise/orgs-and-teams/jira/jira-integrations-dvcs.png differ diff --git a/assets/images/enterprise/orgs-and-teams/jira/jira-link-github-account.png b/assets/images/enterprise/orgs-and-teams/jira/jira-link-github-account.png new file mode 100644 index 0000000000..e90ccfb025 Binary files /dev/null and b/assets/images/enterprise/orgs-and-teams/jira/jira-link-github-account.png differ diff --git a/assets/images/enterprise/orgs-and-teams/organization-dev-settings-oauth-apps.png b/assets/images/enterprise/orgs-and-teams/organization-dev-settings-oauth-apps.png new file mode 100644 index 0000000000..c57c6002ee Binary files /dev/null and b/assets/images/enterprise/orgs-and-teams/organization-dev-settings-oauth-apps.png differ diff --git a/assets/images/enterprise/orgs-and-teams/profile-select-organization.png b/assets/images/enterprise/orgs-and-teams/profile-select-organization.png new file mode 100644 index 0000000000..ba776a2f59 Binary files /dev/null and b/assets/images/enterprise/orgs-and-teams/profile-select-organization.png differ diff --git a/assets/images/enterprise/orgs-and-teams/register-oauth-application-button.png b/assets/images/enterprise/orgs-and-teams/register-oauth-application-button.png new file mode 100644 index 0000000000..9cf59d03dd Binary files /dev/null and b/assets/images/enterprise/orgs-and-teams/register-oauth-application-button.png differ diff --git a/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png b/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png new file mode 100644 index 0000000000..a768d4c9a8 Binary files /dev/null and b/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png differ diff --git a/assets/images/enterprise/repository/dependabot-alerts-tab.png b/assets/images/enterprise/repository/dependabot-alerts-tab.png new file mode 100644 index 0000000000..ad40ef54cc Binary files /dev/null and b/assets/images/enterprise/repository/dependabot-alerts-tab.png differ diff --git a/assets/images/help/billing/confirm-sponsorship-cancellation.png b/assets/images/help/billing/confirm-sponsorship-cancellation.png index d8123dc2ac..0ae527d924 100644 Binary files a/assets/images/help/billing/confirm-sponsorship-cancellation.png and b/assets/images/help/billing/confirm-sponsorship-cancellation.png differ diff --git a/assets/images/help/codespaces/add-port-button.png b/assets/images/help/codespaces/add-port-button.png new file mode 100644 index 0000000000..b1cb290faf Binary files /dev/null and b/assets/images/help/codespaces/add-port-button.png differ diff --git a/assets/images/help/codespaces/add-prebuilt-container-command.png b/assets/images/help/codespaces/add-prebuilt-container-command.png new file mode 100644 index 0000000000..c4027cf320 Binary files /dev/null and b/assets/images/help/codespaces/add-prebuilt-container-command.png differ diff --git a/assets/images/help/codespaces/automatic-port-forwarding.png b/assets/images/help/codespaces/automatic-port-forwarding.png index f539a73ffc..0a09c482e8 100644 Binary files a/assets/images/help/codespaces/automatic-port-forwarding.png and b/assets/images/help/codespaces/automatic-port-forwarding.png differ diff --git a/assets/images/help/codespaces/copy-icon-port-url.png b/assets/images/help/codespaces/copy-icon-port-url.png new file mode 100644 index 0000000000..f9cbf56da0 Binary files /dev/null and b/assets/images/help/codespaces/copy-icon-port-url.png differ diff --git a/assets/images/help/codespaces/label-icon.png b/assets/images/help/codespaces/label-icon.png new file mode 100644 index 0000000000..650537e7ae Binary files /dev/null and b/assets/images/help/codespaces/label-icon.png differ diff --git a/assets/images/help/codespaces/label-text-box.png b/assets/images/help/codespaces/label-text-box.png new file mode 100644 index 0000000000..bbbb323768 Binary files /dev/null and b/assets/images/help/codespaces/label-text-box.png differ diff --git a/assets/images/help/codespaces/make-public-option.png b/assets/images/help/codespaces/make-public-option.png new file mode 100644 index 0000000000..56b9a6b67b Binary files /dev/null and b/assets/images/help/codespaces/make-public-option.png differ diff --git a/assets/images/help/codespaces/port-number-text-box.png b/assets/images/help/codespaces/port-number-text-box.png new file mode 100644 index 0000000000..2fc5ca6f30 Binary files /dev/null and b/assets/images/help/codespaces/port-number-text-box.png differ diff --git a/assets/images/help/codespaces/ports-tab.png b/assets/images/help/codespaces/ports-tab.png new file mode 100644 index 0000000000..529bffa470 Binary files /dev/null and b/assets/images/help/codespaces/ports-tab.png differ diff --git a/assets/images/help/codespaces/prebuilt-container-ok-button.png b/assets/images/help/codespaces/prebuilt-container-ok-button.png new file mode 100644 index 0000000000..f1121cf9b5 Binary files /dev/null and b/assets/images/help/codespaces/prebuilt-container-ok-button.png differ diff --git a/assets/images/help/codespaces/predefined-container-definitions-list.png b/assets/images/help/codespaces/predefined-container-definitions-list.png new file mode 100644 index 0000000000..a603dc77a9 Binary files /dev/null and b/assets/images/help/codespaces/predefined-container-definitions-list.png differ diff --git a/assets/images/help/codespaces/rebuild-container-command.png b/assets/images/help/codespaces/rebuild-container-command.png new file mode 100644 index 0000000000..c3e83dd105 Binary files /dev/null and b/assets/images/help/codespaces/rebuild-container-command.png differ diff --git a/assets/images/help/codespaces/rebuild-prompt.png b/assets/images/help/codespaces/rebuild-prompt.png new file mode 100644 index 0000000000..c69079ab4a Binary files /dev/null and b/assets/images/help/codespaces/rebuild-prompt.png differ diff --git a/assets/images/help/codespaces/recovery-mode-error-message.png b/assets/images/help/codespaces/recovery-mode-error-message.png new file mode 100644 index 0000000000..edeb571833 Binary files /dev/null and b/assets/images/help/codespaces/recovery-mode-error-message.png differ diff --git a/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png b/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png new file mode 100644 index 0000000000..62067f94ee Binary files /dev/null and b/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png differ diff --git a/assets/images/help/pages/choose-a-theme.png b/assets/images/help/pages/choose-a-theme.png index e05a637b4e..aa5af54d24 100644 Binary files a/assets/images/help/pages/choose-a-theme.png and b/assets/images/help/pages/choose-a-theme.png differ diff --git a/assets/images/help/pages/click-private-pages-url-to-preview.png b/assets/images/help/pages/click-private-pages-url-to-preview.png index eb285a2fd0..6cac3856e6 100644 Binary files a/assets/images/help/pages/click-private-pages-url-to-preview.png and b/assets/images/help/pages/click-private-pages-url-to-preview.png differ diff --git a/assets/images/help/pages/enforce-https-custom-domains.png b/assets/images/help/pages/enforce-https-custom-domains.png index a397baf340..653520fe7a 100644 Binary files a/assets/images/help/pages/enforce-https-custom-domains.png and b/assets/images/help/pages/enforce-https-custom-domains.png differ diff --git a/assets/images/help/pages/pages-tab.png b/assets/images/help/pages/pages-tab.png new file mode 100644 index 0000000000..02a87abc5a Binary files /dev/null and b/assets/images/help/pages/pages-tab.png differ diff --git a/assets/images/help/pages/publishing-source-drop-down.png b/assets/images/help/pages/publishing-source-drop-down.png index 53d9dcfe29..91131ab650 100644 Binary files a/assets/images/help/pages/publishing-source-drop-down.png and b/assets/images/help/pages/publishing-source-drop-down.png differ diff --git a/assets/images/help/pages/remove-custom-domain.png b/assets/images/help/pages/remove-custom-domain.png new file mode 100644 index 0000000000..2b09f66fbd Binary files /dev/null and b/assets/images/help/pages/remove-custom-domain.png differ diff --git a/assets/images/help/pages/save-custom-apex-domain.png b/assets/images/help/pages/save-custom-apex-domain.png index cf5d7cf090..d41cddbddd 100644 Binary files a/assets/images/help/pages/save-custom-apex-domain.png and b/assets/images/help/pages/save-custom-apex-domain.png differ diff --git a/assets/images/help/pages/save-custom-subdomain.png b/assets/images/help/pages/save-custom-subdomain.png index 24a248d980..01f6d6d926 100644 Binary files a/assets/images/help/pages/save-custom-subdomain.png and b/assets/images/help/pages/save-custom-subdomain.png differ diff --git a/assets/images/help/repository/actions-quickstart-commit-new-file.png b/assets/images/help/repository/actions-quickstart-commit-new-file.png new file mode 100644 index 0000000000..7d1df5a5c2 Binary files /dev/null and b/assets/images/help/repository/actions-quickstart-commit-new-file.png differ diff --git a/assets/images/help/repository/actions-quickstart-job.png b/assets/images/help/repository/actions-quickstart-job.png new file mode 100644 index 0000000000..93fa19fca6 Binary files /dev/null and b/assets/images/help/repository/actions-quickstart-job.png differ diff --git a/assets/images/help/repository/actions-quickstart-log-detail.png b/assets/images/help/repository/actions-quickstart-log-detail.png new file mode 100644 index 0000000000..05ff4b0ba4 Binary files /dev/null and b/assets/images/help/repository/actions-quickstart-log-detail.png differ diff --git a/assets/images/help/repository/actions-quickstart-logs.png b/assets/images/help/repository/actions-quickstart-logs.png new file mode 100644 index 0000000000..e7a0efcbd7 Binary files /dev/null and b/assets/images/help/repository/actions-quickstart-logs.png differ diff --git a/assets/images/help/repository/actions-quickstart-run-name.png b/assets/images/help/repository/actions-quickstart-run-name.png new file mode 100644 index 0000000000..d6398fa640 Binary files /dev/null and b/assets/images/help/repository/actions-quickstart-run-name.png differ diff --git a/assets/images/help/repository/actions-quickstart-workflow-sidebar.png b/assets/images/help/repository/actions-quickstart-workflow-sidebar.png new file mode 100644 index 0000000000..2221c58c98 Binary files /dev/null and b/assets/images/help/repository/actions-quickstart-workflow-sidebar.png differ diff --git a/assets/images/help/settings/settings-sidebar-billing-plans.png b/assets/images/help/settings/settings-sidebar-billing-plans.png new file mode 100644 index 0000000000..015902a30b Binary files /dev/null and b/assets/images/help/settings/settings-sidebar-billing-plans.png differ diff --git a/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync.png b/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync.png new file mode 100644 index 0000000000..c88e669e31 Binary files /dev/null and b/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync.png differ diff --git a/assets/images/help/settings/theme-choose-a-single-theme.png b/assets/images/help/settings/theme-choose-a-single-theme.png new file mode 100644 index 0000000000..a63837059e Binary files /dev/null and b/assets/images/help/settings/theme-choose-a-single-theme.png differ diff --git a/assets/images/help/settings/theme-mode-drop-down-menu.png b/assets/images/help/settings/theme-mode-drop-down-menu.png new file mode 100644 index 0000000000..3e2599affe Binary files /dev/null and b/assets/images/help/settings/theme-mode-drop-down-menu.png differ diff --git a/assets/images/help/settings/theme-settings-radio-buttons.png b/assets/images/help/settings/theme-settings-radio-buttons.png deleted file mode 100644 index 0ff46c06b4..0000000000 Binary files a/assets/images/help/settings/theme-settings-radio-buttons.png and /dev/null differ diff --git a/assets/images/help/sponsors/add-a-tier-button.png b/assets/images/help/sponsors/add-a-tier-button.png index fef5798c32..df5a2e41a9 100644 Binary files a/assets/images/help/sponsors/add-a-tier-button.png and b/assets/images/help/sponsors/add-a-tier-button.png differ diff --git a/assets/images/help/sponsors/enable-custom-amounts.png b/assets/images/help/sponsors/enable-custom-amounts.png new file mode 100644 index 0000000000..8c0de05d9e Binary files /dev/null and b/assets/images/help/sponsors/enable-custom-amounts.png differ diff --git a/assets/images/help/sponsors/filter-drop-down.png b/assets/images/help/sponsors/filter-drop-down.png index 4128bc4f69..61522d8b72 100644 Binary files a/assets/images/help/sponsors/filter-drop-down.png and b/assets/images/help/sponsors/filter-drop-down.png differ diff --git a/assets/images/help/sponsors/pay-prorated-amount-link.png b/assets/images/help/sponsors/pay-prorated-amount-link.png index 46683831ad..882a677a15 100644 Binary files a/assets/images/help/sponsors/pay-prorated-amount-link.png and b/assets/images/help/sponsors/pay-prorated-amount-link.png differ diff --git a/assets/images/help/sponsors/publish-tier-button.png b/assets/images/help/sponsors/publish-tier-button.png index c52eb02e22..d87155ed79 100644 Binary files a/assets/images/help/sponsors/publish-tier-button.png and b/assets/images/help/sponsors/publish-tier-button.png differ diff --git a/assets/images/help/sponsors/save-tier-draft.png b/assets/images/help/sponsors/save-tier-draft.png index a008decdc1..9469f3c1a6 100644 Binary files a/assets/images/help/sponsors/save-tier-draft.png and b/assets/images/help/sponsors/save-tier-draft.png differ diff --git a/assets/images/help/sponsors/select-a-tier-box.png b/assets/images/help/sponsors/select-a-tier-box.png index cbdad0a4f0..7337ae1c64 100644 Binary files a/assets/images/help/sponsors/select-a-tier-box.png and b/assets/images/help/sponsors/select-a-tier-box.png differ diff --git a/assets/images/help/sponsors/set-default-amount.png b/assets/images/help/sponsors/set-default-amount.png new file mode 100644 index 0000000000..6f05d09dc5 Binary files /dev/null and b/assets/images/help/sponsors/set-default-amount.png differ diff --git a/assets/images/help/sponsors/show-one-time-tiers.png b/assets/images/help/sponsors/show-one-time-tiers.png new file mode 100644 index 0000000000..6a4ce0c3e5 Binary files /dev/null and b/assets/images/help/sponsors/show-one-time-tiers.png differ diff --git a/assets/images/help/sponsors/sponsor-developer-button.png b/assets/images/help/sponsors/sponsor-developer-button.png index 07ff04b8c3..e44f53529a 100644 Binary files a/assets/images/help/sponsors/sponsor-developer-button.png and b/assets/images/help/sponsors/sponsor-developer-button.png differ diff --git a/assets/images/help/sponsors/tier-price-description.png b/assets/images/help/sponsors/tier-price-description.png index 6c8dcc929c..74310b682d 100644 Binary files a/assets/images/help/sponsors/tier-price-description.png and b/assets/images/help/sponsors/tier-price-description.png differ diff --git a/assets/images/help/sponsors/update-sponsorship-button.png b/assets/images/help/sponsors/update-sponsorship-button.png index 3e73ca622f..c4d7f82a31 100644 Binary files a/assets/images/help/sponsors/update-sponsorship-button.png and b/assets/images/help/sponsors/update-sponsorship-button.png differ diff --git a/assets/images/help/sponsors/updates-checkbox-manage.png b/assets/images/help/sponsors/updates-checkbox-manage.png index 42f509ba4c..c0e919374d 100644 Binary files a/assets/images/help/sponsors/updates-checkbox-manage.png and b/assets/images/help/sponsors/updates-checkbox-manage.png differ diff --git a/assets/images/help/sponsors/who-can-see-sponsorship.png b/assets/images/help/sponsors/who-can-see-sponsorship.png index 6caf98886d..aac8a4df94 100644 Binary files a/assets/images/help/sponsors/who-can-see-sponsorship.png and b/assets/images/help/sponsors/who-can-see-sponsorship.png differ diff --git a/assets/images/octicons/hamburger.svg b/assets/images/octicons/hamburger.svg index ed3357e45b..1f07d96dc0 100644 --- a/assets/images/octicons/hamburger.svg +++ b/assets/images/octicons/hamburger.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/assets/images/octicons/search.svg b/assets/images/octicons/search.svg index a85c44c281..fec5946f4d 100644 --- a/assets/images/octicons/search.svg +++ b/assets/images/octicons/search.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/assets/images/octicons/x.svg b/assets/images/octicons/x.svg index 017868ac0a..e5a43e31e6 100644 --- a/assets/images/octicons/x.svg +++ b/assets/images/octicons/x.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/content/README.md b/content/README.md index 45b571c323..ca4ad5debd 100644 --- a/content/README.md +++ b/content/README.md @@ -184,8 +184,10 @@ featuredLinks: ### `changelog` -- Purpose: Render a list of changelog items with timestamps on product pages (ex: `layouts/product-landing.html`) -- Type: `Array`, items are objects `{ href: string, title: string, date: 'YYYY-MM-DD' }` +- Purpose: Render a list of items pulled from [GitHub Changelog](https://github.blog/changelog/) on product landing pages (ex: `layouts/product-landing.html`). The one exception is Education, which pulls from https://github.blog/category/community/education. +- Type: `Object`, properties: + - `label` -- must be present and corresponds to the labels used in the [GitHub Changelog](https://github.blog/changelog/) + - `prefix` -- optional string that starts each changelog title that should be omitted in the docs feed. For example, with the prefix `GitHub Actions: ` specified, changelog titles like `GitHub Actions: Some Title Here` will render as `Some Title Here` in the docs feed). - Optional. ### `defaultPlatform` @@ -223,7 +225,7 @@ includeGuides: ``` ### `type` -- Purpose: Indicate the type of article. +- Purpose: Indicate the type of article. - Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`. - Optional. diff --git a/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 1052bd4b76..785cb39f9d 100644 --- a/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -58,7 +58,7 @@ inputs: When you specify an input to an action in a workflow file or use a default input value, {% data variables.product.prodname_dotcom %} creates an environment variable for the input with the name `INPUT_`. The environment variable created converts input names to uppercase letters and replaces spaces with `_` characters. -For example, if a workflow defined the numOctocats and octocatEyeColor inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables. +For example, if a workflow defined the `numOctocats` and `octocatEyeColor` inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables. #### `inputs.` @@ -76,6 +76,10 @@ For example, if a workflow defined the numOctocats and octocatEyeColor inputs, t **Optional** A `string` representing the default value. The default value is used when an input parameter isn't specified in a workflow file. +#### `inputs..deprecationMessage` + +**Optional** If the input parameter is used, this `string` is logged as a warning message. You can use this warning to notify users that the input is deprecated and mention any alternatives. + ### `outputs` **Optional** Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. diff --git a/content/actions/guides/about-packaging-with-github-actions.md b/content/actions/guides/about-packaging-with-github-actions.md index 0b3d9fb516..7e9f27871e 100644 --- a/content/actions/guides/about-packaging-with-github-actions.md +++ b/content/actions/guides/about-packaging-with-github-actions.md @@ -45,7 +45,7 @@ In addition to uploading packaging artifacts for testing in a continuous integra * **Publish packages to {% data variables.product.prodname_registry %}** {% data variables.product.prodname_registry %} can act as a package hosting service for many types of packages. You can choose to share your packages with all of {% data variables.product.prodname_dotcom %}, or private packages to share with collaborators or an organization. For more information, see "[About {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages/about-github-packages)." - You may want to publish packages to {% data variables.product.prodname_registry %} on every push into the default branch. This will allow developers on your project to always be able to run and test the latest build out of master easily, by installing it from {% data variables.product.prodname_registry %}. + You may want to publish packages to {% data variables.product.prodname_registry %} on every push into the default branch. This will allow developers on your project to always be able to run and test the latest build out of the main branch easily, by installing it from {% data variables.product.prodname_registry %}. * **Publish packages to a package registry** For many projects, publishing to a package registry is performed whenever a new version of a project is released. For example, a project that produces a JAR file may upload new releases to the Maven Central repository. Or, a .NET project may produce a nuget package and upload it to the NuGet Gallery. diff --git a/content/actions/guides/building-and-testing-nodejs.md b/content/actions/guides/building-and-testing-nodejs.md index 9d37882676..ed249dc7fe 100644 --- a/content/actions/guides/building-and-testing-nodejs.md +++ b/content/actions/guides/building-and-testing-nodejs.md @@ -37,7 +37,7 @@ We recommend that you have a basic understanding of Node.js, YAML, workflow conf {% data variables.product.prodname_dotcom %} provides a Node.js workflow template that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the template. For more information, see the [Node.js workflow template](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). -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. The workflow shown below assumes that the default branch for your repository is `main`. {% raw %} ```yaml{:copy} @@ -45,9 +45,9 @@ name: Node.js CI on: push: - branches: [ $default-branch ] + branches: [ main ] pull_request: - branches: [ $default-branch ] + branches: [ main ] jobs: build: diff --git a/content/actions/guides/building-and-testing-ruby.md b/content/actions/guides/building-and-testing-ruby.md index c2dde2eef5..79faf88e39 100644 --- a/content/actions/guides/building-and-testing-ruby.md +++ b/content/actions/guides/building-and-testing-ruby.md @@ -31,7 +31,7 @@ We recommend that you have a basic understanding of Ruby, YAML, workflow configu {% data variables.product.prodname_dotcom %} provides a Ruby workflow template that will work for most Ruby projects. For more information, see the [Ruby workflow template](https://github.com/actions/starter-workflows/blob/master/ci/ruby.yml). -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. The workflow shown below assumes that the default branch for your repository is `main`. {% raw %} ```yaml @@ -39,9 +39,9 @@ name: Ruby on: push: - branches: [ $default-branch ] + branches: [ main ] pull_request: - branches: [ $default-branch ] + branches: [ main ] jobs: test: @@ -105,9 +105,9 @@ name: Ruby CI on: push: - branches: [ $default-branch ] + branches: [ main ] pull_request: - branches: [ $default-branch ] + branches: [ main ] jobs: test: @@ -211,9 +211,9 @@ name: Matrix Testing on: push: - branches: [ $default-branch ] + branches: [ main ] pull_request: - branches: [ $default-branch ] + branches: [ main ] jobs: test: @@ -272,11 +272,11 @@ name: Ruby Gem on: # Manually publish workflow_dispatch: - # Alternatively, publish whenever changes are merged to the default branch. + # Alternatively, publish whenever changes are merged to the `main` branch. push: - branches: [ $default-branch ] + branches: [ main ] pull_request: - branches: [ $default-branch ] + branches: [ main ] jobs: build: diff --git a/content/actions/guides/index.md b/content/actions/guides/index.md index 4046b2bf8a..6ba486d6eb 100644 --- a/content/actions/guides/index.md +++ b/content/actions/guides/index.md @@ -70,6 +70,7 @@ includeGuides: - /actions/guides/commenting-on-an-issue-when-a-label-is-added - /actions/guides/moving-assigned-issues-on-project-boards - /actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column + - /actions/guides/managing-github-actions-with-github-cli --- @@ -104,3 +105,4 @@ includeGuides: + diff --git a/content/actions/guides/managing-github-actions-with-github-cli.md b/content/actions/guides/managing-github-actions-with-github-cli.md new file mode 100644 index 0000000000..51e5fec620 --- /dev/null +++ b/content/actions/guides/managing-github-actions-with-github-cli.md @@ -0,0 +1,37 @@ +--- +title: Managing GitHub Actions with GitHub CLI +intro: 'You can use {% data variables.product.prodname_cli %} to interact with {% data variables.product.prodname_actions %}.' +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'overview' +topics: + - 'Workflows' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + +### Setting up {% data variables.product.prodname_cli %} + +{% data reusables.cli.download-update-cli %} {% data reusables.cli.actions-cli-version %} {% data reusables.cli.cli-manual %} + +{% data reusables.cli.cli-auth %} + +{% data reusables.cli.cli-repo %} + +### Managing {% data variables.product.prodname_actions %} with {% data variables.product.prodname_cli %} + +To view all available commands related to {% data variables.product.prodname_actions %}, run `gh actions`. + +For more information on using commands in specific scenarios, see the following procedures: + +- "[Re-running a workflow](/actions/managing-workflow-runs/re-running-a-workflow#re-run-a-workflow-through-github-cli)" +- "[Manually running a workflow](/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow-using-github-cli)" +- "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts#download-artifacts-through-github-cli)" +- "[Using workflow run logs](/actions/managing-workflow-runs/using-workflow-run-logs#viewing-logs-through-github-cli)" +- "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history#viewing-workflow-run-history-with-github-cli)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +- "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow#disabling-and-enabling-workflows-through-github-cli)"{% endif %} diff --git a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 1c76fa56cf..7a3c715b25 100644 --- a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -123,7 +123,7 @@ The self-hosted runner polls {% data variables.product.product_name %} to retrie You must ensure that the self-hosted runner has appropriate network access to communicate with the {% data variables.product.prodname_ghe_managed %} URL. For example, if your instance name is `octoghae`, then you will need to allow the self-hosted runner to access `octoghae.github.com`. -If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)." +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)." {% endif %} {% if currentVersion == "free-pro-team@latest" %} @@ -143,7 +143,7 @@ pkg-containers.githubusercontent.com pkg-containers-az.githubusercontent.com ``` -If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#using-github-actions-with-an-ip-allow-list)". +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#using-github-actions-with-an-ip-allow-list)". {% else %} diff --git a/content/actions/index.md b/content/actions/index.md index 48ff80ce2c..62205a48e4 100644 --- a/content/actions/index.md +++ b/content/actions/index.md @@ -22,18 +22,9 @@ featuredLinks: - /actions/reference/environment-variables - /actions/reference/encrypted-secrets changelog: - - title: Environments, environment protection rules and environment secrets (beta) - date: '2020-12-15' - href: https://github.blog/changelog/2020-12-15-github-actions-environments-environment-protection-rules-and-environment-secrets-beta/ - - title: Workflow visualization - date: '2020-12-08' - href: https://github.blog/changelog/2020-12-08-github-actions-workflow-visualization/ - - title: Removing set-env and add-path commands on November 16 - date: '2020-11-09' - href: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/ - + label: 'actions' + prefix: 'GitHub Actions: ' product_video: https://www.youtube-nocookie.com/embed/cP0I9w2coGU - redirect_from: - /articles/automating-your-workflow-with-github-actions/ - /articles/customizing-your-project-with-github-actions/ @@ -55,29 +46,4 @@ versions: - - - -{% assign actionsCodeExamples = site.data.variables.action_code_examples %} -{% if actionsCodeExamples %} -
-

Code examples

- -
- -
- -
- {% render code-example-card for actionsCodeExamples as example %} -
- - - -
-
{% octicon "search" width="24" %}
-

Sorry, there is no result for

-

It looks like we don't have an example that fits your filter.
Try another filter or add your code example

- Learn how to add a code example {% octicon "arrow-right" %} -
-
-{% endif %} + \ No newline at end of file diff --git a/content/actions/learn-github-actions/security-hardening-for-github-actions.md b/content/actions/learn-github-actions/security-hardening-for-github-actions.md index 9e6ea648c4..c35f549564 100644 --- a/content/actions/learn-github-actions/security-hardening-for-github-actions.md +++ b/content/actions/learn-github-actions/security-hardening-for-github-actions.md @@ -121,7 +121,7 @@ For example, you can use the audit log to track the `org.update_actions_secret` ![Audit log entries](/assets/images/help/repository/audit-log-entries.png) The following tables describe the {% data variables.product.prodname_actions %} events that you can find in the audit log. For more information on using the audit log, see -"[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." +"[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." {% if currentVersion == "free-pro-team@latest" %} #### Events for environments @@ -157,7 +157,7 @@ The following tables describe the {% data variables.product.prodname_actions %} | `enterprise.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an enterprise](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise)." | `enterprise.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. | `enterprise.runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." -| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI. This event is not included when you export the audit log as JSON data or a CSV file. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)" and "[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)."{% endif %} +| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI. This event is not included when you export the audit log as JSON data or a CSV file. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)" and "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)."{% endif %} | `org.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an organization](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)." | `org.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see [Removing a runner from an organization](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization). | `org.runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." diff --git a/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md b/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md index 9031151f9d..344b2dbc8d 100644 --- a/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md +++ b/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md @@ -21,13 +21,13 @@ If you need to share workflows and other {% data variables.product.prodname_acti ### Creating a workflow template -Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. Workflow templates can be used to create new workflows in an organizations' public repositories; to use templates to create workflows in private repositories, the organization must be part of an enterprise or GitHub One plan. +Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. Workflow templates can be used to create new workflows in an organizations' public repositories; to use templates to create workflows in private repositories, the organization must be part of an enterprise plan. This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the template is presented to users when they are creating a new workflow. 1. If it doesn't already exist, create a new public repository named `.github` in your organization. -1. Create a directory named `workflow-templates`. -1. Create your new workflow file inside the `workflow-templates` directory. +2. Create a directory named `workflow-templates`. +3. Create your new workflow file inside the `workflow-templates` directory. If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created using your template, the placeholder will be automatically replaced with the name of the repository's default branch. @@ -52,7 +52,7 @@ This procedure demonstrates how to create a workflow template and metadata file. - name: Run a one-line script run: echo Hello from Octo Organization ``` -1. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: +4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: ```yaml { "name": "Octo Organization Workflow", diff --git a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md index 9cd84a31fa..202262b0f8 100644 --- a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md +++ b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md @@ -1,6 +1,6 @@ --- title: Disabling and enabling a workflow -intro: 'You can disable and re-enable a workflow using {% data variables.product.prodname_dotcom %} or the REST API.' +intro: 'You can disable and re-enable a workflow using the {% data variables.product.prodname_dotcom %} UI, the REST API, or {% data variables.product.prodname_cli %}.' product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' @@ -12,7 +12,7 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on {% data variables.product.prodname_dotcom %}. You can also disable and enable a workflow using the REST API. For more information, see the "[Actions REST API](/rest/reference/actions#workflows)." +Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on {% data variables.product.prodname_dotcom %}. Temporarily disabling a workflow can be useful in many scenarios. These are a few examples where disabling a workflow might be helpful: @@ -27,7 +27,9 @@ Temporarily disabling a workflow can be useful in many scenarios. These are a fe {% endwarning %} -### Disabling a workflow +### Disabling and enabling workflows with the {% data variables.product.prodname_dotcom %} UI + +#### Disabling a workflow You can manually disable a workflow so that it won't execute any workflow runs. A disabled workflow is not deleted, and can be re-enabled. @@ -42,7 +44,7 @@ You can manually disable a workflow so that it won't execute any workflow runs. The disabled workflow is marked {% octicon "stop" aria-label="The stop icon" %} to indicate its status. ![actions list disabled workflow](/assets/images/help/repository/actions-find-disabled-workflow.png) -### Enabling a workflow +#### Enabling a workflow You can re-enable a workflow that was previously disabled. @@ -52,3 +54,23 @@ You can re-enable a workflow that was previously disabled. ![actions select disabled workflow](/assets/images/help/repository/actions-select-disabled-workflow.png) 1. Click **Enable workflow**. ![actions enable workflow](/assets/images/help/repository/actions-enable-workflow.png) + +### Disabling and enabling workflows with {% data variables.product.prodname_cli %} + +{% data reusables.actions.actions-cli %} + +To disable a workflow, use the `workflow disable` subcommand. Replace `workflow` with either the name, ID, or file name of the workflow you want to disable. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. If you don't specify a workflow, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow. + +```shell +gh workflow disable workflow +``` + +To enable a workflow, use the `workflow enable` subcommand. Replace `workflow` with either the name, ID, or file name of the workflow you want to enable. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. If you don't specify a workflow, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow. + +```shell +gh workflow enable workflow +``` + +### Disabling and enabling workflows through the REST API + +You can also disable and enable a workflow using the REST API. For more information, see the "[Actions REST API](/rest/reference/actions#workflows)." diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index df597aa7ac..af408b893a 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -15,6 +15,8 @@ versions: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Configuring the retention period for GitHub Actions artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} {% if currentVersion == "enterprise-server@2.22" %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %} +### Download artifacts with the {% data variables.product.prodname_dotcom %} UI + {% data reusables.repositories.permissions-statement-read %} {% data reusables.repositories.navigate-to-repo %} @@ -27,3 +29,33 @@ versions: {% else %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) {% endif %} + +### Download artifacts with {% data variables.product.prodname_cli %} + +{% data reusables.actions.actions-cli %} + +{% data variables.product.prodname_cli %} will download each artifact into separate directories based on the artifact name. If only a single artifact is specified, it will be extracted into the current directory. + +To download all artifacts generated by a workflow run, use the `run download` subcommand. Replace `run-id` with the ID of the run that you want to download artifacts from. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run. + +```shell +gh run download run-id +``` + +To download a specific artifact from a run, use the `run download` subcommand. Replace `run-id` with the ID of the run that you want to download artifacts from. Replace `artifact-name` with the name of the artifact that you want to download. + +```shell +gh run download run-id -n artifact-name +``` + +You can specify more than one artifact. + +```shell +gh run download run-id -n artifact-name-1 -n artifact-name-2 +``` + +To download specific artifacts across all runs in a repository, use the `run download` subcommand. + +```shell +gh run download -n artifact-name-1 -n artifact-name-2 +``` diff --git a/content/actions/managing-workflow-runs/manually-running-a-workflow.md b/content/actions/managing-workflow-runs/manually-running-a-workflow.md index 55a78bf07c..a25fda294f 100644 --- a/content/actions/managing-workflow-runs/manually-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/manually-running-a-workflow.md @@ -1,6 +1,6 @@ --- title: Manually running a workflow -intro: 'When a workflow is configured to run on the `workflow_dispatch` event, you can run the workflow using the REST API or from the Actions tab on {% data variables.product.prodname_dotcom %}.' +intro: 'When a workflow is configured to run on the `workflow_dispatch` event, you can run the workflow using the Actions tab on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_cli %}, or the REST API.' product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' @@ -31,6 +31,40 @@ To trigger the `workflow_dispatch` event on {% data variables.product.prodname_d 1. Select the branch where the workflow will run and type the input parameters used by the workflow. Click **Run workflow**. ![actions manually run workflow](/assets/images/actions-manually-run-workflow.png) +### Running a workflow using {% data variables.product.prodname_cli %} + +{% data reusables.actions.actions-cli %} + +To run a workflow, use the `workflow run` subcommand. Replace the `workflow` parameter with either the name, ID, or file name of the workflow you want to run. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. If you don't specify a workflow, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow. + +```shell +gh workflow run workflow +``` + +If your workflow accepts inputs, {% data variables.product.prodname_cli %} will prompt you to enter them. Alternatively, you can use `-f` or `-F` to add an input in `key=value` format. Use `-F` to read from a file. + +```shell +gh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt +``` + +You can also pass inputs as JSON by using standard input. + +```shell +echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json +``` + +To run a workflow on a branch other than the repository's default branch, use the `--ref` flag. + +```shell +gh workflow run workflow --ref branch-name +``` + +To view the progress of the workflow run, use the `run watch` subcommand and select the run from the interactive list. + +```shell +gh run watch +``` + ### Running a workflow using the REST API When using the REST API, you configure the `inputs` and `ref` as request body parameters. If the inputs are omitted, the default values defined in the workflow file are used. diff --git a/content/actions/managing-workflow-runs/re-running-a-workflow.md b/content/actions/managing-workflow-runs/re-running-a-workflow.md index f72ee39863..171c1397f3 100644 --- a/content/actions/managing-workflow-runs/re-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/re-running-a-workflow.md @@ -12,6 +12,8 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} +### Re-run a workflow using the {% data variables.product.prodname_dotcom %} UI + {% data reusables.repositories.permissions-statement-write %} {% data reusables.repositories.navigate-to-repo %} @@ -19,3 +21,19 @@ versions: {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} 1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png){% else %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png){% endif %} + +### Re-run a workflow using {% data variables.product.prodname_cli %} + +{% data reusables.actions.actions-cli %} + +To re-run a failed workflow run, use the `run rerun` subcommand. Replace `run-id` with the ID of the failed run that you want to re-run. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. + +```shell +gh run rerun run-id +``` + +To view the progress of the workflow run, use the `run watch` subcommand and select the run from the interactive list. + +```shell +gh run watch +``` diff --git a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md index a433c07caa..91b744887d 100644 --- a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md @@ -22,13 +22,13 @@ versions: {% data reusables.repositories.permissions-statement-write %} -{% data reusables.github-actions.artifact-log-retention-statement %} +{% data reusables.github-actions.artifact-log-retention-statement %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} -1. Under **Artifacts**, click {% octicon "trashcan" aria-label="The trashcan icon" %} next to the artifact you want to remove. +1. Under **Artifacts**, click {% octicon "trash" aria-label="The trash icon" %} next to the artifact you want to remove. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact-updated.png) {% else %} diff --git a/content/actions/managing-workflow-runs/using-workflow-run-logs.md b/content/actions/managing-workflow-runs/using-workflow-run-logs.md index fa3973fb94..d393e4c7d4 100644 --- a/content/actions/managing-workflow-runs/using-workflow-run-logs.md +++ b/content/actions/managing-workflow-runs/using-workflow-run-logs.md @@ -109,3 +109,31 @@ After deleting logs, the **Delete all logs** button is removed to indicate that ![Delete all logs](/assets/images/help/repository/delete-all-logs.png) 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 %} + +### Viewing logs with {% data variables.product.prodname_cli %} + +{% data reusables.actions.actions-cli %} + +To view the log for a specific job, use the `run view` subcommand. Replace `run-id` with the ID of run that you want to view logs for. {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a job from the run. If you don't specify `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run, and then returns another interactive menu for you to choose a job from the run. + +```shell +gh run view run-id --log +``` + +You can also use the `--job` flag to specify a job ID. Replace `job-id` with the ID of the job that you want to view logs for. + +```shell +gh run view --job job-id --log +``` + +You can use `grep` to search the log. For example, this command will return all log entries that contain the word `error`. + +```shell +gh run view --job job-id --log | grep error +``` + +To filter the logs for any failed steps, use `--log-failed` instead of `--log`. + +```shell +gh run view --job job-id --log-failed +``` diff --git a/content/actions/managing-workflow-runs/viewing-workflow-run-history.md b/content/actions/managing-workflow-runs/viewing-workflow-run-history.md index 284bd3fcd9..5bb9ee1c41 100644 --- a/content/actions/managing-workflow-runs/viewing-workflow-run-history.md +++ b/content/actions/managing-workflow-runs/viewing-workflow-run-history.md @@ -12,9 +12,67 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} +### Viewing workflow run history on {% data variables.product.prodname_dotcom %} + {% data reusables.repositories.permissions-statement-read %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} + +### Viewing workflow run history with {% data variables.product.prodname_cli %} + +{% data reusables.actions.actions-cli %} + +#### Viewing recent workflow runs + +To list the recent workflow runs, use the `run list` subcommand. + +```shell +gh run list +``` + +To specify the maximum number of runs to return, you can use the `-L` or `--limit` flag . The default is `10`. + +```shell +gh run list --limit 5 +``` + +To only return runs for the specified workflow, you can use the `-w` or `--workflow` flag. Replace `workflow` with either the workflow name, workflow ID, or workflow file name. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. + +```shell +gh run list --workflow workflow +``` + +#### Viewing details for a specific workflow run + +To display details for a specific workflow run, use the `run view` subcommand. Replace `run-id` with the ID of the run that you want to view. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run. + +```shell +gh run view run-id +``` + +To include job steps in the output, use the `-v` or `--verbose` flag. + +```shell +gh run view run-id --verbose +``` + +To view details for a specific job in the run, use the `-j` or `--job` flag. Replace `job-id` with the ID of the job that you want to view. + +```shell +gh run view --job job-id +``` + +To view the full log for a job, use the `--log` flag. + +```shell +gh run view --job job-id --log +``` + +Use the `--exit-status` flag to exit with a non-zero status if the run failed. For example: + +```shell +gh run view 0451 --exit-status && echo "run pending or passed" +``` diff --git a/content/actions/quickstart.md b/content/actions/quickstart.md index fa57cf9deb..cb424476cc 100644 --- a/content/actions/quickstart.md +++ b/content/actions/quickstart.md @@ -1,6 +1,6 @@ --- title: Quickstart for GitHub Actions -intro: 'Add a {% data variables.product.prodname_actions %} workflow to an existing repository in 5 minutes or less.' +intro: 'Try out the features of {% data variables.product.prodname_actions %} in 5 minutes or less.' allowTitleToDifferFromFilename: true redirect_from: - /actions/getting-started-with-github-actions/starting-with-preconfigured-workflow-templates @@ -19,135 +19,73 @@ topics: ### Introduction -You only need an existing {% data variables.product.prodname_dotcom %} repository to create and run a {% data variables.product.prodname_actions %} workflow. In this guide, you'll add a workflow that lints multiple coding languages using the [{% data variables.product.prodname_dotcom %} Super-Linter action](https://github.com/github/super-linter). The workflow uses Super-Linter to validate your source code every time a new commit is pushed to your repository. +You only need a {% data variables.product.prodname_dotcom %} repository to create and run a {% data variables.product.prodname_actions %} workflow. In this guide, you'll add a workflow that demonstrates some of the essential features of {% data variables.product.prodname_actions %}. + +The following example shows you how {% data variables.product.prodname_actions %} jobs can be automatically triggered, where they run, and how they can interact with the code in your repository. ### Creating your first workflow -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. +1. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `github-actions-demo.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 `github-actions-demo.yml` file: {% raw %} ```yaml{:copy} - name: Super-Linter - - # Run this workflow every time a new commit pushed to your repository - on: push - + name: GitHub Actions Demo + on: [push] jobs: - # Set the job key. The key is displayed as the job name - # when a job name is not provided - super-lint: - # Name the Job - name: Lint code base - # Set the type of machine to run on + Explore-GitHub-Actions: runs-on: ubuntu-latest - steps: - # Checks out a copy of your repository on the ubuntu-latest machine - - name: Checkout code + - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event." + - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!" + - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}." + - name: Check out repository code uses: actions/checkout@v2 + - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner." + - run: echo "🖥️ The workflow is now ready to test your code on the runner." + - name: List files in the repository + run: | + ls ${{ github.workspace }} + - run: echo "🍏 This job's status is ${{ job.status }}." - # Runs the Super-Linter action - - name: Run Super-Linter - uses: github/super-linter@v3 - env: - DEFAULT_BRANCH: main - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` {% endraw %} -3. To run your workflow, scroll to the bottom of the page and select **Create a new branch for this commit and start a pull request**. Then, to create a pull request, click **Propose new file**. - ![Commit workflow file](/assets/images/commit-workflow-file.png) +3. Scroll to the bottom of the page and select **Create a new branch for this commit and start a pull request**. Then, to create a pull request, click **Propose new file**. + ![Commit workflow file](/assets/images/help/repository/actions-quickstart-commit-new-file.png) -Committing the workflow file in your repository triggers the `push` event and runs your workflow. +Committing the workflow file to a branch in your repository triggers the `push` event and runs your workflow. ### Viewing your workflow results {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} -{% data reusables.repositories.navigate-to-workflow-superlinter %} -{% data reusables.repositories.view-run-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} -1. Under **Jobs** or in the visualization graph, click the **Lint code base** job. - ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job-updated.png) -{% else %} -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) -{% endif %} -{% data reusables.repositories.view-failed-job-results-superlinter %} +1. In the left sidebar, click the workflow you want to see. + ![Workflow list in left sidebar](/assets/images/help/repository/actions-quickstart-workflow-sidebar.png) +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/actions-quickstart-run-name.png) +1. Under **Jobs** , click the **Explore-GitHub-Actions** job. + + ![Locate job](/assets/images/help/repository/actions-quickstart-job.png) +1. The log shows you how each of the steps was processed. Expand any of the steps to view its details. + + ![Example workflow results](/assets/images/help/repository/actions-quickstart-logs.png) + + For example, you can see the list of files in your repository: + ![Example action detail](/assets/images/help/repository/actions-quickstart-log-detail.png) + ### More workflow templates {% data reusables.actions.workflow-template-overview %} ### Next steps -The super-linter workflow you just added runs each time code is pushed to your repository to help you spot errors and inconsistencies in your code. But this is only the beginning of what you can do with {% data variables.product.prodname_actions %}. Your repository can contain multiple workflows that trigger different jobs based on different events. {% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}: +The example workflow you just added runs each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. But this is only the beginning of what you can do with {% data variables.product.prodname_actions %}: -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial -- "[Guides](/actions/guides)" for specific uses cases and examples -- [github/super-linter](https://github.com/github/super-linter) for more details about configuring the Super-Linter action +- Your repository can contain multiple workflows that trigger different jobs based on different events. +- You can use a workflow to install software testing apps and have them automatically test your code on {% data variables.product.prodname_dotcom %}'s runners. - +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial. +- "[Guides](/actions/guides)" for specific uses cases and examples. diff --git a/content/actions/reference/context-and-expression-syntax-for-github-actions.md b/content/actions/reference/context-and-expression-syntax-for-github-actions.md index 8bdfedc6e8..cf9743f600 100644 --- a/content/actions/reference/context-and-expression-syntax-for-github-actions.md +++ b/content/actions/reference/context-and-expression-syntax-for-github-actions.md @@ -323,7 +323,7 @@ Returns `true` if `searchString` ends with `searchValue`. This function is not c `format( string, replaceValue0, replaceValue1, ..., replaceValueN)` -Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces useing double braces. +Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces using double braces. ##### Example diff --git a/content/actions/reference/environments.md b/content/actions/reference/environments.md index d0e0ca0360..779a70ad24 100644 --- a/content/actions/reference/environments.md +++ b/content/actions/reference/environments.md @@ -80,7 +80,7 @@ Deleting an environment will delete all secrets and protection rules associated {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.github-actions.sidebar-environment %} -1. Next the the environment that you want to delete, click {% octicon "trashcan" aria-label="The trashcan icon" %}. +1. Next the the environment that you want to delete, click {% octicon "trash" aria-label="The trash icon" %}. 2. Click **I understand, delete this environment**. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.1" %}You can also delete environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)."{% endif %} diff --git a/content/actions/reference/usage-limits-billing-and-administration.md b/content/actions/reference/usage-limits-billing-and-administration.md index 2ab089a0ed..ef87f6ebc6 100644 --- a/content/actions/reference/usage-limits-billing-and-administration.md +++ b/content/actions/reference/usage-limits-billing-and-administration.md @@ -67,7 +67,7 @@ You can configure the artifact and log retention period for your repository, org For more information, see: - [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository) -- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization) +- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization) - [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your enterprise](/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account) {% endif %} @@ -77,7 +77,7 @@ For more information, see: For more information, see: - "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository)" -- "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)"{% if currentVersion == "free-pro-team@latest" %} +- "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)"{% if currentVersion == "free-pro-team@latest" %} - "[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)" for {% data variables.product.prodname_ghe_cloud %}{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} diff --git a/content/actions/reference/workflow-syntax-for-github-actions.md b/content/actions/reference/workflow-syntax-for-github-actions.md index 334df0d22f..9e2de6816c 100644 --- a/content/actions/reference/workflow-syntax-for-github-actions.md +++ b/content/actions/reference/workflow-syntax-for-github-actions.md @@ -899,7 +899,7 @@ The order that you define a `matrix` matters. The first option you define will b #### Example running with more than one version of Node.js -You can specify a matrix by supplying an array for the configuration options. For example, if the runner supports Node.js versions 6, 8, and 10, you could specify an array of those versions in the `matrix`. +You can specify a matrix by supplying an array for the configuration options. For example, if the runner supports Node.js versions 10, 12, and 14, you could specify an array of those versions in the `matrix`. This example creates a matrix of three jobs by setting the `node` key to an array of three Node.js versions. To use the matrix, the example sets the `matrix.node` context property as the value of the `setup-node` action's input parameter `node-version`. As a result, three jobs will run, each using a different Node.js version. @@ -907,10 +907,10 @@ This example creates a matrix of three jobs by setting the `node` key to an arra ```yaml strategy: matrix: - node: [6, 8, 10] + node: [10, 12, 14] steps: # Configures the node version used on GitHub-hosted runners - - uses: actions/setup-node@v1 + - uses: actions/setup-node@v2 with: # The Node.js version to configure node-version: ${{ matrix.node }} @@ -934,9 +934,9 @@ runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-16.04, ubuntu-18.04] - node: [6, 8, 10] + node: [10, 12, 14] steps: - - uses: actions/setup-node@v1 + - uses: actions/setup-node@v2 with: node-version: ${{ matrix.node }} ``` @@ -948,7 +948,7 @@ steps: #### Example including additional values into combinations -You can add additional configuration options to a build matrix job that already exists. For example, if you want to use a specific version of `npm` when the job that uses `windows-latest` and version 4 of `node` runs, you can use `include` to specify that additional option. +You can add additional configuration options to a build matrix job that already exists. For example, if you want to use a specific version of `npm` when the job that uses `windows-latest` and version 8 of `node` runs, you can use `include` to specify that additional option. {% raw %} ```yaml @@ -956,29 +956,29 @@ runs-on: ${{ matrix.os }} strategy: matrix: os: [macos-latest, windows-latest, ubuntu-18.04] - node: [4, 6, 8, 10] + node: [8, 10, 12, 14] include: - # includes a new variable of npm with a value of 2 + # includes a new variable of npm with a value of 6 # for the matrix leg matching the os and version - os: windows-latest - node: 4 - npm: 2 + node: 8 + npm: 6 ``` {% endraw %} #### Example including new combinations -You can use `include` to add new jobs to a build matrix. Any unmatched include configurations are added to the matrix. For example, if you want to use `node` version 12 to build on multiple operating systems, but wanted one extra experimental job using node version 13 on Ubuntu, you can use `include` to specify that additional job. +You can use `include` to add new jobs to a build matrix. Any unmatched include configurations are added to the matrix. For example, if you want to use `node` version 14 to build on multiple operating systems, but wanted one extra experimental job using node version 15 on Ubuntu, you can use `include` to specify that additional job. {% raw %} ```yaml runs-on: ${{ matrix.os }} strategy: matrix: - node: [12] + node: [14] os: [macos-latest, windows-latest, ubuntu-18.04] include: - - node: 13 + - node: 15 os: ubuntu-18.04 experimental: true ``` @@ -994,11 +994,11 @@ runs-on: ${{ matrix.os }} strategy: matrix: os: [macos-latest, windows-latest, ubuntu-18.04] - node: [4, 6, 8, 10] + node: [8, 10, 12, 14] exclude: - # excludes node 4 on macOS + # excludes node 8 on macOS - os: macos-latest - node: 4 + node: 8 ``` {% endraw %} @@ -1033,7 +1033,7 @@ Prevents a workflow run from failing when a job fails. Set to `true` to allow a #### Example preventing a specific failing matrix job from failing a workflow run -You can allow specific jobs in a job matrix to fail without failing the workflow run. For example, if you wanted to only allow an experimental job with `node` set to `13` to fail without failing the workflow run. +You can allow specific jobs in a job matrix to fail without failing the workflow run. For example, if you wanted to only allow an experimental job with `node` set to `15` to fail without failing the workflow run. {% raw %} ```yaml @@ -1042,11 +1042,11 @@ continue-on-error: ${{ matrix.experimental }} strategy: fail-fast: false matrix: - node: [11, 12] + node: [13, 14] os: [macos-latest, ubuntu-18.04] experimental: [false] include: - - node: 13 + - node: 15 os: ubuntu-18.04 experimental: true ``` @@ -1064,7 +1064,7 @@ If you do not set a `container`, all steps will run directly on the host specifi jobs: my_job: container: - image: node:10.16-jessie + image: node:14.16 env: NODE_ENV: development ports: @@ -1079,7 +1079,7 @@ When you only specify a container image, you can omit the `image` keyword. ```yaml jobs: my_job: - container: node:10.16-jessie + container: node:14.16 ``` ### `jobs..container.image` diff --git a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index a4c0796611..043e79414a 100644 --- a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -21,7 +21,7 @@ After you enable SAML SSO and SCIM for {% data variables.product.prodname_ghe_ma * Assign the {% data variables.product.prodname_ghe_managed %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.prodname_ghe_managed %} for connection to a team and its parent organization. * Unassign the {% data variables.product.prodname_ghe_managed %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. -For more information about managing identity and access for your enterprise on {% data variables.product.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." +For more information about managing identity and access for your enterprise on {% data variables.product.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." ### Prerequisites diff --git a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md index a0bd008285..6e936006e1 100644 --- a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md +++ b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md @@ -28,7 +28,7 @@ The provisioning application on your IdP communicates with {% data variables.pro {% data reusables.scim.supported-idps %} -When you set up user provisioning with a supported IdP, you can also assign or unassign the application for {% data variables.product.product_name %} to groups of users. These groups are then available to organization owners and team maintainers in {% data variables.product.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." +When you set up user provisioning with a supported IdP, you can also assign or unassign the application for {% data variables.product.product_name %} to groups of users. These groups are then available to organization owners and team maintainers in {% data variables.product.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." ### Prerequisites diff --git a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md index 7edc128771..fb9bf6d64d 100644 --- a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md +++ b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md @@ -13,7 +13,7 @@ By default, authorized users can access your enterprise from any IP address. Ent {% data reusables.identity-and-permissions.ip-allow-lists-enable %} -You can also configure allowed IP addresses for an individual organization. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization)." +You can also configure allowed IP addresses for an individual organization. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." By default, Azure network security group (NSG) rules leave all inbound traffic open on ports 22, 80, 443, and 25. Enterprise owners can contact {% data variables.contact.github_support %} to configure access restrictions for your instance. diff --git a/content/admin/enterprise-management/increasing-storage-capacity.md b/content/admin/enterprise-management/increasing-storage-capacity.md index 1db8208731..0007b50b70 100644 --- a/content/admin/enterprise-management/increasing-storage-capacity.md +++ b/content/admin/enterprise-management/increasing-storage-capacity.md @@ -31,7 +31,10 @@ As more users join {% data variables.product.product_location %}, you may need t 1. Resize the existing user volume disk using your virtualization platform's tools. {% data reusables.enterprise_installation.ssh-into-instance %} 3. Put the appliance in maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)." -4. Reboot the appliance to detect the new storage allocation. +4. Reboot the appliance to detect the new storage allocation: + ```shell + $ sudo reboot + ``` 5. Run the `ghe-storage-extend` command to expand the `/data/user` filesystem: ```shell $ ghe-storage-extend @@ -40,7 +43,10 @@ As more users join {% data variables.product.product_location %}, you may need t ### Increasing the root partition size using a new appliance 1. Set up a new {% data variables.product.prodname_ghe_server %} instance with a larger root disk using the same version as your current appliance. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." -2. Shut down the current appliance. +2. Shut down the current appliance: + ```shell + $ sudo poweroff + ``` 3. Detach the data disk from the current appliance using your virtualization platform's tools. 4. Attach the data disk to the new appliance with the larger root disk. @@ -57,6 +63,9 @@ As more users join {% data variables.product.product_location %}, you may need t ```shell $ ghe-upgrade PACKAGE-NAME.pkg -s -t /dev/xvdg1 ``` -4. Shut down the appliance. +4. Shut down the appliance: + ```shell + $ sudo poweroff + ``` 5. In the hypervisor, remove the old root disk and attach the new root disk at the same location as the old root disk. 6. Start the appliance. diff --git a/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md b/content/admin/github-actions/about-using-actions-in-your-enterprise.md similarity index 53% rename from content/admin/github-actions/about-using-actions-on-github-enterprise-server.md rename to content/admin/github-actions/about-using-actions-in-your-enterprise.md index e87d29f61f..0e87f21491 100644 --- a/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md +++ b/content/admin/github-actions/about-using-actions-in-your-enterprise.md @@ -1,40 +1,43 @@ --- -title: About using actions on GitHub Enterprise Server -intro: '{% data variables.product.prodname_ghe_server %} includes most {% data variables.product.prodname_dotcom %}-authored actions, and has options for enabling access to other actions from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_marketplace %}.' +title: About using actions in your enterprise +intro: '{% data variables.product.product_name %} includes most {% data variables.product.prodname_dotcom %}-authored actions, and has options for enabling access to other actions from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_marketplace %}.' redirect_from: - /enterprise/admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server - /admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server + - /admin/github-actions/about-using-actions-on-github-enterprise-server versions: enterprise-server: '>=2.22' + github-ae: 'next' topics: - enterprise --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data variables.product.prodname_actions %} workflows can use _actions_, which are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. {% data reusables.actions.enterprise-no-internet-actions %} -### Official actions bundled with {% data variables.product.prodname_ghe_server %} +### Official actions bundled with your enterprise instance -Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.prodname_ghe_server %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}. When your {% data variables.product.prodname_ghe_server %} instance is updated, the bundled official actions are also updated. +Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.product_name %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}. The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see all the official actions included on your enterprise instance, browse to the `actions` organization on your instance: https://HOSTNAME/actions. -Each action is a repository in the `actions` organization, and each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. +Each action is a repository in the `actions` organization, and each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. For information on how to update the bundled official actions, see "[Using the latest version of the official bundled actions](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)." {% note %} -**Note:** When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.prodname_ghe_server %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[Setting up the tool cache on self-hosted runners without internet access](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)." +**Note:** When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[Setting up the tool cache on self-hosted runners without internet access](/enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)." {% endnote %} ### Configuring access to actions on {% data variables.product.prodname_dotcom_the_website %} -If users on your enterprise instance need access to other actions from {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}, there are a few configuration options. +If users in your enterprise need access to other actions from {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}, there are a few configuration options. -The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". {% data reusables.actions.enterprise-limit-actions-use %} +The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". {% data reusables.actions.enterprise-limit-actions-use %} Alternatively, if you want stricter control over which actions are allowed in your enterprise, you can manually download and sync actions onto your enterprise instance using the `actions-sync` tool. For more information, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/github-actions/manually-syncing-actions-from-githubcom)." diff --git a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md index 8235057e02..588e25c8a3 100644 --- a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md +++ b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md @@ -1,25 +1,28 @@ --- title: Enabling automatic access to GitHub.com actions using GitHub Connect -intro: 'To allow {% data variables.product.prodname_actions %} on your enterprise instance to use actions from {% data variables.product.prodname_dotcom_the_website %}, you can connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_ghe_cloud %}.' -permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable access to all {% data variables.product.prodname_dotcom_the_website %} actions.' +intro: 'To allow {% data variables.product.prodname_actions %} in your enterprise to use actions from {% data variables.product.prodname_dotcom_the_website %}, you can connect your enterprise instance to {% data variables.product.prodname_ghe_cloud %}.' +permissions: 'Site administrators for {% data variables.product.product_name %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable access to all {% data variables.product.prodname_dotcom_the_website %} actions.' redirect_from: - /enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect versions: enterprise-server: '>=2.22' + github-ae: 'next' topics: - enterprise --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.enterprise-github-connect-warning %} +{% data reusables.actions.ae-beta %} -By default, {% data variables.product.prodname_actions %} workflows on {% data variables.product.prodname_ghe_server %} cannot use actions directly from {% data variables.product.prodname_dotcom_the_website %} or [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). +By default, {% data variables.product.prodname_actions %} workflows on {% data variables.product.product_name %} cannot use actions directly from {% data variables.product.prodname_dotcom_the_website %} or [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). -To make all actions from {% data variables.product.prodname_dotcom_the_website %} available on your enterprise instance, you can use {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_ghe_cloud %}. For other ways of accessing actions from {% data variables.product.prodname_dotcom_the_website %}, see "[About using actions on {% data variables.product.prodname_ghe_server %}](/admin/github-actions/about-using-actions-on-github-enterprise-server)." +To make all actions from {% data variables.product.prodname_dotcom_the_website %} available on your enterprise instance, you can use {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For other ways of accessing actions from {% data variables.product.prodname_dotcom_the_website %}, see "[About using actions in your enterprise](/admin/github-actions/about-using-actions-in-your-enterprise)." ### Enabling automatic access to all {% data variables.product.prodname_dotcom_the_website %} actions -Before enabling access to all actions from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location_enterprise %}, you must connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/enterprise/{{ currentVersion }}/admin/guides/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)." +Before enabling access to all actions from {% data variables.product.prodname_dotcom_the_website %} on your enterprise instance, you must connect your enterprise to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/enterprise/{{ currentVersion }}/admin/guides/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md index 4cba468196..bd74d9004e 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md @@ -116,7 +116,7 @@ To run {% data variables.product.prodname_actions %} workflows, you need to add You can control which actions your users are allowed to use in your enterprise. This includes setting up {% data variables.product.prodname_github_connect %} for automatic access to actions from {% data variables.product.prodname_dotcom_the_website %}, or manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}. -For more information, see "[About using actions on {% data variables.product.prodname_ghe_server %}](/admin/github-actions/about-using-actions-on-github-enterprise-server)." +For more information, see "[About using actions in your enterprise](/admin/github-actions/about-using-actions-in-your-enterprise)." ### General security hardening for {% data variables.product.prodname_actions %} diff --git a/content/admin/github-actions/index.md b/content/admin/github-actions/index.md index e11d3b7f61..e769835b7f 100644 --- a/content/admin/github-actions/index.md +++ b/content/admin/github-actions/index.md @@ -29,7 +29,7 @@ topics: {% link_in_list /enforcing-github-actions-policies-for-your-enterprise %} {% topic_link_in_list /managing-access-to-actions-from-githubcom %} - {% link_in_list /about-using-actions-on-github-enterprise-server %} + {% link_in_list /about-using-actions-in-your-enterprise %} {% link_in_list /enabling-automatic-access-to-githubcom-actions-using-github-connect %} {% link_in_list /manually-syncing-actions-from-githubcom %} {% link_in_list /using-the-latest-version-of-the-official-bundled-actions %} diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom.md index 78e01a4ca3..f1b4ee85c8 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom.md @@ -6,6 +6,7 @@ redirect_from: - /enterprise/admin/github-actions/managing-access-to-actions-from-githubcom versions: enterprise-server: '>=2.22' + github-ae: 'next' topics: - enterprise --- diff --git a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md index 3f8f07e6ba..d12fdc41a0 100644 --- a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md +++ b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md @@ -1,26 +1,28 @@ --- title: Manually syncing actions from GitHub.com -intro: 'For users that need access to actions from {% data variables.product.prodname_dotcom_the_website %}, you can sync specific actions to your {% data variables.product.prodname_ghe_server %} instance.' +intro: 'For users that need access to actions from {% data variables.product.prodname_dotcom_the_website %}, you can sync specific actions to your enterprise.' redirect_from: - /enterprise/admin/github-actions/manually-syncing-actions-from-githubcom versions: enterprise-server: '>=2.22' + github-ae: 'next' topics: - enterprise --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.actions.enterprise-no-internet-actions %} -The recommended approach of enabling access to actions from {% data variables.product.prodname_dotcom_the_website %} is to enable automatic access to all actions. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_ghe_cloud %} . For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". +The recommended approach of enabling access to actions from {% data variables.product.prodname_dotcom_the_website %} is to enable automatic access to all actions. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %} . For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)". -However, if you want stricter control over which actions are allowed in your enterprise, you can follow this guide to use {% data variables.product.company_short %}'s open source [`actions-sync`](https://github.com/actions/actions-sync) tool to sync individual action repositories from {% data variables.product.prodname_dotcom_the_website %} to your enterprise instance. +However, if you want stricter control over which actions are allowed in your enterprise, you can follow this guide to use {% data variables.product.company_short %}'s open source [`actions-sync`](https://github.com/actions/actions-sync) tool to sync individual action repositories from {% data variables.product.prodname_dotcom_the_website %} to your enterprise. ### About the `actions-sync` tool -The `actions-sync` tool must be run on a machine that can access the {% data variables.product.prodname_dotcom_the_website %} API and your {% data variables.product.prodname_ghe_server %} instance's API. The machine doesn't need to be connected to both at the same time. +The `actions-sync` tool must be run on a machine that can access the {% data variables.product.prodname_dotcom_the_website %} API and your {% data variables.product.product_name %} instance's API. The machine doesn't need to be connected to both at the same time. If your machine has access to both systems at the same time, you can do the sync with a single `actions-sync sync` command. If you can only access one system at a time, you can use the `actions-sync pull` and `push` commands. @@ -28,8 +30,21 @@ The `actions-sync` tool can only download actions from {% data variables.product ### Prerequisites -* Before using the `actions-sync` tool, you must ensure that all destination organizations already exist on your enterprise instance. The following example demonstrates how to sync actions to an organization named `synced-actions` on an enterprise instance. For more information, see "[Creating a new organization from scratch](/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch)." -* You must create a personal access token (PAT) on your enterprise instance that can create and write to repositories in the destination organizations. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +* Before using the `actions-sync` tool, you must ensure that all destination organizations already exist in your enterprise. The following example demonstrates how to sync actions to an organization named `synced-actions`. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +* You must create a personal access token (PAT) on your enterprise that can create and write to repositories in the destination organizations. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +* If you want to sync the bundled actions in the `actions` organization on {% data variables.product.product_location %}, you must be an owner of the `actions` organization. + + {% note %} + + **Note:** By default, even site administrators are not owners of the bundled `actions` organization. + + {% endnote %} + + Site administrators can use the `ghe-org-admin-promote` command in the administrative shell to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." + + ```shell + ghe-org-admin-promote -u USERNAME -o actions + ``` ### Example: Using the `actions-sync` tool @@ -37,7 +52,7 @@ This example demonstrates using the `actions-sync` tool to sync an individual ac {% note %} -**Note:** This example uses the `actions-sync sync` command, which requires concurrent access to both the {% data variables.product.prodname_dotcom_the_website %} API and your {% data variables.product.prodname_ghe_server %} instance's API from your machine. If you can only access one system at a time, you can use the `actions-sync pull` and `push` commands. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#not-connected-instances). +**Note:** This example uses the `actions-sync sync` command, which requires concurrent access to both the {% data variables.product.prodname_dotcom_the_website %} API and your enterprise instance's API from your machine. If you can only access one system at a time, you can use the `actions-sync pull` and `push` commands. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#not-connected-instances). {% endnote %} @@ -60,10 +75,10 @@ This example demonstrates using the `actions-sync` tool to sync an individual ac * `--destination-url`: The URL of the destination enterprise instance. * `--repo-name`: The action repository to sync. This takes the format of `owner/repository:destination_owner/destination_repository`. - * The above example syncs the [`docker/build-push-action`](https://github.com/docker/build-push-action) repository to the `synced-actions/docker-build-push-action` repository on the destination {% data variables.product.prodname_ghe_server %} instance. You must create the organization named `synced-actions` on your enterprise instance before running the above command. - * If you omit `:destination_owner/destination_repository`, the tool uses the original owner and repository name for your enterprise instance. Before running the command, you must create a new organization on your instance that matches the owner name of the action. Consider using a central organization to store the synced actions on your instance, as this means you will not need to create multiple new organizations if you sync actions from different owners. + * The above example syncs the [`docker/build-push-action`](https://github.com/docker/build-push-action) repository to the `synced-actions/docker-build-push-action` repository on the destination enterprise instance. You must create the organization named `synced-actions` in your enterprise before running the above command. + * If you omit `:destination_owner/destination_repository`, the tool uses the original owner and repository name for your enterprise. Before running the command, you must create a new organization in your enterprise that matches the owner name of the action. Consider using a central organization to store the synced actions in your enterprise, as this means you will not need to create multiple new organizations if you sync actions from different owners. * You can sync multiple actions by replacing the `--repo-name` parameter with `--repo-name-list` or `--repo-name-list-file`. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#actions-sync). -1. After the action repository is created on your enterprise instance, people in your enterprise can use the destination repository to reference the action in their workflows. For the example action shown above: +1. After the action repository is created in your enterprise, people in your enterprise can use the destination repository to reference the action in their workflows. For the example action shown above: ```yaml uses: synced-actions/docker-build-push-action@v1 diff --git a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md index a380a9961e..6b6ad117ba 100644 --- a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md +++ b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md @@ -5,18 +5,20 @@ redirect_from: - /enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access versions: enterprise-server: '>=2.22' + github-ae: 'next' topics: - enterprise --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About the included setup actions and the runner tool cache {% data reusables.actions.enterprise-no-internet-actions %} -Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.prodname_ghe_server %}. However, self-hosted runners without internet access will require some configuration before they can use the included `actions/setup-LANGUAGE` actions, such as `setup-node`. +Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.product_name %}. However, self-hosted runners without internet access require some configuration before they can use the included `actions/setup-LANGUAGE` actions, such as `setup-node`. The `actions/setup-LANGUAGE` actions normally need internet access to download the required environment binaries into the runner's tool cache. Self-hosted runners without internet access can't download the binaries, so you must manually populate the tool cache on the runner. diff --git a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md index ae208f091b..3325c53ca0 100644 --- a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md +++ b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md @@ -1,24 +1,21 @@ --- title: Using the latest version of the official bundled actions -intro: 'You can update the actions that are bundled with your {% data variables.product.prodname_ghe_server %} instance, or use actions directly from {% data variables.product.prodname_dotcom_the_website %}.' +intro: 'You can update the actions that are bundled with your enterprise, or use actions directly from {% data variables.product.prodname_dotcom_the_website %}.' versions: enterprise-server: '>=2.22' + github-ae: 'next' topics: - enterprise --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} -Your {% data variables.product.prodname_ghe_server %} instance includes a number of built-in actions that you can use in your workflows. For more information about the bundled actions, see ["Official actions bundled with {% data variables.product.prodname_ghe_server %}"](/admin/github-actions/about-using-actions-on-github-enterprise-server#official-actions-bundled-with-github-enterprise-server). +Your enterprise instance includes a number of built-in actions that you can use in your workflows. For more information about the bundled actions, see "[Official actions bundled with your enterprise instance](/admin/github-actions/about-using-actions-in-your-enterprise#official-actions-bundled-with-your-enterprise-instance)." These bundled actions are a point-in-time snapshot of the official actions found at https://github.com/actions; as a result, these actions may be older versions that can be updated. To update these actions, you can use `actions-sync` to retrieve updated versions from {% data variables.product.prodname_dotcom_the_website %}. -Alternatively, if your {% data variables.product.prodname_ghe_server %} instance has {% data variables.product.prodname_github_connect %} enabled, then you have additional options for using the latest actions from {% data variables.product.prodname_dotcom_the_website %}: - -- Your workflow file can directly reference a specific tag that only exists on {% data variables.product.prodname_dotcom_the_website %}. -- To force the workflow file to use the actions on {% data variables.product.prodname_dotcom_the_website %}, you can edit the tag assigned to the bundled actions. - These options are described in more detail in the following sections. ### Using actions-sync to update a bundled action @@ -27,19 +24,6 @@ To update the bundled actions, you can use the `actions-sync` tool to synchroniz ### Using actions from {% data variables.product.prodname_dotcom_the_website %} -{% data reusables.github-actions.actions-github-connect-requirement %} +To allow {% data variables.product.product_name %} to use actions directly from {% data variables.product.prodname_dotcom_the_website %}, you can use {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." Once configured, you can use a new version of an action from {% data variables.product.prodname_dotcom_the_website %} by manually specifying the required version in the workflow file. For example, to use version `v2.2.1` of `actions/setup-python` from {% data variables.product.prodname_dotcom_the_website %}, you can specify the tag `actions/setup-python@v2.2.1` in your workflow file. - -### Using the latest version by removing the specific action's tag - -{% data reusables.github-actions.actions-github-connect-requirement %} - -If you remove the version tag that was previously assigned to an action, {% data variables.product.prodname_ghe_server %} will check {% data variables.product.prodname_dotcom_the_website %} for the required tag. For more information on working with tags, see "[Viewing tags](/github/administering-a-repository/viewing-your-repositorys-releases-and-tags#viewing-tags)." - -For example, to use version `v2.2.1` of `actions/setup-python` from {% data variables.product.prodname_dotcom_the_website %}: - -1. In {% data variables.product.prodname_ghe_server %}, delete the `v2` tag from the `actions/setup-python` repository. -1. Create a workflow that uses `actions/setup-python` with the `v2` tag. - -When the workflow is unable to find the specified `v2` tag on {% data variables.product.prodname_ghe_server %}, it checks {% data variables.product.prodname_dotcom_the_website %} for the required tag. If it finds a tagged version of that action, {% data variables.product.prodname_ghe_server %} uses the version from {% data variables.product.prodname_dotcom_the_website %}. diff --git a/content/admin/overview/github-ae-release-notes.md b/content/admin/overview/github-ae-release-notes.md index ec75725972..dbd6bc961a 100644 --- a/content/admin/overview/github-ae-release-notes.md +++ b/content/admin/overview/github-ae-release-notes.md @@ -29,7 +29,7 @@ During this beta, {% data variables.product.prodname_advanced_security %} featur #### Manage teams from your identity provider (IdP) -Customers using SCIM (System for Cross-domain Identity Management) can now sync security groups in Azure Active Directory with {% data variables.product.company_short %} teams. Once a team has been linked to a security group, membership will be automatically updated in {% data variables.product.product_name %} when a user is added or removed from their assigned security group. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." +Customers using SCIM (System for Cross-domain Identity Management) can now sync security groups in Azure Active Directory with {% data variables.product.company_short %} teams. Once a team has been linked to a security group, membership will be automatically updated in {% data variables.product.product_name %} when a user is added or removed from their assigned security group. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." #### IP allow lists beta @@ -37,7 +37,7 @@ Enterprise and organization owners can now use IP allow lists to restrict traffi This functionality is provided in addition to the ability to request network security group changes that filter traffic to the entirety of the {% data variables.product.product_name %} tenant. -For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)" and "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization)." +For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." #### Pull request auto-merge @@ -47,7 +47,7 @@ With auto-merge, pull requests can be set to merge automatically when all merge #### Developer changes -- [Organization owners can now disable publication](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites. +- [Organization owners can now disable publication](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites. - Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/pages/getting-started-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites). - When writing an issue or pull request, the list syntax for bullets, numbers, and tasks will now be autocompleted after you press `return` or `enter`. - You can now delete a directory in a repository from the repository page. When navigating to a directory, a new kebab button next to the "Add file" button gives the option to delete the directory. @@ -65,7 +65,7 @@ With auto-merge, pull requests can be set to merge automatically when all merge ##### Default branch renaming -Enterprise and organization owners can now set the default branch name for new repositories. Enterprise owners can also enforce their choice of default branch name across all organizations or allow individual organizations to choose their own. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)" and "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)." +Enterprise and organization owners can now set the default branch name for new repositories. Enterprise owners can also enforce their choice of default branch name across all organizations or allow individual organizations to choose their own. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)" and "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)." Existing repositories are unaffected by these settings, and their default branch name will not be changed. diff --git a/content/admin/user-management/managing-projects-using-jira.md b/content/admin/user-management/managing-projects-using-jira.md index c6ea376e22..a5ee42f60c 100644 --- a/content/admin/user-management/managing-projects-using-jira.md +++ b/content/admin/user-management/managing-projects-using-jira.md @@ -1,6 +1,6 @@ --- -title: Managing projects using JIRA -intro: 'You can integrate JIRA with {% data variables.product.prodname_enterprise %} for project management.' +title: Managing projects using Jira +intro: 'You can integrate Jira with {% data variables.product.prodname_enterprise %} for project management.' redirect_from: - /enterprise/admin/guides/installation/project-management-using-jira/ - /enterprise/admin/articles/project-management-using-jira/ @@ -13,34 +13,54 @@ topics: - enterprise --- -### Connecting JIRA to a {% data variables.product.prodname_enterprise %} organization +### Connecting Jira to a {% data variables.product.prodname_enterprise %} organization -1. Sign into your {% data variables.product.prodname_enterprise %} account at http[s]://[hostname]/login. -1. In the upper right corner of any page, click the account settings (gear) icon. -1. In the left sidebar, click the name of your organization. -1. In the left sidebar, click **Applications**. -1. In the upper right corner of the **Organization applications** box, click **Register new application**. -1. Fill in the application settings: - - In the **Application name** field, type "JIRA". - - In the **Homepage URL** field, type the full URL of your JIRA instance. - - In the **Authorization callback URL** field, type the full URL of your JIRA instance. -1. Click **Register application**. -1. At the top of the page, note the **Client ID** and **Client Secret**. You will need these for configuring your JIRA instance. +1. Sign into your {% data variables.product.prodname_enterprise %} account at http[s]://[hostname]/login. If already signed in, click on the {% data variables.product.prodname_dotcom %} logo in the top left corner. +2. Click on your profile icon under the {% data variables.product.prodname_dotcom %} logo and select the organization you would like to connect with Jira. -### JIRA instance configuration + ![Select an organization](/assets/images/enterprise/orgs-and-teams/profile-select-organization.png) -1. On your JIRA instance, log into an account with administrative access. -1. At the top of the page, click the settings (gear) icon. -1. In the settings dropdown, choose **Add-ons**. -1. In the left sidebar, under **Source control**, click **DVCS accounts**. -1. Click **Link Bitbucket or GitHub account**. -1. In the **Add New Account** modal, fill in your {% data variables.product.prodname_enterprise %} settings: - - From the **Host** dropdown menu, choose **GitHub Enterprise**. +3. Click on the **Edit _organization name_ settings** link. + + ![Edit organization settings](/assets/images/enterprise/orgs-and-teams/edit-organization-settings.png) + +4. In the left sidebar, under **Developer settings**, click **OAuth Apps**. + + ![Select OAuth Apps](/assets/images/enterprise/orgs-and-teams/organization-dev-settings-oauth-apps.png) + +5. Click on the **Register new application** button. + + ![Register new application button](/assets/images/enterprise/orgs-and-teams/register-oauth-application-button.png) + +6. Fill in the application settings: + - In the **Application name** field, type "Jira" or any name you would like to use to identify the Jira instance. + - In the **Homepage URL** field, type the full URL of your Jira instance. + - In the **Authorization callback URL** field, type the full URL of your Jira instance. +7. Click **Register application**. +8. At the top of the page, note the **Client ID** and **Client Secret**. You will need these for configuring your Jira instance. + +### Jira instance configuration + +1. On your Jira instance, log into an account with administrative access. +2. At the top of the page, click the settings (gear) icon and choose **Applications**. + + ![Select Applications on Jira settings](/assets/images/enterprise/orgs-and-teams/jira/jira-applications.png) + +3. In the left sidebar, under **Integrations**, click **DVCS accounts**. + + ![Jira Integrations menu - DVCS accounts](/assets/images/enterprise/orgs-and-teams/jira/jira-integrations-dvcs.png) + +4. Click **Link Bitbucket Cloud or {% data variables.product.prodname_dotcom %} account**. + + ![Link GitHub account to Jira](/assets/images/enterprise/orgs-and-teams/jira/jira-link-github-account.png) + +5. In the **Add New Account** modal, fill in your {% data variables.product.prodname_enterprise %} settings: + - From the **Host** dropdown menu, choose **{% data variables.product.prodname_enterprise %}**. - In the **Team or User Account** field, type the name of your {% data variables.product.prodname_enterprise %} organization or personal account. - In the **OAuth Key** field, type the Client ID of your {% data variables.product.prodname_enterprise %} developer application. - In the **OAuth Secret** field, type the Client Secret for your {% data variables.product.prodname_enterprise %} developer application. - - If you don't want to link new repositories owned by your {% data variables.product.prodname_enterprise %} organization or personal account, unselect **Auto Link New Repositories**. - - If you don't want to enable smart commits, unselect **Enable Smart Commits**. + - If you don't want to link new repositories owned by your {% data variables.product.prodname_enterprise %} organization or personal account, deselect **Auto Link New Repositories**. + - If you don't want to enable smart commits, deselect **Enable Smart Commits**. - Click **Add**. -1. Review the permissions you are granting to your {% data variables.product.prodname_enterprise %} account and click **Authorize application**. -1. If necessary, type your password to continue. +6. Review the permissions you are granting to your {% data variables.product.prodname_enterprise %} account and click **Authorize application**. +7. If necessary, type your password to continue. diff --git a/content/code-security/secret-security/about-secret-scanning.md b/content/code-security/secret-security/about-secret-scanning.md index 68b1598540..1915cbf242 100644 --- a/content/code-security/secret-security/about-secret-scanning.md +++ b/content/code-security/secret-security/about-secret-scanning.md @@ -45,7 +45,7 @@ When {% data variables.product.prodname_secret_scanning %} detects a set of cred {% data variables.product.prodname_secret_scanning_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. {% endif %} -If you're a repository administrator or an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for {% if currentVersion == "free-pro-team@latest" %} private{% endif %} repositories that are owned by organizations. You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization.{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_secret_scanning_caps %} is not available for user-owned private repositories.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +If you're a repository administrator or an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for {% if currentVersion == "free-pro-team@latest" %} private{% endif %} repositories that are owned by organizations. You can enable {% data variables.product.prodname_secret_scanning %} for all your repositories, or for all new repositories within your organization.{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_secret_scanning_caps %} is not available for user-owned private repositories.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." When you push commits to a{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of the commits for secrets. diff --git a/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md b/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md index ff7cd65eb8..de5374ce76 100644 --- a/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md +++ b/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md @@ -77,4 +77,4 @@ You can also ignore individual alerts from {% data variables.product.prodname_se ### Further reading -- "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" +- "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" diff --git a/content/code-security/secure-coding/about-code-scanning.md b/content/code-security/secure-coding/about-code-scanning.md index d0bbcb16bc..2b63cd2895 100644 --- a/content/code-security/secure-coding/about-code-scanning.md +++ b/content/code-security/secure-coding/about-code-scanning.md @@ -12,6 +12,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} @@ -59,7 +60,6 @@ You can view and contribute to the queries for {% data variables.product.prodnam ### Further reading -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} -- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)"{% endif %} +- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" - [{% data variables.product.prodname_security %}](https://securitylab.github.com/) - [OASIS Static Analysis Results Interchange Format (SARIF) TC](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=sarif) on the OASIS Committee website diff --git a/content/code-security/secure-coding/about-integration-with-code-scanning.md b/content/code-security/secure-coding/about-integration-with-code-scanning.md index 9d0a4e23ea..297a24c05e 100644 --- a/content/code-security/secure-coding/about-integration-with-code-scanning.md +++ b/content/code-security/secure-coding/about-integration-with-code-scanning.md @@ -12,6 +12,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors.md index 88add62dcb..210d9d385e 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors.md @@ -13,4 +13,4 @@ versions: topics: - security --- - + diff --git a/content/code-security/secure-coding/configuring-code-scanning.md b/content/code-security/secure-coding/configuring-code-scanning.md index 9f1e06a8b1..5c8ac92041 100644 --- a/content/code-security/secure-coding/configuring-code-scanning.md +++ b/content/code-security/secure-coding/configuring-code-scanning.md @@ -13,6 +13,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} diff --git a/content/code-security/secure-coding/configuring-codeql-code-scanning-in-your-ci-system.md b/content/code-security/secure-coding/configuring-codeql-code-scanning-in-your-ci-system.md index e938ab06cc..30cb6f2bdd 100644 --- a/content/code-security/secure-coding/configuring-codeql-code-scanning-in-your-ci-system.md +++ b/content/code-security/secure-coding/configuring-codeql-code-scanning-in-your-ci-system.md @@ -14,6 +14,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta-codeql-runner %} {% data reusables.code-scanning.beta %} diff --git a/content/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages.md b/content/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages.md index c3dce7fa78..d448dcfb4d 100644 --- a/content/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages.md @@ -15,6 +15,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} diff --git a/content/code-security/secure-coding/index.md b/content/code-security/secure-coding/index.md index cb7577cb39..4873568c26 100644 --- a/content/code-security/secure-coding/index.md +++ b/content/code-security/secure-coding/index.md @@ -1,7 +1,7 @@ --- title: Finding security vulnerabilities and errors in your code shortTitle: Secure coding -intro: 'Keep your code secure by using secret scanning to identify and fix potential security vulnerabilities and other errors in your code.' +intro: 'Keep your code secure by using {% data variables.product.prodname_code_scanning %} to identify and fix potential security vulnerabilities and other errors in your code.' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/managing-security-vulnerabilities/finding-security-vulnerabilities-in-your-projects-code @@ -13,6 +13,7 @@ versions: topics: - security --- + ### Table of Contents diff --git a/content/code-security/secure-coding/integrating-with-code-scanning.md b/content/code-security/secure-coding/integrating-with-code-scanning.md index 575eeb5caf..6aaceb4c9f 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning.md @@ -14,4 +14,4 @@ versions: topics: - security --- - + diff --git a/content/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository.md b/content/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository.md index 1873a772bb..25ade63a64 100644 --- a/content/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository.md +++ b/content/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository.md @@ -1,7 +1,7 @@ --- title: Managing code scanning alerts for your repository shortTitle: Managing alerts -intro: 'From the security view, you can view, fix, {% if currentVersion == "enterprise-server@2.22" %}or close{% else %}dismiss, or delete{% endif %} alerts for potential vulnerabilities or errors in your project''s code.' +intro: 'From the security view, you can view, fix, dismiss, or delete alerts for potential vulnerabilities or errors in your project''s code.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.' versions: @@ -15,6 +15,7 @@ redirect_from: topics: - security --- + {% data reusables.code-scanning.beta %} @@ -63,7 +64,7 @@ You need write permission to view a summary of all the alerts for a repository o Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." -If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have {% if currentVersion == "enterprise-server@2.22" %}closed{% else %}dismissed{% endif %}. +If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have dismissed. Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. @@ -73,14 +74,6 @@ Alerts may be fixed in one branch but not in another. You can use the "Branch" d ![Filtering alerts by branch](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) {% endif %} -{% if currentVersion == "enterprise-server@2.22" %} - -### Closing an alert - -Closing an alert is a way to resolve an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} - -{% else %} - ### Dismissing or deleting alerts There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab. @@ -104,20 +97,9 @@ When you delete an alert: To dismiss or delete alerts: -{% endif %} - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} -{% if currentVersion == "enterprise-server@2.22" %} -{% data reusables.code-scanning.click-alert-in-list %} -1. Select the **Close** drop-down menu and click a reason for closing the alert. - ![Choosing reason for closing the alert via the Close drop-down](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) - -{% data reusables.code-scanning.false-positive-fix-codeql %} - -{% else %} - 1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**. ![Deleting alerts](/assets/images/help/repository/code-scanning-delete-alerts.png) @@ -149,8 +131,6 @@ To dismiss or delete alerts: If a project has multiple alerts that you want to dismiss for the same reason, you can bulk dismiss them from the summary of alerts. Typically, you'll want to filter the list and then dismiss all of the matching alerts. For example, you might want to dismiss all of the current alerts in the project that have been tagged for a particular Common Weakness Enumeration (CWE) vulnerability. -{% endif %} - ### Further reading - "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" diff --git a/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md b/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md index 240ad20ad8..0838bf8d03 100644 --- a/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md @@ -12,6 +12,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} diff --git a/content/code-security/secure-coding/running-codeql-code-scanning-in-your-ci-system.md b/content/code-security/secure-coding/running-codeql-code-scanning-in-your-ci-system.md index de00f2d6b2..549e6d493e 100644 --- a/content/code-security/secure-coding/running-codeql-code-scanning-in-your-ci-system.md +++ b/content/code-security/secure-coding/running-codeql-code-scanning-in-your-ci-system.md @@ -13,6 +13,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta-codeql-runner %} @@ -44,7 +45,7 @@ The {% data variables.product.prodname_codeql_runner %} is a command-line tool t ### Downloading the {% data variables.product.prodname_codeql_runner %} -You can download the {% data variables.product.prodname_codeql_runner %} from https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. +You can download the {% data variables.product.prodname_codeql_runner %} from https://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. On Linux: @@ -66,7 +67,7 @@ On Windows, the `codeql-runner-win.exe` file usually requires no change to permi Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell -wget https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux +wget https://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` @@ -77,9 +78,7 @@ In addition to this, each CI server also needs: The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. Allow the CI servers access to https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. -{% if currentVersion == "enterprise-server@2.22" %} -1. Mirror the `github/codeql-action` repository on {% data variables.product.product_name %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} +1. Allow the CI servers access to https://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. 1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. ### Calling the {% data variables.product.prodname_codeql_runner %} diff --git a/content/code-security/secure-coding/sarif-support-for-code-scanning.md b/content/code-security/secure-coding/sarif-support-for-code-scanning.md index ffb2663941..43d3931cbc 100644 --- a/content/code-security/secure-coding/sarif-support-for-code-scanning.md +++ b/content/code-security/secure-coding/sarif-support-for-code-scanning.md @@ -13,6 +13,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} diff --git a/content/code-security/secure-coding/setting-up-code-scanning-for-a-repository.md b/content/code-security/secure-coding/setting-up-code-scanning-for-a-repository.md index 91b9a5c7b3..3bdc51faeb 100644 --- a/content/code-security/secure-coding/setting-up-code-scanning-for-a-repository.md +++ b/content/code-security/secure-coding/setting-up-code-scanning-for-a-repository.md @@ -16,6 +16,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} @@ -32,7 +33,7 @@ You decide how to generate {% data variables.product.prodname_code_scanning %} a {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +3. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} !["Set up {% data variables.product.prodname_code_scanning %}" button to the right of "{% data variables.product.prodname_code_scanning_capc %}" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) 4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.product.prodname_codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository.{% endif %} diff --git a/content/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests.md b/content/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests.md index 3e7fd38c1a..91229e734a 100644 --- a/content/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests.md @@ -13,6 +13,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} @@ -20,7 +21,7 @@ topics: In repositories where {% data variables.product.prodname_code_scanning %} is configured as a pull request check, {% data variables.product.prodname_code_scanning %} checks the code in the pull request. By default, this is limited to pull requests that target the default branch, but you can change this configuration within {% data variables.product.prodname_actions %} or in a third-party CI/CD system. If merging the changes would introduce new {% data variables.product.prodname_code_scanning %} alerts to the target branch, these are reported as check results in the pull request. The alerts are also shown as annotations in the **Files changed** tab of the pull request. If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." -If {% data variables.product.prodname_code_scanning %} has any results with a severity of `error`, the check fails and the error is reported in the check results. If all the results found by {% data variables.product.prodname_code_scanning %} have lower severities, the alerts are treated as warnings or notices and the check succeeds. If your pull request targets a protected branch that uses {% data variables.product.prodname_code_scanning %}, and the repository owner has configured required status checks, then you must either fix or {% if currentVersion == "enterprise-server@2.22" %}close{% else %}dismiss{% endif %} all error alerts before the pull request can be merged. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." +If {% data variables.product.prodname_code_scanning %} has any results with a severity of `error`, the check fails and the error is reported in the check results. If all the results found by {% data variables.product.prodname_code_scanning %} have lower severities, the alerts are treated as warnings or notices and the check succeeds. If your pull request targets a protected branch that uses {% data variables.product.prodname_code_scanning %}, and the repository owner has configured required status checks, then you must either fix or dismiss all error alerts before the pull request can be merged. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." ![Failed {% data variables.product.prodname_code_scanning %} check on a pull request](/assets/images/help/repository/code-scanning-check-failure.png) @@ -44,18 +45,10 @@ In the detailed view for an alert, some {% data variables.product.prodname_code_ ![Alert description and link to show more information](/assets/images/help/repository/code-scanning-pr-alert.png) -### {% if currentVersion == "enterprise-server@2.22" %}Resolving{% else %}Fixing{% endif %} an alert on your pull request +### Fixing an alert on your pull request Anyone with push access to a pull request can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on that pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed. -{% if currentVersion == "enterprise-server@2.22" %} - -If you don't think that an alert needs to be fixed, users with write permission can close the alert manually. {% data reusables.code-scanning.close-alert-examples %} The **Close** button is available in annotations and in the alerts view if you have write permission for the repository. - -{% data reusables.code-scanning.false-positive-fix-codeql %} - -{% else %} - ### Dismissing an alert on your pull request An alternative way of closing an alert is to dismiss it. You can dismiss an alert if you don't think it needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} If you have write permission for the repository, the **Dismiss** button is available in code annotations and in the alerts summary. When you click **Dismiss** you will be prompted to choose a reason for closing the alert. @@ -66,6 +59,4 @@ An alternative way of closing an alert is to dismiss it. You can dismiss an aler {% data reusables.code-scanning.false-positive-fix-codeql %} -For more information about dismissing alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)." - -{% endif %} +For more information about dismissing alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)." diff --git a/content/code-security/secure-coding/troubleshooting-codeql-code-scanning-in-your-ci-system.md b/content/code-security/secure-coding/troubleshooting-codeql-code-scanning-in-your-ci-system.md index 36f2f621eb..c05c126050 100644 --- a/content/code-security/secure-coding/troubleshooting-codeql-code-scanning-in-your-ci-system.md +++ b/content/code-security/secure-coding/troubleshooting-codeql-code-scanning-in-your-ci-system.md @@ -13,6 +13,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta-codeql-runner %} {% data reusables.code-scanning.beta %} diff --git a/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md b/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md index 2353e87c59..09891aae69 100644 --- a/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md +++ b/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md @@ -13,6 +13,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.not-available %} diff --git a/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md b/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md index 28b6dbc560..6706d947f6 100644 --- a/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md +++ b/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md @@ -14,6 +14,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} @@ -24,7 +25,7 @@ topics: You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)." -You can upload the results using {% data variables.product.prodname_actions %}{% if currentVersion == "enterprise-server@2.22" %} (available if your organization is taking part in the beta program){% endif %}, the {% data variables.product.prodname_code_scanning %} API, or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: +You can upload the results using {% data variables.product.prodname_actions %}, the {% data variables.product.prodname_code_scanning %} API, or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: - {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis. - {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below). diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system.md index cbeb534682..2deae2dcf1 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system.md @@ -13,4 +13,5 @@ versions: topics: - security --- + diff --git a/content/code-security/security-overview/exploring-security-alerts.md b/content/code-security/security-overview/exploring-security-alerts.md index 3e9d077fe4..45c7c67a68 100644 --- a/content/code-security/security-overview/exploring-security-alerts.md +++ b/content/code-security/security-overview/exploring-security-alerts.md @@ -11,7 +11,7 @@ versions: ### About the security overview -You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository)." +You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." The security overview indicates whether {% data variables.product.prodname_GH_advanced_security %} features are enabled for repositories owned by your organization and consolidates alerts from {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} alerts, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[About securing your repository](/code-security/getting-started/about-securing-your-repository)." diff --git a/content/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies.md b/content/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies.md index 6e385e03eb..6d7a62b89d 100644 --- a/content/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies.md @@ -1,6 +1,6 @@ --- title: About alerts for vulnerable dependencies -intro: '{% data variables.product.product_name %} sends {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} when we detect vulnerabilities affecting your repository.' +intro: '{% data variables.product.product_name %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository.' redirect_from: - /articles/about-security-alerts-for-vulnerable-dependencies - /github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies @@ -11,6 +11,7 @@ versions: topics: - security --- + ### About vulnerable dependencies @@ -21,12 +22,12 @@ When your code depends on a package that has a security vulnerability, this vuln ### Detection of vulnerable dependencies - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %}{% else %}{% data variables.product.product_name %} detects vulnerable dependencies and sends security alerts{% endif %} when: +{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %} when: {% if currentVersion == "free-pro-team@latest" %} -- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)."{% else %} -- New advisory data is synchronized to {% data variables.product.prodname_ghe_server %} each hour from {% data variables.product.prodname_dotcom_the_website %}. For more information about advisory data, see "Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}."{% endif %} -- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% if currentVersion == "free-pro-team@latest" %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} +- New advisory data is synchronized to {% data variables.product.prodname_ghe_server %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} +- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% if currentVersion == "free-pro-team@latest" %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)." {% data reusables.repositories.dependency-review %} @@ -38,58 +39,41 @@ For a list of the ecosystems that {% data variables.product.product_name %} can {% endnote %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" % %} ### {% data variables.product.prodname_dependabot %} alerts for vulnerable dependencies -{% else %} -### Security alerts for vulnerable dependencies -{% endif %} {% data reusables.repositories.enable-security-alerts %} {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies in _public_ repositories and generates {% data variables.product.prodname_dependabot_alerts %} by default. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories. -You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -For information about permission requirements for actions related to {% data variables.product.prodname_dependabot_alerts %}, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-requirements-for-security-features)." +For information about permission requirements for actions related to {% data variables.product.prodname_dependabot_alerts %}, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#permission-requirements-for-security-features)." {% data variables.product.product_name %} starts generating the dependency graph immediately and generates alerts for any vulnerable dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)." {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} When {% data variables.product.product_name %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. The alert includes a link to the affected file in the project, and information about a fixed version. {% data variables.product.product_name %} also notifies the maintainers of affected repositories about the new alert according to their notification preferences. For more information, see "[Configuring notifications for vulnerable dependencies](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)." -{% endif %} {% if currentVersion == "free-pro-team@latest" %} For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, the alert may also contain a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} -When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a security alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version. -{% endif %} - {% warning %} **Note**: {% data variables.product.product_name %}'s security features do not claim to catch all vulnerabilities. Though we are always trying to update our vulnerability database and generate alerts with our most up-to-date information, we will not be able to catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough vulnerability review when necessary. {% endwarning %} -### Access to {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts +### Access to {% data variables.product.prodname_dependabot %} alerts -You can see all of the alerts that affect a particular project{% if currentVersion == "free-pro-team@latest" %} on the repository's Security tab or{% endif %} in the repository's dependency graph.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."{% endif %} +You can see all of the alerts that affect a particular project{% if currentVersion == "free-pro-team@latest" %} on the repository's Security tab or{% endif %} in the repository's dependency graph. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} -By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}.{% endif %} {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." +By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} -We send security alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. -{% endif %} +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %} For more information, see "[Configuring notifications for vulnerable dependencies](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)." -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %} For more information, see "[Choosing the delivery method for your notifications](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %} For more information, see "[Configuring notifications for vulnerable dependencies](/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies)."{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} -You can also see all the {% data variables.product.prodname_dependabot_alerts %} that correspond to a particular vulnerability in the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database#viewing-your-vulnerable-repositories)." -{% endif %} +You can also see all the {% data variables.product.prodname_dependabot_alerts %} that correspond to a particular vulnerability in the {% data variables.product.prodname_advisory_database %}. {% data reusables.security-advisory.link-browsing-advisory-db %} {% if currentVersion == "free-pro-team@latest" %} ### Further reading diff --git a/content/code-security/supply-chain-security/about-the-dependency-graph.md b/content/code-security/supply-chain-security/about-the-dependency-graph.md index 3f516de9cb..20423a438d 100644 --- a/content/code-security/supply-chain-security/about-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/about-the-dependency-graph.md @@ -9,6 +9,7 @@ versions: topics: - repositories --- + ### Dependency graph availability @@ -59,10 +60,6 @@ You can use the dependency graph to: {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}If the dependency graph is not available in your system, your site administrator can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} If the dependency graph is not available in your system, your site administrator can enable the dependency graph and security alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)." - -{% endif %} - When the dependency graph is first enabled, any manifest and lock files for supported ecosystems are parsed immediately. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. Once enabled, the graph is automatically updated with every push to the repository{% if currentVersion == "free-pro-team@latest" %} and every push to other repositories in the graph{% endif %}. ### Supported package ecosystems @@ -89,6 +86,6 @@ The recommended formats explicitly define which versions are used for all direct - "[Dependency graph](https://en.wikipedia.org/wiki/Dependency_graph)" on Wikipedia - "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)"{% if currentVersion == "free-pro-team@latest" %} -- "[Viewing insights for your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization)" +- "[Viewing insights for your organization](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"{% endif %} - "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)"{% endif %} +- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)" diff --git a/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md b/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md index d4debc6b6c..d5aaa3cb1d 100644 --- a/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md +++ b/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md @@ -321,7 +321,7 @@ updates: {% note %} -**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)." +**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)." {% endnote %} @@ -767,6 +767,19 @@ registries: ``` {% endraw %} +The `docker-registry` type can also be used to pull from Amazon ECR using static AWS credentials. + +{% raw %} +```yaml +registries: + ecr-docker: + type: docker-registry + url: https://1234567890.dkr.ecr.us-east-1.amazonaws.com + username: ${{secrets.ECR_AWS_ACCESS_KEY_ID}} + password: ${{secrets.ECR_AWS_SECRET_ACCESS_KEY}} +``` +{% endraw %} + #### `git` The `git` type supports username and password. @@ -907,4 +920,4 @@ registries: url: https://rubygems.pkg.github.com/octocat/github_api token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} ``` -{% endraw %} \ No newline at end of file +{% endraw %} diff --git a/content/code-security/supply-chain-security/configuring-dependabot-security-updates.md b/content/code-security/supply-chain-security/configuring-dependabot-security-updates.md index 83bf346c37..391fdce78b 100644 --- a/content/code-security/supply-chain-security/configuring-dependabot-security-updates.md +++ b/content/code-security/supply-chain-security/configuring-dependabot-security-updates.md @@ -48,7 +48,7 @@ If security updates are not enabled for your repository and you don't know why, You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository (see below). -You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% data variables.product.prodname_dependabot_security_updates %} require specific repository settings. For more information, see "[Supported repositories](#supported-repositories)." diff --git a/content/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies.md b/content/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies.md index 182e15babb..d72622a743 100644 --- a/content/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies.md @@ -1,7 +1,7 @@ --- title: Configuring notifications for vulnerable dependencies shortTitle: Configuring notifications -intro: 'Optimize how you receive notifications about {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts.' +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot %} alerts.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies versions: @@ -10,49 +10,41 @@ versions: topics: - security --- + ### About notifications for vulnerable dependencies -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% else %}When {% data variables.product.product_name %} detects vulnerable dependencies in your repositories, it sends security alerts.{% endif %}{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. {% endif %} -{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." +{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.21" %} -Your site administrator needs to enable security alerts for vulnerable dependencies for {% data variables.product.product_location %} before you can use the feature. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.20" %} -By default, if your site administrator has configured email for notifications on your enterprise, you will receive {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} by email.{% endif %} +By default, if your site administrator has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email.{% endif %} {% if currentVersion ver_gt "enterprise-server@2.21" %}Site administrators can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %} -{% if currentVersion ver_lt "enterprise-server@2.22" %}Site administrators can also enable security alerts without notifications. For more information, see "[Enabling security alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %} - -### Configuring notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} +### Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %} {% data reusables.notifications.vulnerable-dependency-notification-options %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} ![{% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png) -{% else %} - ![Security alerts options](/assets/images/help/notifications-v2/security-alerts-options.png) -{% endif %} {% note %} -**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot %} alerts. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" % %}{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}."{% endif %} +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." ### How to reduce the noise from notifications for vulnerable dependencies -If you are concerned about receiving too many notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} enabled. You can still navigate to see your {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} in your repository's Security tab.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."{% endif %} +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." ### Further reading diff --git a/content/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository.md b/content/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository.md index 5bdea0f321..1cc7967411 100644 --- a/content/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository.md @@ -14,6 +14,7 @@ versions: topics: - repositories --- + ### Viewing the dependency graph @@ -51,19 +52,6 @@ Any direct and indirect dependencies that are specified in the repository's mani {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} -Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to security alerts. - -![Dependencies graph](/assets/images/help/graphs/dependencies_graph_server.png) - -{% note %} - -**Note:** {% data variables.product.prodname_ghe_server %} does not populate the **Dependents** view. - -{% endnote %} - -{% endif %} - {% if currentVersion == "free-pro-team@latest" %} #### Dependents view @@ -75,7 +63,7 @@ For public repositories, the dependents view shows how the repository is used by Repository administrators can enable or disable the dependency graph for private repositories. -You can also enable or disable the dependency graph for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +You can also enable or disable the dependency graph for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -116,8 +104,8 @@ If a manifest or lock file is not processed, its dependencies are omitted from t ### Further reading -- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"{% if currentVersion == "free-pro-team@latest" %} -- "[Viewing insights for your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization)" -- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" +- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)" +- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% if currentVersion == "free-pro-team@latest" %} +- "[Viewing insights for your organization](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)" - "[Understanding how {% data variables.product.product_name %} uses and protects your data](/github/understanding-how-github-uses-and-protects-your-data)" {% endif %} diff --git a/content/code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies.md index 3d36b39b88..a6c9542ce0 100644 --- a/content/code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -6,6 +6,7 @@ redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies versions: free-pro-team: '*' + enterprise-server: '>=3.0' topics: - security --- @@ -16,18 +17,18 @@ The results of dependency detection reported by {% data variables.product.produc {% data variables.product.prodname_dotcom %} generates and displays dependency data differently than other tools. Consequently, if you've been using another tool to identify dependencies you will almost certainly see different results. Consider the following: -* {% data variables.product.prodname_advisory_database %} is one of the data sources that {% data variables.product.prodname_dotcom %} uses to identify vulnerable dependencies. It's a free, curated database of vulnerability information for common package ecosystems on {% data variables.product.prodname_dotcom %}. It includes both data reported directly to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_security_advisories %}, as well as official feeds and community sources. This data is reviewed and curated by {% data variables.product.prodname_dotcom %} to ensure that false or unactionable information is not shared with the development community. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)." +* {% data variables.product.prodname_advisory_database %} is one of the data sources that {% data variables.product.prodname_dotcom %} uses to identify vulnerable dependencies. It's a free, curated database of vulnerability information for common package ecosystems on {% data variables.product.prodname_dotcom %}. It includes both data reported directly to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_security_advisories %}, as well as official feeds and community sources. This data is reviewed and curated by {% data variables.product.prodname_dotcom %} to ensure that false or unactionable information is not shared with the development community. {% data reusables.security-advisory.link-browsing-advisory-db %} * The dependency graph parses all known package manifest files in a user’s repository. For example, for npm it will parse the _package-lock.json_ file. It constructs a graph of all of the repository’s dependencies and public dependents. This happens when you enable the dependency graph and when anyone pushes to the default branch, and it includes commits that makes changes to a supported manifest format. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." * {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." -* {% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." +* {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)." - {% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is discovered and added to the advisory database. + {% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is added to the advisory database{% if currentVersion ver_gt "enterprise-server@2.22" %} and synchronized to {% data variables.product.prodname_ghe_server %}{% endif %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)." ### Why don't I get vulnerability alerts for some ecosystems? -{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_dependabot %} security updates are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." +{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_dependabot %} security updates, {% endif %}and {% data variables.product.prodname_dependabot %} alerts are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." -It's worth noting that [{% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) may exist for other ecosystems. The information in a security advisory is provided by the maintainers of a particular repository. This data is not curated in the same way as information for the supported ecosystems. +It's worth noting that {% data variables.product.prodname_dotcom %} Security Advisories may exist for other ecosystems. The information in a security advisory is provided by the maintainers of a particular repository. This data is not curated in the same way as information for the supported ecosystems. {% if currentVersion == "free-pro-team@latest" %}For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."{% endif %} **Check**: Does the uncaught vulnerability apply to an unsupported ecosystem? @@ -35,9 +36,9 @@ It's worth noting that [{% data variables.product.prodname_dotcom %} Security Ad The dependency graph includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transitive dependencies, even when they aren't specified in a lockfile, by looking at the dependencies of the dependencies in a manifest file. -{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% data variables.product.prodname_dependabot %} security updates only suggests a change where it can directly "fix" the dependency, that is, when these are: +{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_dependabot_security_updates %} only suggest a change where {% data variables.product.prodname_dependabot %} can directly "fix" the dependency, that is, when these are: * Direct dependencies explicitly declared in a manifest or lockfile -* Transitive dependencies declared in a lockfile +* Transitive dependencies declared in a lockfile{% endif %} The dependency graph doesn't include “loose” dependencies. “Loose” dependencies are individual files that are copied from another source and checked into the repository directly or within an archive (such as a ZIP or JAR file), rather than being referenced by in a package manager’s manifest or lockfile. @@ -83,6 +84,7 @@ Some third-party tools use uncurated CVE data that isn't checked or filtered by Since {% data variables.product.prodname_dependabot %} uses curated data in the {% data variables.product.prodname_advisory_database %}, the volume of alerts may be lower, but the alerts you do receive will be accurate and relevant. +{% if currentVersion == "free-pro-team@latest" %} ### Does each dependency vulnerability generate a separate alert? When a dependency has multiple vulnerabilities, only one aggregated alert is generated for that dependency, instead of one alert per vulnerability. @@ -96,10 +98,11 @@ When you click to display the alert details, you can see how many vulnerabilitie ![Multiple vulnerabilities for a {% data variables.product.prodname_dependabot %} alert](/assets/images/help/repository/dependabot-vulnerabilities-number.png) **Check**: If there is a discrepancy in the totals you are seeing, check that you are not comparing alert numbers with vulnerability numbers. +{% endif %} ### Further reading - "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" - "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" -- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)" +- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"{% if currentVersion == "free-pro-team@latest" %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/content/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/content/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index a7d607aaea..4abc9b31a8 100644 --- a/content/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/content/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -8,11 +8,13 @@ permissions: Repository administrators and organization owners can view and upda shortTitle: Viewing and updating vulnerable dependencies versions: free-pro-team: '*' + enterprise-server: '>=3.0' topics: - security --- -Your repository's {% data variables.product.prodname_dependabot %} alerts tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}. You can sort the list of alerts using the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." +Your repository's {% data variables.product.prodname_dependabot %} alerts tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% if currentVersion == "free-pro-team@latest" %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts using the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." +{% if currentVersion == "free-pro-team@latest" %} You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% data reusables.repositories.dependency-review %} @@ -20,9 +22,11 @@ You can enable automatic security updates for any repository that uses {% data v ### About updates for vulnerable dependencies in your repository {% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that your codebase is using dependencies with known vulnerabilities. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability. +{% endif %} ### Viewing and updating vulnerable dependencies +{% if currentVersion == "free-pro-team@latest" %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} @@ -35,10 +39,31 @@ You can enable automatic security updates for any repository that uses {% data v 1. Optionally, if the alert is being fixed, if it's incorrect, or located in unused code, use the "Dismiss" drop-down, and click a reason for dismissing the alert. ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down.png) +{% elsif currentVersion ver_gt "enterprise-server@3.0" %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-dependabot-alerts %} +1. Click the alert you'd like to view. + ![Alert selected in list of alerts](/assets/images/enterprise/graphs/click-alert-in-alerts-list.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. +1. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. Alternatively, if you decide not to update the dependency, click the **Dismiss** drop-down, and select a reason for dismissing the alert. + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/enterprise/repository/dependabot-alert-dismiss-drop-down.png) + +{% else %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +{% data reusables.repositories.click-dependency-graph %} +1. Click the version number of the vulnerable dependency to display detailed information. + ![Detailed information on the vulnerable dependency](/assets/images/enterprise/3.0/dependabot-alert-info.png) +1. Review the details of the vulnerability and determine whether or not you need to update the dependency. When you merge a pull request that updates the manifest or lock file to a secure version of the dependency, this will resolve the alert. +1. The banner at the top of the **Dependencies** tab is displayed until all the vulnerable dependencies are resolved or you dismiss it. Click **Dismiss** in the top right corner of the banner and select a reason for dismissing the alert. + ![Dismiss security banner](/assets/images/enterprise/3.0/dependabot-alert-dismiss.png) +{% endif %} + ### Further reading -- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" -- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)" +- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% if currentVersion == "free-pro-team@latest" %} +- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)"{% endif %} - "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" -- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)" -- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)" +- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)"{% if currentVersion == "free-pro-team@latest" %} +- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %} diff --git a/content/developers/apps/creating-a-github-app-from-a-manifest.md b/content/developers/apps/creating-a-github-app-from-a-manifest.md index 171ab3f848..a401bcf827 100644 --- a/content/developers/apps/creating-a-github-app-from-a-manifest.md +++ b/content/developers/apps/creating-a-github-app-from-a-manifest.md @@ -179,7 +179,7 @@ You must complete this step of the GitHub App Manifest flow within one hour. {% data reusables.pre-release-program.api-preview-warning %} {% endif %} - POST /app-manifests/:code/conversions + POST /app-manifests/{code}/conversions For more information about the endpoint's response, see [Create a GitHub App from a manifest](/rest/reference/apps#create-a-github-app-from-a-manifest). diff --git a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md index 4f61410172..a42f21fc9d 100644 --- a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md +++ b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md @@ -94,9 +94,9 @@ By default, the response takes the following form. The response parameters `expi ```json { - "access_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghu_16C7e42F292c6912E7710c838347Ae178B4a"{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}", + "access_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghu_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}", "expires_in": 28800, - "refresh_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghr_1B4a2e77838347a7E420ce178F2E7c6912E169246c34E1ccbF66C46812d16D5B1A9Dc86A1498"{% else %}r1.c1b4a2e77838347a7e420ce178f2e7c6912e1692{% endif %}", + "refresh_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghr_1B4a2e77838347a7E420ce178F2E7c6912E169246c34E1ccbF66C46812d16D5B1A9Dc86A1498{% else %}r1.c1b4a2e77838347a7e420ce178f2e7c6912e1692{% endif %}", "refresh_token_expires_in": 15811200, "scope": "", "token_type": "bearer" @@ -106,7 +106,7 @@ By default, the response takes the following form. The response parameters `expi By default, the response takes the following form: - access_token={% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghu_16C7e42F292c6912E7710c838347Ae178B4a"{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}&token_type=bearer + access_token={% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghu_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}&token_type=bearer {% endif %} diff --git a/content/developers/apps/refreshing-user-to-server-access-tokens.md b/content/developers/apps/refreshing-user-to-server-access-tokens.md index 608fd9205e..60e176a078 100644 --- a/content/developers/apps/refreshing-user-to-server-access-tokens.md +++ b/content/developers/apps/refreshing-user-to-server-access-tokens.md @@ -42,9 +42,9 @@ Name | Type | Description ```json { - "access_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghu_16C7e42F292c6912E7710c838347Ae178B4a"{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}", + "access_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghu_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}", "expires_in": "28800", - "refresh_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghr_1B4a2e77838347a7E420ce178F2E7c6912E169246c34E1ccbF66C46812d16D5B1A9Dc86A1498"{% else %}r1.c1b4a2e77838347a7e420ce178f2e7c6912e169246c34e1ccbf66c46812d16d5b1a9dc86a149873c{% endif %}", + "refresh_token": "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghr_1B4a2e77838347a7E420ce178F2E7c6912E169246c34E1ccbF66C46812d16D5B1A9Dc86A1498{% else %}r1.c1b4a2e77838347a7e420ce178f2e7c6912e169246c34e1ccbf66c46812d16d5b1a9dc86a149873c{% endif %}", "refresh_token_expires_in": "15811200", "scope": "", "token_type": "bearer" diff --git a/content/developers/github-marketplace/about-marketplace-badges.md b/content/developers/github-marketplace/about-marketplace-badges.md index 11e6b80de5..d9bf33689a 100644 --- a/content/developers/github-marketplace/about-marketplace-badges.md +++ b/content/developers/github-marketplace/about-marketplace-badges.md @@ -13,7 +13,7 @@ Certain apps on the {% data variables.product.prodname_marketplace %} have the { - Verified ownership of their domain and has a verified badge on their profile - Confirmed their email address so {% data variables.product.prodname_dotcom %} Support can reach the organization -- Required two-factor authentication for their organization. For more information, see "[Requiring two-factor authentication in your organization](/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization)." +- Required two-factor authentication for their organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." ![Marketplace badge for GitHub Apps](/assets/images/marketplace/apps-with-verified-publisher-badge-tooltip.png) diff --git a/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md b/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md index 77342b3bd8..d811ada581 100644 --- a/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md +++ b/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md @@ -24,8 +24,8 @@ To offer paid plans for your app, the app must be owned by an organization and y ![Publisher verification option in the organization settings sidebar](/assets/images/marketplace/publisher-verification-settings-option.png) 1. Under "Publisher Verification", complete the information in the checklist: - Ensure that your basic profile information is present and accurate. Also, make sure that you've included the best email address for support and updates from {% data variables.product.company_short %}. - - Ensure that Two-factor authentication is enabled for your organization. For more information, see "[Requiring two-factor authentication in your organization](/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization)." - - Submit a verified domain and ensure that a "Verified" badge displays on your organization's profile page. For related information, see "[Verifying your organization's domain](/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain)." + - Ensure that Two-factor authentication is enabled for your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." + - Submit a verified domain and ensure that a "Verified" badge displays on your organization's profile page. For related information, see "[Verifying your organization's domain](/organizations/managing-organization-settings/verifying-your-organizations-domain)." ![Publisher Verification checklist](/assets/images/marketplace/publisher-verification-checklist.png) diff --git a/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md b/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md index 50544a871f..838fadc590 100644 --- a/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md +++ b/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md @@ -24,7 +24,7 @@ Here are guidelines about the fields you'll need to fill out in the **Listing de #### Listing name -Your app's name will appear on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). The name is limited to 255 characters. +Your listing's name will appear on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). The name is limited to 255 characters and can be different from your app's name. Your listing cannot have the same name as an existing {% data variables.product.product_name %} user, unless the name is your own user or organization name. #### Very short description diff --git a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md index 9e1768ab20..c11bfa475c 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md @@ -19,7 +19,7 @@ With {% data variables.product.prodname_discussions %}, the community for your p You don't need to close a discussion like you close an issue or a pull request. -If a repository administrator or project maintainer enables discussions for a repository, anyone who visits the repository can create and participate in discussions for the repository. Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. For more information, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)." +If a repository administrator or project maintainer enables discussions for a repository, anyone who visits the repository can create and participate in discussions for the repository. Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." For more information about management of discussions for your repository, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)." diff --git a/content/discussions/guides/best-practices-for-community-conversations-on-github.md b/content/discussions/guides/best-practices-for-community-conversations-on-github.md index 37c0347541..ee63e656d2 100644 --- a/content/discussions/guides/best-practices-for-community-conversations-on-github.md +++ b/content/discussions/guides/best-practices-for-community-conversations-on-github.md @@ -29,7 +29,7 @@ You can use {% data variables.product.prodname_discussions %} to discuss big pic Issues are useful for discussing specific details of a project such as bug reports and planned improvements. For more information, see "[About issues](/articles/about-issues)." Pull requests allow you to comment directly on proposed changes. For more information, see "[About pull requests](/articles/about-pull-requests)" and "[Commenting on a pull request](/articles/commenting-on-a-pull-request)." -{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." +{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." ### Following contributing guidelines diff --git a/content/discussions/guides/granting-higher-permissions-to-top-contributors.md b/content/discussions/guides/granting-higher-permissions-to-top-contributors.md index 8ded0aaa3a..6c12ee38c7 100644 --- a/content/discussions/guides/granting-higher-permissions-to-top-contributors.md +++ b/content/discussions/guides/granting-higher-permissions-to-top-contributors.md @@ -21,7 +21,7 @@ The most helpful contributors for the past 30 days are highlighted on the {% dat People with triage permissions for a repository can help moderate a project's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)." -For more information about repository permission levels and {% data variables.product.prodname_discussions %}, see "[Repository permissions levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)." +For more information about repository permission levels and {% data variables.product.prodname_discussions %}, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." ### Step 3: Change permissions levels for top contributors diff --git a/content/discussions/index.md b/content/discussions/index.md index 84d965fd4a..3c52fee2cf 100644 --- a/content/discussions/index.md +++ b/content/discussions/index.md @@ -22,6 +22,8 @@ featuredLinks: - /discussions/guides/finding-discussions-across-multiple-repositories - /discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository +changelog: + label: 'discussions' product_video: https://www.youtube-nocookie.com/embed/IpBw2SJkFyk layout: product-landing versions: @@ -32,24 +34,3 @@ versions: - - -{% assign discussionsCommunityExamples = site.data.variables.discussions_community_examples %} -{% if discussionsCommunityExamples %} -
-

Communities using discussions

- -
- {% render discussions-community-card for discussionsCommunityExamples as example %} -
- {% if discussionsCommunityExamples.length > 6 %} - - {% endif %} -
-
{% octicon "search" width="24" %}
-

Sorry, there is no result for

-

It looks like we don't have an example that fits your filter.
Try another filter or add your code example

- Add your community {% octicon "arrow-right" %} -
-
-{% endif %} diff --git a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md b/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md index 4c77f71e2c..2d14f8ed52 100644 --- a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md +++ b/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md @@ -12,7 +12,7 @@ versions: {% data reusables.discussions.about-discussions %} For more information about discussions, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." -Organization owners can choose the permissions required to create a discussion for repositories owned by the organization. For more information, see "[Managing discussion creation for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization)." +Organization owners can choose the permissions required to create a discussion for repositories owned by the organization. For more information, see "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)." As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." diff --git a/content/education/index.md b/content/education/index.md index 44ffabc2e0..abd70e5dc1 100644 --- a/content/education/index.md +++ b/content/education/index.md @@ -19,21 +19,8 @@ featuredLinks: - /desktop - /github/getting-started-with-github/github-cli - /education/manage-coursework-with-github-classroom/teach-with-github-classroom - changelog: - - title: 'Try something new at Local Hack Day: Learn' - date: '2020-10-15' - href: https://github.blog/2020-10-15-try-something-new-at-local-hack-day-learn/ - - title: 'Remote Education: Creating community through shared experiences' - date: '2020-09-24' - href: https://github.blog/2020-09-24-remote-education-creating-community-through-shared-experiences/ - - title: 'Remote Education: A series of best practices for online campus communities' - date: '2020-09-10' - href: https://github.blog/2020-09-10-remote-education-a-series-of-best-practices-for-online-campus-communities/ - - title: Welcome to the inaugural class of MLH Fellows - date: '2020-06-24' - href: https://github.blog/2020-06-24-welcome-to-the-inaugural-class-of-mlh-fellows/ - + label: 'education' layout: product-landing versions: free-pro-team: '*' diff --git a/content/education/manage-coursework-with-github-classroom/create-a-group-assignment.md b/content/education/manage-coursework-with-github-classroom/create-a-group-assignment.md index 45df283ef9..95fdfc6fe1 100644 --- a/content/education/manage-coursework-with-github-classroom/create-a-group-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/create-a-group-assignment.md @@ -17,7 +17,7 @@ When a student accepts a group assignment, the student can create a new team or {% data reusables.classroom.about-assignments %} -You can decide how many teams one assignment can have, and how many members each team can have. Each team that a student creates for an assignment is a team within your organization on {% data variables.product.product_name %}. The visibility of the team is secret. Teams that you create on {% data variables.product.product_name %} will not appear in {% data variables.product.prodname_classroom %}. For more information, see "[About teams](/github/setting-up-and-managing-organizations-and-teams/about-teams)." +You can decide how many teams one assignment can have, and how many members each team can have. Each team that a student creates for an assignment is a team within your organization on {% data variables.product.product_name %}. The visibility of the team is secret. Teams that you create on {% data variables.product.product_name %} will not appear in {% data variables.product.prodname_classroom %}. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." For a video demonstration of the creation of a group assignment, see "[Basics of setting up {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)." diff --git a/content/education/manage-coursework-with-github-classroom/manage-classrooms.md b/content/education/manage-coursework-with-github-classroom/manage-classrooms.md index 845faf1938..4ad2ceef98 100644 --- a/content/education/manage-coursework-with-github-classroom/manage-classrooms.md +++ b/content/education/manage-coursework-with-github-classroom/manage-classrooms.md @@ -20,7 +20,7 @@ redirect_from: After you create a classroom, {% data variables.product.prodname_classroom %} will prompt you to invite teaching assistants (TAs) and admins to the classroom. Each classroom can have one or more admins. Admins can be teachers, TAs, or any other course administrator who you'd like to have control over your classrooms on {% data variables.product.prodname_classroom %}. -Invite TAs and admins to your classroom by inviting the user accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization)" and "[Inviting users to join your organization](/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization)." +Invite TAs and admins to your classroom by inviting the user accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)" and "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom. @@ -34,7 +34,7 @@ When you first share the URL for an assignment with a student, the student must ### Prerequisites -You must have an organization account on {% data variables.product.product_name %} to manage classrooms on {% data variables.product.prodname_classroom %}. For more information, see "[Types of {% data variables.product.company_short %} accounts](/github/getting-started-with-github/types-of-github-accounts#organization-accounts)" and "[Creating a new organization from scratch](/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch)." +You must have an organization account on {% data variables.product.product_name %} to manage classrooms on {% data variables.product.prodname_classroom %}. For more information, see "[Types of {% data variables.product.company_short %} accounts](/github/getting-started-with-github/types-of-github-accounts#organization-accounts)" and "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." You must authorize the OAuth app for {% data variables.product.prodname_classroom %} for your organization to manage classrooms for your organization account. For more information, see "[Authorizing OAuth Apps](/github/authenticating-to-github/authorizing-oauth-apps)." diff --git a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md index d7afb49e30..68990facf8 100644 --- a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md +++ b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md @@ -26,7 +26,7 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} in y {% note %} -**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)."{% elsif currentVersion ver_gt "enterprise-server@2.21"%}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."{% endif %} +**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)."{% elsif currentVersion ver_gt "enterprise-server@2.21"%}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."{% endif %} {% endnote %} @@ -48,7 +48,7 @@ You can disable all workflows for a repository or set a policy that configures w {% note %} -**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)."{% elsif currentVersion ver_gt "enterprise-server@2.21" %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." +**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)."{% elsif currentVersion ver_gt "enterprise-server@2.21" %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." {% endif %} diff --git a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md index 4eed68ffc8..9d6fd613cc 100644 --- a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -103,4 +103,4 @@ Organization owners and repository administrators can only grant access to view ### Further reading - "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" -- "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" +- "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" diff --git a/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md b/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md index fc4dac0766..063be8cd39 100644 --- a/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md +++ b/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md @@ -16,7 +16,7 @@ For each repository that you administer on {% data variables.product.prodname_do This overview can help you audit access to your repository, onboard or off-board contractors or employees, and effectively respond to security incidents. -For more information about repository permission levels, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)." +For more information about repository permission levels, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." ![Access management overview](/assets/images/help/repository/manage-access-overview.png) @@ -52,10 +52,10 @@ For more information about repository permission levels, see "[Permission levels {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-manage-access %} -4. Under "Manage access", find the team or person whose access you'd like to remove, then click {% octicon "trashcan" aria-label="The trashcan icon" %}. - ![Trashcan icon for removing access](/assets/images/help/repository/manage-access-remove.png) +4. Under "Manage access", find the team or person whose access you'd like to remove, then click {% octicon "trash" aria-label="The trash icon" %}. + ![trash icon for removing access](/assets/images/help/repository/manage-access-remove.png) ### Further reading - "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" -- "[Setting base permissions for an organization](/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization)" +- "[Setting base permissions for an organization](/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization)" diff --git a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md index 6d6be04cd2..1aa967f98b 100644 --- a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md +++ b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md @@ -13,7 +13,7 @@ topics: - repositories --- -An organization owner must allow forks of private{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)." +An organization owner must allow forks of private{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." {% data reusables.organizations.internal-repos-enterprise %} diff --git a/content/github/administering-a-repository/renaming-a-branch.md b/content/github/administering-a-repository/renaming-a-branch.md index 4bf0adb79c..cd99cfb94c 100644 --- a/content/github/administering-a-repository/renaming-a-branch.md +++ b/content/github/administering-a-repository/renaming-a-branch.md @@ -38,4 +38,10 @@ From the local clone of the repository on a computer, run the following commands $ git branch -m OLD-BRANCH-NAME NEW-BRANCH-NAME $ git fetch origin $ git branch -u origin/NEW-BRANCH-NAME NEW-BRANCH-NAME +$ git remote set-head origin -a +``` + +Optionally, run the following command to remove tracking references to the old branch name. +``` +$ git remote prune origin ``` diff --git a/content/github/administering-a-repository/setting-repository-visibility.md b/content/github/administering-a-repository/setting-repository-visibility.md index 587bf86a29..e356187e86 100644 --- a/content/github/administering-a-repository/setting-repository-visibility.md +++ b/content/github/administering-a-repository/setting-repository-visibility.md @@ -16,7 +16,7 @@ topics: ### About repository visibility changes -Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization)." +Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." We recommend reviewing the following caveats before you change the visibility of a repository. diff --git a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md index c7f6ff6491..010d673100 100644 --- a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md @@ -51,5 +51,5 @@ After an enterprise or organization owner enables or enforces SAML SSO for an or ### Further reading -{% if currentVersion == "free-pro-team@latest" %}- "[About identity and access management with SAML single sign-on](/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %} +{% if currentVersion == "free-pro-team@latest" %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %} {% if currentVersion == "github-ae@latest" %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %} diff --git a/content/github/authenticating-to-github/creating-a-personal-access-token.md b/content/github/authenticating-to-github/creating-a-personal-access-token.md index fe174b149d..754e8fa567 100644 --- a/content/github/authenticating-to-github/creating-a-personal-access-token.md +++ b/content/github/authenticating-to-github/creating-a-personal-access-token.md @@ -17,13 +17,13 @@ topics: Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line). -{% if currentVersion == "free-pro-team@latest" %}If you want to use a PAT to access resources owned by an organization that uses SAML SSO, you must authorize the PAT. For more information, see "[About authentication with SAML single sign-on](/articles/about-authentication-with-saml-single-sign-on)" and "[Authorizing a personal access token for use with SAML single sign-on](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."{% endif %} +{% if currentVersion == "free-pro-team@latest" %}If you want to use a PAT to access resources owned by an organization that uses SAML SSO, you must authorize the PAT. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" and "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."{% endif %} {% if currentVersion == "free-pro-team@latest" %}{% data reusables.user_settings.removes-personal-access-tokens %}{% endif %} ### Creating a token -{% if currentVersion == "free-pro-team@latest" %}1. [Verify your email address](/articles/verifying-your-email-address), if it hasn't been verified yet.{% endif %} +{% if currentVersion == "free-pro-team@latest" %}1. [Verify your email address](/github/getting-started-with-github/verifying-your-email-address), if it hasn't been verified yet.{% endif %} {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.developer_settings %} {% data reusables.user_settings.personal_access_tokens %} @@ -47,13 +47,13 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti {% else %} ![Newly created token](/assets/images/help/settings/personal_access_tokens_ghe_legacy.png) {% endif %} - {% warning %} **Warning:** Treat your tokens like passwords and keep them secret. When working with the API, use tokens as environment variables instead of hardcoding them into your programs. {% endwarning %} -{% if currentVersion == "free-pro-team@latest" %}9. To use your token to authenticate to an organization that uses SAML SSO, [authorize the token for use with a SAML single-sign-on organization](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).{% endif %} + +{% if currentVersion == "free-pro-team@latest" %}9. To use your token to authenticate to an organization that uses SAML SSO, [authorize the token for use with a SAML single-sign-on organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).{% endif %} ### Using a token on the command line @@ -61,7 +61,7 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti Personal access tokens can only be used for HTTPS Git operations. If your repository uses an SSH remote URL, you will need to [switch the remote from SSH to HTTPS](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-ssh-to-https). -If you are not prompted for your username and password, your credentials may be cached on your computer. You can [update your credentials in the Keychain](/articles/updating-credentials-from-the-osx-keychain) to replace your old password with the token. +If you are not prompted for your username and password, your credentials may be cached on your computer. You can [update your credentials in the Keychain](/github/getting-started-with-github/updating-credentials-from-the-macos-keychain) to replace your old password with the token. ### Further reading diff --git a/content/github/authenticating-to-github/creating-a-strong-password.md b/content/github/authenticating-to-github/creating-a-strong-password.md index 11fb184df2..757915ebfc 100644 --- a/content/github/authenticating-to-github/creating-a-strong-password.md +++ b/content/github/authenticating-to-github/creating-a-strong-password.md @@ -20,7 +20,7 @@ To keep your account secure, we recommend you follow these best practices: - Use a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/), to generate a password of at least 15 characters. - Generate a unique password for {% data variables.product.product_name %}. If you use your {% data variables.product.product_name %} password elsewhere and that service is compromised, then attackers or other malicious actors could use that information to access your {% data variables.product.product_name %} account. - Configure two-factor authentication for your personal account. For more information, see "[About two-factor authentication](/articles/about-two-factor-authentication)." -- Never share your password, even with a potential collaborator. Each person should use their own personal account on {% data variables.product.product_name %}. For more information on ways to collaborate, see: "[Inviting collaborators to a personal repository](/articles/inviting-collaborators-to-a-personal-repository)," "[About collaborative development models](/articles/about-collaborative-development-models/)," or "[Collaborating with groups in organizations](/articles/collaborating-with-groups-in-organizations/)." +- Never share your password, even with a potential collaborator. Each person should use their own personal account on {% data variables.product.product_name %}. For more information on ways to collaborate, see: "[Inviting collaborators to a personal repository](/articles/inviting-collaborators-to-a-personal-repository)," "[About collaborative development models](/articles/about-collaborative-development-models/)," or "[Collaborating with groups in organizations](/organizations/collaborating-with-groups-in-organizations/)." {% data reusables.repositories.blocked-passwords %} diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 3878011b20..60dc147f2f 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -186,7 +186,7 @@ An overview of some of the most common actions that are recorded as events in th | Action | Description |------------------|------------------- -| `repo_funding_link_button_toggle` | Triggered when you enable or disable a sponsor button in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") +| `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") | `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)") @@ -194,9 +194,11 @@ An overview of some of the most common actions that are recorded as events in th | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") | `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled +| `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state | `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") | `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") | `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") @@ -264,4 +266,3 @@ An overview of some of the most common actions that are recorded as events in th |--------------------|--------------------- | `update` | Triggered when you set or change the status on your profile. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)." | `destroy` | Triggered when you clear the status on your profile. - diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md index c5d427757e..056544366e 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md @@ -18,7 +18,7 @@ You can create and participate in issues, pull requests, and team discussions, d Issues are useful for discussing specific details of a project such as bug reports and planned improvements. For more information, see "[About issues](/articles/about-issues)." Pull requests allow you to comment directly on proposed changes. For more information, see "[About pull requests](/articles/about-pull-requests)" and "[Commenting on a pull request](/articles/commenting-on-a-pull-request)." -{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." +{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." ### Reacting to ideas in comments diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md index 93a6a0374d..b96273574f 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md @@ -15,7 +15,7 @@ topics: After a pull request is opened, anyone with *read* access can review and comment on the changes it proposes. You can also suggest specific changes to lines of code, which the author can apply directly from the pull request. For more information, see "[Reviewing proposed changes in a pull request](/articles/reviewing-proposed-changes-in-a-pull-request)." -Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review)." {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %} +Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review)." {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."{% endif %} Reviews allow for discussion of proposed changes and help ensure that the changes meet the repository's contributing guidelines and other quality standards. You can define which individuals or teams own certain types or areas of code in a CODEOWNERS file. When a pull request modifies code that has a defined owner, that individual or team will automatically be requested as a reviewer. For more information, see "[About code owners](/articles/about-code-owners/)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md index c7618f3507..0ac7f8a01c 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md @@ -37,7 +37,7 @@ If the branch you want to delete is associated with an open pull request, you mu {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %} -1. Scroll to the branch that you want to delete, then click {% octicon "trashcan" aria-label="The trashcan icon to delete the branch" %}. +1. Scroll to the branch that you want to delete, then click {% octicon "trash" aria-label="The trash icon to delete the branch" %}. ![delete the branch](/assets/images/help/branches/branches-delete.png) {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md index 72ba7b1693..76413a4df8 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md +++ b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md @@ -13,7 +13,7 @@ topics: Owners and collaborators on a repository owned by a user account can assign pull request reviews. Organization members with triage permissions to a repository can assign a pull request review. -Owners or collaborators can assign a pull request review to any person that has been explicitly granted [read access](/articles/access-permissions-on-github) to a user-owned repository. Organization members can assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %} +Owners or collaborators can assign a pull request review to any person that has been explicitly granted [read access](/articles/access-permissions-on-github) to a user-owned repository. Organization members can assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."{% endif %} {% note %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index 563ad76cfb..97604c7b7e 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -79,5 +79,5 @@ If you change the visibility of an internal repository and then delete the repos - "[Setting repository visibility](/articles/setting-repository-visibility)" - "[About forks](/articles/about-forks)" - "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)" -- "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)" +- "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" - "{% if currentVersion == "free-pro-team@latest" %}[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-forking-private-or-internal-repositories){% else %}[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories){% endif %}" diff --git a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md index c65f2577a1..f6944dd4c2 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md @@ -23,7 +23,7 @@ Code owners are automatically requested for review when someone opens a pull req When someone with admin or owner permissions has enabled required reviews, they also can optionally require approval from a code owner before the author can merge a pull request in the repository. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)." -{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If a team has enabled code review assignments, the individual approvals won't satisfy the requirement for code owner approval in a protected branch. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If a team has enabled code review assignments, the individual approvals won't satisfy the requirement for code owner approval in a protected branch. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If a file has a code owner, you can see who the code owner is before you open a pull request. In the repository, you can browse to the file and hover over {% octicon "shield-lock" aria-label="The edit icon" %}. diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md index 722ababce5..453fac1bfa 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md @@ -21,7 +21,7 @@ Private repositories are only accessible to you, people you explicitly share acc Public repositories are accessible to everyone on the internet. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." {% endif %} -Organization owners always have access to every repository created in an organization. For more information, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)." +Organization owners always have access to every repository created in an organization. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." diff --git a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md index 4754cfb3d8..5158be272e 100644 --- a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md +++ b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md @@ -42,7 +42,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} > provide shell access. ``` -If the repository belongs to an organization and you're using an SSH key generated by an OAuth App, OAuth App access may have been restricted by an organization owner. For more information, see "About OAuth App access restrictions." +If the repository belongs to an organization and you're using an SSH key generated by an OAuth App, OAuth App access may have been restricted by an organization owner. For more information, see "About OAuth App access restrictions." For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account). diff --git a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md index 0c63b670ab..37f449b720 100644 --- a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md +++ b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md @@ -25,20 +25,23 @@ You can create a default codespace configuration using a pre-built container con {% data variables.product.prodname_codespaces %} uses settings contained in a configuration file named `devcontainer.json`. {% data reusables.codespaces.devcontainer-location %} -You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the {% data variables.product.prodname_vscode %} editor, but you can also set editor-specific settings in a file named `.vscode/settings.json`. +Each new codespace created from a branch that contains the `.devcontainer` folder will be configured according to the folder's contents. For more information, see "[Creating a codespace](/github/developing-online-with-codespaces/creating-a-codespace)." -Changes to a repository's codespace configuration apply only to every new codespace and do not affect any existing codespace. +You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the {% data variables.product.prodname_vscode %} editor, but you can also set editor-specific settings in a file named `.vscode/settings.json`. ### Using a pre-built container configuration -You can use any pre-built container configuration for {% data variables.product.prodname_vscode %} that is available in the [`vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository. Pre-built container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. +Pre-built container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. -1. Clone or download the [`vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository. -1. In the `vscode-dev-containers` repository, navigate to the [`containers`](https://github.com/microsoft/vscode-dev-containers/tree/master/containers) folder, then choose a container configuration for your project's needs. We'll use the [Node.js & JavaScript](https://aka.ms/vscode-dev-containers/definitions/node) container configuration as an example. -1. From the [`Node.js & JavaScript`](https://aka.ms/vscode-dev-containers/definitions/node) folder, copy the `.devcontainer` folder to the root of your project's repository. -1. Commit and push the new configuration to your project's repository on {% data variables.product.prodname_dotcom %}. - -Each new codespace created from a branch which contains the `.devcontainer` folder will be configured according to the folder's contents. For more information, see "[Creating a codespace](/github/developing-online-with-codespaces/creating-a-codespace)." +1. Access the command palette (`shift command P` / `shift control P`), then start typing "Codespaces: Add Development Container Configuration Files...". Click **Codespaces: Add Development Container Configuration Files...** + !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) +1. Click the definition you want to use. + ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) +1. Follow the prompts to customize your definition. +1. Click **OK**. + ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) +1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) ### Creating a custom codespace configuration @@ -53,6 +56,8 @@ You can define default editor settings for {% data variables.product.prodname_vs * Editor settings defined in `.vscode/settings.json` are applied as _Workspace_-scoped settings in the codespace. * Editor settings defined in the `settings` key in `devcontainer.json` are applied as _Remote [Codespaces]_-scoped settings in the codespace. +After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." + ### Supported codespace configuration keys You can use configuration keys supported by {% data variables.product.prodname_codespaces %} in `devcontainer.json`. @@ -80,3 +85,15 @@ You can use configuration keys supported by {% data variables.product.prodname_c - `dockerComposeFile` For more information about the available settings for `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. + +### Applying changes to your configuration + +{% data reusables.codespaces.apply-devcontainer-changes %} + +1. {% data reusables.codespaces.rebuild-command %} + !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-container-command.png) +1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. + ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) + - To diagnose the error by reviewing the creation logs, click **View creation log**. + - To fix the errors identified in the logs, update your `devcontainer.json` file. + - To apply the changes, rebuild your container. {% data reusables.codespaces.rebuild-command %} diff --git a/content/github/developing-online-with-codespaces/developing-in-a-codespace.md b/content/github/developing-online-with-codespaces/developing-in-a-codespace.md index f40aa202bc..40f87cb27a 100644 --- a/content/github/developing-online-with-codespaces/developing-in-a-codespace.md +++ b/content/github/developing-online-with-codespaces/developing-in-a-codespace.md @@ -11,36 +11,22 @@ topics: - codespaces --- +### About development with {% data variables.product.prodname_codespaces %} + {% data reusables.codespaces.release-stage %} {% data reusables.codespaces.use-visual-studio-features %} +{% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)." + +{% data reusables.codespaces.apply-devcontainer-changes %} For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." + {% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." -### Connecting to a codespace from {% data variables.product.prodname_vscode %} {% data reusables.codespaces.connect-to-codespace-from-vscode %} ### Navigating to your codespace + {% data reusables.codespaces.navigate-to-codespaces %} 2. Click the name of the codespace you want to develop in. - ![Name of codespace](/assets/images/help/codespaces/click-name-codespace.png) - -### Forwarding ports - -Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on port 3000, you can access the application from your browser to test and debug it. - -When an application running inside a codespace outputs a port to the console, {% data variables.product.prodname_codespaces %} detects the localhost URL pattern and automatically forwards those ports. You can click on the URL in the terminal to open it in a browser. For example, if an application outputs `http://127.0.0.1:3000` or `http://localhost:3000` to the console, the log would automatically convert the output to a clickable URL for port 3000. - -![Automatic Port Forwarding](/assets/images/help/codespaces/automatic-port-forwarding.png) - -Alternatively, you can also use any of the following ways to forward a port. - -* You can forward a port on demand by triggering the command palette (`shift command P` / `shift control P`) and typing "Codespaces: Forward Port". You can then enter the number of the port you want to forward. - - ![Command Palette Port Forwarding](/assets/images/help/codespaces/command-palette-port-forwarding.png) - -* You can automatically configure forwarded ports in a `.devcontainer.json` file using the `forwardPorts` property. - -* You can add or remove forwarded ports within the Remote Explorer extension. From the Remote Explorer you can copy and paste the URLs for forwarded ports, allowing you to access them through your browser. - - ![Remote Explorer Port Forwarding](/assets/images/help/codespaces/remote-explorer-port-forwarding.png) + ![Name of codespace](/assets/images/help/codespaces/click-name-codespace.png) \ No newline at end of file diff --git a/content/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace.md b/content/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace.md new file mode 100644 index 0000000000..1871742796 --- /dev/null +++ b/content/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace.md @@ -0,0 +1,61 @@ +--- +title: Forwarding ports in your codespace +intro: '{% data reusables.codespaces.about-port-forwarding %}' +product: '{% data reusables.gated-features.codespaces %}' +versions: + free-pro-team: '*' +topics: + - codespaces +--- + +### About forwarded ports + +Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on port 4000, you can access the application from your browser to test and debug the application. + +When an application running inside a codespace outputs a port to the console, {% data variables.product.prodname_codespaces %} detects the localhost URL pattern and automatically forwards the port. You can click on the URL in the terminal to open the port in a browser. For example, if an application outputs `http://127.0.0.1:4000` or `http://localhost:4000` to the console, the log would automatically convert the output to a clickable URL for port 4000. + +![Automatic port forwarding](/assets/images/help/codespaces/automatic-port-forwarding.png) + +You can also forward a port manually, label forwarded ports, share fowarded ports publicly, and add forwarded ports to the codespace configuration. + +### Forwarding a port + +You can manually forward a port that wasn't forwarded automatically. + +{% data reusables.codespaces.navigate-to-ports-tab %} +1. Under the list of ports, click **Add port**. + ![Add port button](/assets/images/help/codespaces/add-port-button.png) +1. Type the port number or address, then press enter. + ![Text box to type port button](/assets/images/help/codespaces/port-number-text-box.png) + +### Labeling a port + +You can label a port to make the port more easily identifiable in a list. + +{% data reusables.codespaces.navigate-to-ports-tab %} +1. Hover over the port you want to label, then click the label icon. + ![Label icon for port](/assets/images/help/codespaces/label-icon.png) +{% data reusables.codespaces.type-port-label %} + +### Sharing a port + +If you want to share a forwarded port with others, you can make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate. + +{% data reusables.codespaces.navigate-to-ports-tab %} +1. Right click the port you want to share, then click **Make Public**. + ![Option to make port public in right-click menu](/assets/images/help/codespaces/make-public-option.png) +1. To the right of the local address for the port, click the copy icon. + ![Copy icon for port URL](/assets/images/help/codespaces/copy-icon-port-url.png) +1. Send the copied URL to the person you want to share the port with. + +### Adding a port to the codespace configuration + +You can add a forwarded port to the {% data variables.product.prodname_codespaces %} configuration for the repository, so the port will automatically be forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces#applying-changes-to-your-configuration)." + +You can manually configure fowarded ports in a `.devcontainer.json` file using the `forwardPorts` property, or you can use the "Ports" panel in your codespace. + +{% data reusables.codespaces.navigate-to-ports-tab %} +1. Right click the port you want to add to the codespace configuration, then click **Set Label and Update devcontainer.json**. + ![Option to set label and add port to devcontainer.json in the right-click menu](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) +{% data reusables.codespaces.type-port-label %} + diff --git a/content/github/developing-online-with-codespaces/index.md b/content/github/developing-online-with-codespaces/index.md index c0a39439e1..699d24bc7f 100644 --- a/content/github/developing-online-with-codespaces/index.md +++ b/content/github/developing-online-with-codespaces/index.md @@ -20,6 +20,7 @@ topics: {% link_in_list /configuring-codespaces-for-your-project %} {% link_in_list /creating-a-codespace %} {% link_in_list /developing-in-a-codespace %} +{% link_in_list /forwarding-ports-in-your-codespace %} {% link_in_list /personalizing-codespaces-for-your-account %} {% link_in_list /managing-encrypted-secrets-for-codespaces %} {% link_in_list /managing-access-and-security-for-codespaces %} diff --git a/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md b/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md index 400c039188..82c5517bb8 100644 --- a/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md +++ b/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md @@ -16,6 +16,14 @@ topics: {% data reusables.codespaces.unsupported-repos %} +{% data reusables.codespaces.recovery-mode %} + +``` +This codespace is currently running in recovery mode due to a container error. +``` + +Review the creation logs, update the configuration as needed, and run the "Rebuild Container" command to retry. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." + If you encounter issues while using a browser that is not Chromium-based, try switching to a Chromium-based browser, or check for known issues with your browser in the `microsoft/vscode` repository by searching for issues labeled with the name of your browser, such as[`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) or [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari). If you encounter issues while using a Chromium-based browser, you can check if you're experiencing another known issue with {% data variables.product.prodname_vscode %} in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository. diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md index 79451ea523..588b80e6f2 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md @@ -7,6 +7,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} @@ -36,14 +37,6 @@ You can use {% data variables.product.prodname_code_scanning %} with {% data var You can view and contribute to the queries for {% data variables.product.prodname_code_scanning %} in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/) in the {% data variables.product.prodname_codeql %} documentation. -{% if currentVersion == "free-pro-team@latest" %} - -### About billing for {% data variables.product.prodname_code_scanning %} - -{% data variables.product.prodname_code_scanning_capc %} uses {% data variables.product.prodname_actions %}, and each run of a {% data variables.product.prodname_code_scanning %} workflow consumes minutes for {% data variables.product.prodname_actions %}. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)." - -{% endif %} - ### About third-party code scanning tools {% data reusables.code-scanning.you-can-upload-third-party-analysis %} @@ -54,7 +47,5 @@ You can view and contribute to the queries for {% data variables.product.prodnam ### Further reading -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} -- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)"{% endif %} - [{% data variables.product.prodname_security %}](https://securitylab.github.com/) - [OASIS Static Analysis Results Interchange Format (SARIF) TC](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=sarif) on the OASIS Committee website diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md index 24c879678c..8c93a3eb42 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md @@ -8,6 +8,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md index 959b2968df..b36ffd6258 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md @@ -9,4 +9,4 @@ versions: topics: - security --- - + diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md index 13cd43a2c5..c7fbdb2ec2 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md @@ -9,6 +9,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} @@ -23,7 +24,7 @@ Before you can configure {% data variables.product.prodname_code_scanning %} for {% data reusables.code-scanning.edit-workflow %} -{% data variables.product.prodname_codeql %} analysis is just one type of {% data variables.product.prodname_code_scanning %} you can do in {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_marketplace %}{% if currentVersion ver_gt "enterprise-server@2.21" %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %} contains other {% data variables.product.prodname_code_scanning %} workflows you can use. {% if currentVersion == "free-pro-team@latest" %}You can find a selection of these on the "Get started with {% data variables.product.prodname_code_scanning %}" page, which you can access from the **{% octicon "shield" aria-label="The shield symbol" %} Security** tab.{% endif %} The specific examples given in this article relate to the {% data variables.product.prodname_codeql_workflow %} file. +{% data variables.product.prodname_codeql %} analysis is just one type of {% data variables.product.prodname_code_scanning %} you can do in {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_marketplace %} on {% data variables.product.prodname_dotcom_the_website %} contains other {% data variables.product.prodname_code_scanning %} workflows you can use. The specific examples given in this article relate to the {% data variables.product.prodname_codeql_workflow %} file. ### Editing a {% data variables.product.prodname_code_scanning %} workflow @@ -49,7 +50,7 @@ By default, the {% data variables.product.prodname_codeql_workflow %} uses the ` #### Scanning pull requests -The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} +The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. The `pull_request` event is not triggered if the pull request was opened from a private fork. For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)." @@ -110,9 +111,7 @@ This workflow scans: ### Specifying an operating system -If your code requires a specific operating system to compile, you can configure the operating system in your {% data variables.product.prodname_codeql_workflow %}. Edit the value of `jobs.analyze.runs-on` to specify the operating system for the machine that runs your {% data variables.product.prodname_code_scanning %} actions. {% if currentVersion ver_gt "enterprise-server@2.21" %}You specify the operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% else %} - -If you choose to use a self-hosted runner for code scanning, you can specify an operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% endif %} +If your code requires a specific operating system to compile, you can configure the operating system in your {% data variables.product.prodname_codeql_workflow %}. Edit the value of `jobs.analyze.runs-on` to specify the operating system for the machine that runs your {% data variables.product.prodname_code_scanning %} actions. You specify the operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`. ``` yaml jobs: @@ -121,11 +120,9 @@ jobs: runs-on: [self-hosted, ubuntu-latest] ``` -{% if currentVersion == "free-pro-team@latest" %}For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."{% endif %} +{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." -{% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see {% if currentVersion ver_gt "enterprise-server@2.21" %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}." - -{% if currentVersion ver_gt "enterprise-server@2.21" %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %} +You must ensure that Git is in the PATH variable on your self-hosted runners. ### Changing the languages that are analyzed @@ -157,48 +154,6 @@ If your workflow does not contain a matrix called `language`, then {% data varia with: languages: cpp, csharp, python ``` -{% if currentVersion == "free-pro-team@latest" %} -### Analyzing Python dependencies - -For GitHub-hosted runners that use Linux only, the {% data variables.product.prodname_codeql_workflow %} will try to auto-install Python dependencies to give more results for the CodeQL analysis. You can control this behavior by specifying the `setup-python-dependencies` parameter for the action called by the "Initialize CodeQL" step. By default, this parameter is set to `true`: - -- If the repository contains code written in Python, the "Initialize CodeQL" step installs the necessary dependencies on the GitHub-hosted runner. If the auto-install succeeds, the action also sets the environment variable `CODEQL_PYTHON` to the Python executable file that includes the dependencies. - -- If the repository doesn't have any Python dependencies, or the dependencies are specified in an unexpected way, you'll get a warning and the action will continue with the remaining jobs. The action can run successfully even when there are problems interpreting dependencies, but the results may be incomplete. - -Alternatively, you can install Python dependencies manually on any operating system. You will need to add `setup-python-dependencies` and set it to `false`, as well as set `CODEQL_PYTHON` to the Python executable that includes the dependencies, as shown in this workflow extract: - -```yaml -jobs: - CodeQL-Build: - - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v2 - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - run: | - python -m pip install --upgrade pip - if [ -f requirements.txt ]; - then pip install -r requirements.txt; - fi - # Set the `CODEQL-PYTHON` environment variable to the Python executable - # that includes the dependencies - echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: python - # Override the default behavior so that the action doesn't attempt - # to auto-install Python dependencies - setup-python-dependencies: false -``` -{% endif %} ### Running additional queries diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md index 7925a69c3c..9f724ba5ca 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md @@ -9,6 +9,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta-codeql-runner %} {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md index 6056f759a8..7add0c02d7 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md @@ -9,6 +9,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} @@ -30,10 +31,7 @@ If your workflow uses a `language` matrix, `autobuild` attempts to build each of {% note %} -{% if currentVersion == "github-ae@latest" %}**Note**: For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." -{% else %} **Note**: If you use self-hosted runners for {% data variables.product.prodname_actions %}, you may need to install additional software to use the `autobuild` process. Additionally, if your repository requires a specific version of a build tool, you may need to install it manually. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". -{% endif %} {% endnote %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md index aa1a4ae018..eb43db25a4 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md @@ -7,6 +7,7 @@ versions: topics: - security --- + ### Table of Contents diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md index 078e2407e4..f0ed718b05 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md @@ -9,4 +9,4 @@ versions: topics: - security --- - + diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md index fa0590466e..4da45e4d69 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md @@ -1,12 +1,13 @@ --- title: Managing code scanning alerts for your repository shortTitle: Managing alerts -intro: 'From the security view, you can view, fix, {% if currentVersion == "enterprise-server@2.22" %}or close{% else %}dismiss, or delete{% endif %} alerts for potential vulnerabilities or errors in your project''s code.' +intro: 'From the security view, you can view, fix, or close alerts for potential vulnerabilities or errors in your project''s code.' product: '{% data reusables.gated-features.code-scanning %}' permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.' versions: enterprise-server: '2.22' --- + {% data reusables.code-scanning.beta %} @@ -48,82 +49,25 @@ You need write permission to view a summary of all the alerts for a repository o Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." -If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have {% if currentVersion == "enterprise-server@2.22" %}closed{% else %}dismissed{% endif %}. +If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have closed. Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. ![Filtering alerts by branch](/assets/images/enterprise/3.1/help/repository/code-scanning-branch-filter.png) -{% if currentVersion == "enterprise-server@2.22" %} - ### Closing an alert Closing an alert is a way to resolve an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} -{% else %} - -### Dismissing or deleting alerts - -There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab. - -Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the **Security** tab. - -When you dismiss an alert: - -- It's dismissed in all branches. -- The alert is removed from the number of current alerts for your project. -- The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required. -- The reason why you closed the alert is recorded. -- Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert. - -When you delete an alert: - -- It's deleted in all branches. -- The alert is removed from the number of current alerts for your project. -- It is _not_ added to the "Closed" list in the summary of alerts. -- If the code that generated the alert stays the same, and the same {% data variables.product.prodname_code_scanning %} tool runs again without any configuration changes, the alert will be shown again in your analysis results. - -To dismiss or delete alerts: - -{% endif %} - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} -{% if currentVersion == "enterprise-server@2.22" %} {% data reusables.code-scanning.click-alert-in-list %} 1. Select the **Close** drop-down menu and click a reason for closing the alert. ![Choosing reason for closing the alert via the Close drop-down](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) {% data reusables.code-scanning.false-positive-fix-codeql %} -{% else %} - -1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**. - - ![Deleting alerts](/assets/images/help/repository/code-scanning-delete-alerts.png) - - Optionally, you can use the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. - - ![Filter alerts by rule](/assets/images/enterprise/3.1/help/repository/code-scanning-filter-by-rule.png) - -1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore. - - ![Open an alert from the summary list](/assets/images/enterprise/3.1/help/repository/code-scanning-click-alert.png) - -1. Review the alert, then click **Dismiss** and choose a reason for closing the alert. - ![Choosing a reason for dismissing an alert](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) - - {% data reusables.code-scanning.choose-alert-dismissal-reason %} - - {% data reusables.code-scanning.false-positive-fix-codeql %} - -#### Dismissing multiple alerts at once - -If a project has multiple alerts that you want to dismiss for the same reason, you can bulk dismiss them from the summary of alerts. Typically, you'll want to filter the list and then dismiss all of the matching alerts. For example, you might want to dismiss all of the current alerts in the project that have been tagged for a particular Common Weakness Enumeration (CWE) vulnerability. - -{% endif %} - ### Further reading - "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)" diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md index 6c40d2210c..ad4b931e89 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md @@ -8,6 +8,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md index ee1d07b337..10a9aae983 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md @@ -8,6 +8,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta-codeql-runner %} @@ -29,17 +30,13 @@ The {% data variables.product.prodname_codeql_runner %} is a command-line tool t {% note %} **Notes:** -{% if currentVersion == "free-pro-team@latest" %} -* The {% data variables.product.prodname_codeql_runner %} uses the {% data variables.product.prodname_codeql %} CLI to analyze code and therefore has the same license conditions. It's free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -{% else %} * The {% data variables.product.prodname_codeql_runner %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. -{% endif %} * The {% data variables.product.prodname_codeql_runner %} shouldn't be confused with the {% data variables.product.prodname_codeql %} CLI. The {% data variables.product.prodname_codeql %} CLI is an interactive command-line interface that lets you create {% data variables.product.prodname_codeql %} databases for security research and run {% data variables.product.prodname_codeql %} queries. For more information, see "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {% endnote %} ### Downloading the {% data variables.product.prodname_codeql_runner %} -You can download the {% data variables.product.prodname_codeql_runner %} from https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. +You can download the {% data variables.product.prodname_codeql_runner %} from https://github.com/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. On Linux: @@ -61,7 +58,7 @@ On Windows, the `codeql-runner-win.exe` file usually requires no change to permi Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell -wget https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux +wget https://github.com/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` @@ -72,9 +69,8 @@ In addition to this, each CI server also needs: The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. Allow the CI servers access to https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. -{% if currentVersion == "enterprise-server@2.22" %} -1. Mirror the `github/codeql-action` repository on {% data variables.product.product_name %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} +1. Allow the CI servers access to https://github.com/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. +1. Mirror the `github/codeql-action` repository on {% data variables.product.product_name %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}. 1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. ### Calling the {% data variables.product.prodname_codeql_runner %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md index 461781f021..429f648d64 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md @@ -8,6 +8,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md index 96eddbb33b..e5bc87eede 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md @@ -9,6 +9,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} @@ -21,14 +22,12 @@ You decide how to generate {% data variables.product.prodname_code_scanning %} a ### Setting up {% data variables.product.prodname_code_scanning %} using actions -{% if currentVersion == "free-pro-team@latest" %}Using actions to run {% data variables.product.prodname_code_scanning %} will use minutes. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)."{% endif %} - {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +3. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. !["Set up {% data variables.product.prodname_code_scanning %}" button to the right of "{% data variables.product.prodname_code_scanning_capc %}" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) 4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. - !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.product.prodname_codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository.{% endif %} + !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png) 5. To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow. Generally you can commit the {% data variables.product.prodname_codeql_workflow %} without making any changes to it. However, many of the third-party workflows require additional configuration, so read the comments in the workflow before committing. diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md index 2add40278a..03eea86a52 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md @@ -9,6 +9,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} @@ -16,7 +17,7 @@ topics: In repositories where {% data variables.product.prodname_code_scanning %} is configured as a pull request check, {% data variables.product.prodname_code_scanning %} checks the code in the pull request. By default, this is limited to pull requests that target the default branch, but you can change this configuration within {% data variables.product.prodname_actions %} or in a third-party CI/CD system. If merging the changes would introduce new {% data variables.product.prodname_code_scanning %} alerts to the target branch, these are reported as check results in the pull request. The alerts are also shown as annotations in the **Files changed** tab of the pull request. If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)." -If {% data variables.product.prodname_code_scanning %} has any results with a severity of `error`, the check fails and the error is reported in the check results. If all the results found by {% data variables.product.prodname_code_scanning %} have lower severities, the alerts are treated as warnings or notices and the check succeeds. If your pull request targets a protected branch that uses {% data variables.product.prodname_code_scanning %}, and the repository owner has configured required status checks, then you must either fix or {% if currentVersion == "enterprise-server@2.22" %}close{% else %}dismiss{% endif %} all error alerts before the pull request can be merged. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." +If {% data variables.product.prodname_code_scanning %} has any results with a severity of `error`, the check fails and the error is reported in the check results. If all the results found by {% data variables.product.prodname_code_scanning %} have lower severities, the alerts are treated as warnings or notices and the check succeeds. If your pull request targets a protected branch that uses {% data variables.product.prodname_code_scanning %}, and the repository owner has configured required status checks, then you must either fix or close all error alerts before the pull request can be merged. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." ![Failed {% data variables.product.prodname_code_scanning %} check on a pull request](/assets/images/help/repository/code-scanning-check-failure.png) @@ -40,28 +41,10 @@ In the detailed view for an alert, some {% data variables.product.prodname_code_ ![Alert description and link to show more information](/assets/images/help/repository/code-scanning-pr-alert.png) -### {% if currentVersion == "enterprise-server@2.22" %}Resolving{% else %}Fixing{% endif %} an alert on your pull request +### Resolving an alert on your pull request Anyone with push access to a pull request can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on that pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed. -{% if currentVersion == "enterprise-server@2.22" %} - If you don't think that an alert needs to be fixed, users with write permission can close the alert manually. {% data reusables.code-scanning.close-alert-examples %} The **Close** button is available in annotations and in the alerts view if you have write permission for the repository. {% data reusables.code-scanning.false-positive-fix-codeql %} - -{% else %} - -### Dismissing an alert on your pull request - -An alternative way of closing an alert is to dismiss it. You can dismiss an alert if you don't think it needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} If you have write permission for the repository, the **Dismiss** button is available in code annotations and in the alerts summary. When you click **Dismiss** you will be prompted to choose a reason for closing the alert. - -![Choosing a reason for dismissing an alert](/assets/images/help/repository/code-scanning-alert-close-drop-down.png) - -{% data reusables.code-scanning.choose-alert-dismissal-reason %} - -{% data reusables.code-scanning.false-positive-fix-codeql %} - -For more information about dismissing alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)." - -{% endif %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md index 38720c5fa8..1d0e97a89a 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md @@ -8,6 +8,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta-codeql-runner %} {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md index d2281f5c98..af6461511b 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md @@ -8,6 +8,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.not-available %} @@ -113,24 +114,13 @@ If you split your analysis into multiple workflows as described above, we still If your analysis is still too slow to be run during `push` or `pull_request` events, then you may want to only trigger analysis on the `schedule` event. For more information, see "[Events](/actions/learn-github-actions/introduction-to-github-actions#events)." -{% if currentVersion == "free-pro-team@latest" %} -### Results differ between analysis platforms - -If you are analyzing code written in Python, you may see different results depending on whether you run the {% data variables.product.prodname_codeql_workflow %} on Linux, macOS, or Windows. - -On GitHub-hosted runners that use Linux, the {% data variables.product.prodname_codeql_workflow %} tries to install and analyze Python dependencies, which could lead to more results. To disable the auto-install, add `setup-python-dependencies: false` to the "Initialize CodeQL" step of the workflow. For more information about configuring the analysis of Python dependencies, see "[Analyzing Python dependencies](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#analyzing-python-dependencies)." - -{% endif %} - ### Error: "Server error" If the run of a workflow for {% data variables.product.prodname_code_scanning %} fails due to a server error, try running the workflow again. If the problem persists, contact {% data variables.contact.contact_support %}. ### Error: "Out of disk" or "Out of memory" -On very large projects, {% data variables.product.prodname_codeql %} may run out of disk or memory on the runner. -{% if currentVersion == "free-pro-team@latest" %}If you encounter this issue on a hosted {% data variables.product.prodname_actions %} runner, contact {% data variables.contact.contact_support %} so that we can investigate the problem. -{% else %}If you encounter this issue, try increasing the memory on the runner.{% endif %} +On very large projects, {% data variables.product.prodname_codeql %} may run out of disk or memory on the runner. If you encounter this issue, try increasing the memory on the runner. ### Warning: "git checkout HEAD^2 is no longer necessary" diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md index d9af8c6631..5adc5c83f0 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md @@ -9,6 +9,7 @@ versions: topics: - security --- + {% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning %} @@ -19,7 +20,7 @@ topics: You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning)." -You can upload the results using {% data variables.product.prodname_actions %}{% if currentVersion == "enterprise-server@2.22" %} (available if your organization is taking part in the beta program){% endif %}, the {% data variables.product.prodname_code_scanning %} API, or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: +You can upload the results using {% data variables.product.prodname_actions %} (available if your organization is taking part in the beta program), the {% data variables.product.prodname_code_scanning %} API, or the {% data variables.product.prodname_codeql_runner %}. The best upload method will depend on how you generate the SARIF file, for example, if you use: - {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis. - {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below). diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md index 6949b29e6c..fa6eb2b3db 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md @@ -9,4 +9,4 @@ versions: topics: - security --- - + diff --git a/content/github/getting-started-with-github/about-github-advanced-security.md b/content/github/getting-started-with-github/about-github-advanced-security.md index 27e3ce3e96..5b61b99b3f 100644 --- a/content/github/getting-started-with-github/about-github-advanced-security.md +++ b/content/github/getting-started-with-github/about-github-advanced-security.md @@ -37,7 +37,7 @@ For information about {% data variables.product.prodname_advanced_security %} fe The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)." {% endif %} -Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." {% endif %} @@ -46,7 +46,7 @@ Once your system is set up, you can enable and disable these features at the org For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public. -For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} {% endif %} diff --git a/content/github/getting-started-with-github/be-social.md b/content/github/getting-started-with-github/be-social.md index 2817ef122e..a285f017cd 100644 --- a/content/github/getting-started-with-github/be-social.md +++ b/content/github/getting-started-with-github/be-social.md @@ -68,8 +68,8 @@ You're now connected to the {% data variables.product.product_name %} community. ![Star a project](/assets/images/help/stars/star-a-project.png) -- [Set up Git](/articles/set-up-git) -- [Create a repository](/articles/create-a-repo) -- [Fork a repository](/articles/fork-a-repo) +- "[Set up Git](/articles/set-up-git)" +- "[Create a repository](/articles/create-a-repo)" +- "[Fork a repository](/articles/fork-a-repo)" - **Be social** - {% data reusables.support.connect-in-the-forum-bootcamp %} diff --git a/content/github/getting-started-with-github/fork-a-repo.md b/content/github/getting-started-with-github/fork-a-repo.md index 777773290a..e0b6519bc4 100644 --- a/content/github/getting-started-with-github/fork-a-repo.md +++ b/content/github/getting-started-with-github/fork-a-repo.md @@ -151,5 +151,6 @@ You have now forked a repository, practiced cloning your fork, and configured an - "[Set up Git](/articles/set-up-git)" - "[Create a repository](/articles/create-a-repo)" +- **Fork a repository** - "[Be social](/articles/be-social)" - {% data reusables.support.connect-in-the-forum-bootcamp %} diff --git a/content/github/getting-started-with-github/githubs-products.md b/content/github/getting-started-with-github/githubs-products.md index 4fbb23c3f0..3e4f2530fc 100644 --- a/content/github/getting-started-with-github/githubs-products.md +++ b/content/github/getting-started-with-github/githubs-products.md @@ -98,15 +98,4 @@ In addition to the features available with {% data variables.product.prodname_te You can set up a trial to evaluate {% data variables.product.prodname_ghe_cloud %}. For more information, see "Setting up a trial of {% data variables.product.prodname_ghe_cloud %}." -For more information about hosting your own instance of [{% data variables.product.prodname_ghe_server %}](https://enterprise.github.com), contact {% data variables.contact.contact_enterprise_sales %}. {% data reusables.enterprise_installation.request-a-trial %} - -### {% data variables.product.prodname_ghe_one %} - -{% data variables.product.prodname_ghe_one %} includes [{% data variables.product.prodname_enterprise %}](#github-enterprise), plus: - -- {% data variables.contact.github_support %} {% data variables.product.premium_plus_support_plan %} -- {% data variables.product.prodname_insights %} -- {% data variables.product.prodname_GH_advanced_security %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}. For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."{% endif %}{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.22" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)."{% endif %} -- [{% data variables.product.prodname_learning %} for organizations](https://lab.github.com/organizations) - -For more information about signing up for {% data variables.product.prodname_ghe_one %}, contact {% data variables.contact.contact_enterprise_sales %}. +For more information about hosting your own instance of [{% data variables.product.prodname_ghe_server %}](https://enterprise.github.com), contact {% data variables.contact.contact_enterprise_sales %}. {% data reusables.enterprise_installation.request-a-trial %} \ No newline at end of file diff --git a/content/github/getting-started-with-github/keyboard-shortcuts.md b/content/github/getting-started-with-github/keyboard-shortcuts.md index 4570dc23fe..57c1f85600 100644 --- a/content/github/getting-started-with-github/keyboard-shortcuts.md +++ b/content/github/getting-started-with-github/keyboard-shortcuts.md @@ -42,6 +42,9 @@ Below is a list of some of the available keyboard shortcuts. | Keyboard shortcut | Description |-----------|------------ +| control b or command b | Inserts Markdown formatting for bolding text +| control i or command i | Inserts Markdown formatting for italicizing text +| control k or command k | Inserts Markdown formatting for creating a link |e | Open source code file in the **Edit file** tab |control f or command f | Start searching in file editor |control g or command g | Find next diff --git a/content/github/index.md b/content/github/index.md index e7848587f1..d97b60cc5d 100644 --- a/content/github/index.md +++ b/content/github/index.md @@ -23,7 +23,7 @@ versions: {% link_in_list /managing-subscriptions-and-notifications-on-github %} -{% link_in_list /setting-up-and-managing-organizations-and-teams %} + {% link_in_list /setting-up-and-managing-your-enterprise %} {% link_in_list /setting-up-and-managing-billing-and-payments-on-github %} diff --git a/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md b/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md index 163a2a447b..501ad2aaac 100644 --- a/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md +++ b/content/github/managing-files-in-a-repository/deleting-files-in-a-repository.md @@ -25,7 +25,7 @@ If the file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_ ### Deleting a file 1. Browse to the file in your repository that you want to delete. -2. At the top of the file, click {% octicon "trashcan" aria-label="The trashcan icon" %}. +2. At the top of the file, click {% octicon "trash" aria-label="The trash icon" %}. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md index a690af654c..d9d06be906 100644 --- a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md +++ b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md @@ -1,12 +1,13 @@ --- title: About alerts for vulnerable dependencies -intro: '{% data variables.product.product_name %} sends {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} when we detect vulnerabilities affecting your repository.' +intro: '{% data variables.product.product_name %} sends {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} when we detect vulnerabilities affecting your repository.' versions: enterprise-server: '<=2.22' topics: - security --- - + + ### About vulnerable dependencies {% data reusables.repositories.a-vulnerability-is %} @@ -15,12 +16,10 @@ When your code depends on a package that has a security vulnerability, this vuln ### Detection of vulnerable dependencies - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %}{% else %}{% data variables.product.product_name %} detects vulnerable dependencies and sends security alerts{% endif %} when: + {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %}{% else %}{% data variables.product.product_name %} detects vulnerable dependencies and sends security alerts{% endif %} when: -{% if currentVersion == "free-pro-team@latest" %} -- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)."{% else %} -- New advisory data is synchronized to {% data variables.product.prodname_ghe_server %} each hour from {% data variables.product.prodname_dotcom_the_website %}. For more information about advisory data, see "Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}."{% endif %} -- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% if currentVersion == "free-pro-team@latest" %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +- New advisory data is synchronized to {% data variables.product.prodname_ghe_server %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %} +- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." {% data reusables.repositories.dependency-review %} @@ -32,7 +31,7 @@ For a list of the ecosystems that {% data variables.product.product_name %} can {% endnote %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" % %} +{% if currentVersion ver_gt "enterprise-server@2.21" % %} ### {% data variables.product.prodname_dependabot %} alerts for vulnerable dependencies {% else %} ### Security alerts for vulnerable dependencies @@ -40,23 +39,10 @@ For a list of the ecosystems that {% data variables.product.product_name %} can {% data reusables.repositories.enable-security-alerts %} -{% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies in _public_ repositories and generates {% data variables.product.prodname_dependabot_alerts %} by default. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories. - -You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." - -For information about permission requirements for actions related to {% data variables.product.prodname_dependabot_alerts %}, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-requirements-for-security-features)." - -{% data variables.product.product_name %} starts generating the dependency graph immediately and generates alerts for any vulnerable dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)." -{% endif %} - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion ver_gt "enterprise-server@2.21" %} When {% data variables.product.product_name %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. The alert includes a link to the affected file in the project, and information about a fixed version. {% data variables.product.product_name %} also notifies the maintainers of affected repositories about the new alert according to their notification preferences. For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)." {% endif %} -{% if currentVersion == "free-pro-team@latest" %} -For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, the alert may also contain a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." -{% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a security alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version. {% endif %} @@ -67,27 +53,15 @@ When {% data variables.product.product_name %} identifies a vulnerable dependenc {% endwarning %} -### Access to {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts +### Access to {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts -You can see all of the alerts that affect a particular project{% if currentVersion == "free-pro-team@latest" %} on the repository's Security tab or{% endif %} in the repository's dependency graph.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."{% endif %} +You can see all of the alerts that affect a particular project in the repository's dependency graph. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} -By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}.{% endif %} {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." -{% endif %} +{% if currentVersion ver_gt "enterprise-server@2.21" %} +By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}.{% endif %} {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} We send security alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. {% endif %} -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %} For more information, see "[Choosing the delivery method for your notifications](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %} For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} -You can also see all the {% data variables.product.prodname_dependabot_alerts %} that correspond to a particular vulnerability in the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database#viewing-your-vulnerable-repositories)." -{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} -### Further reading - -- "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" -- "[Viewing and updating vulnerable dependencies in your repository](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[Understanding how {% data variables.product.product_name %} uses and protects your data](/categories/understanding-how-github-uses-and-protects-your-data)"{% endif %} +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %} For more information, see "[Choosing the delivery method for your notifications](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)."{% endif %}{% if currentVersion ver_gt "enterprise-server@2.20" %} For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."{% endif %} diff --git a/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md index e90aa74955..2f899bbce3 100644 --- a/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md +++ b/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md @@ -1,20 +1,17 @@ --- title: Configuring notifications for vulnerable dependencies shortTitle: Configuring notifications -intro: 'Optimize how you receive notifications about {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts.' +intro: 'Optimize how you receive notifications about {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts.' versions: enterprise-server: '>=2.21 <=2.22' topics: - security --- + ### About notifications for vulnerable dependencies -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% else %}When {% data variables.product.product_name %} detects vulnerable dependencies in your repositories, it sends security alerts.{% endif %}{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. -{% endif %} - -{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." -{% endif %} +{% if currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% else %}When {% data variables.product.product_name %} detects vulnerable dependencies in your repositories, it sends security alerts.{% endif %} {% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.21" %} Your site administrator needs to enable security alerts for vulnerable dependencies for {% data variables.product.product_location %} before you can use the feature. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %} @@ -26,14 +23,14 @@ By default, if your site administrator has configured email for notifications on {% if currentVersion ver_lt "enterprise-server@2.22" %}Site administrators can also enable security alerts without notifications. For more information, see "[Enabling security alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %} -### Configuring notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} +### Configuring notifications for {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." {% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %} {% data reusables.notifications.vulnerable-dependency-notification-options %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion ver_gt "enterprise-server@2.21" %} ![{% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% else %} ![Security alerts options](/assets/images/help/notifications-v2/security-alerts-options.png) @@ -45,11 +42,11 @@ You can configure notification settings for yourself or your organization from t {% endnote %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" % %}{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}."{% endif %} +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." ### How to reduce the noise from notifications for vulnerable dependencies -If you are concerned about receiving too many notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} enabled. You can still navigate to see your {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} in your repository's Security tab.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."{% endif %} +If you are concerned about receiving too many notifications for {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} enabled. You can still navigate to see your {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} in your repository's Security tab. ### Further reading diff --git a/content/github/managing-security-vulnerabilities/index.md b/content/github/managing-security-vulnerabilities/index.md index 647438f80f..39235e8a5b 100644 --- a/content/github/managing-security-vulnerabilities/index.md +++ b/content/github/managing-security-vulnerabilities/index.md @@ -5,7 +5,7 @@ versions: topics: - security --- - + ### Table of Contents {% topic_link_in_list /managing-vulnerabilities-in-your-projects-dependencies %} diff --git a/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md b/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md index 9a98bb527f..1e601bb6a4 100644 --- a/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md +++ b/content/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies.md @@ -7,4 +7,4 @@ versions: topics: - security --- - + diff --git a/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md index 4dc7aad673..23f8c2387a 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md @@ -65,7 +65,7 @@ Email notifications also allow flexibility with the types of notifications you r ### About participating and watching notifications -When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." +When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[Managing subscriptions and notifications on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)." {% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} diff --git a/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md index d8e3ae3338..0495f3f466 100644 --- a/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md @@ -20,7 +20,7 @@ topics: ![New milestone button](/assets/images/help/repository/new-milestone.png) - To edit a milestone, next to the milestone you want to edit, click **Edit**. ![Edit milestone option](/assets/images/help/repository/edit-milestone.png) -5. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. +5. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. Milestones will render Markdown syntax. For more information about Markdown syntax, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)." ### Deleting milestones diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md index 55d99d1503..0028f8f221 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/downgrading-a-sponsorship.md @@ -19,15 +19,15 @@ When you downgrade or cancel a sponsorship, the change will become effective on {% data reusables.sponsors.navigate-to-sponsored-account %} {% data reusables.sponsors.sponsorship-dashboard %} +{% data reusables.sponsors.review-tiers-to-select %} {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.update-sponsorship %} ### Canceling a sponsorship {% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.billing %} +{% data reusables.user_settings.billing_plans %} {% data reusables.sponsors.billing-switcher %} -{% data reusables.user_settings.subscriptions-tab %} 3. Under "{% data variables.product.prodname_sponsors %}", to the right of the sponsored open source contributor, click {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to your sponsored amount, then click **Cancel sponsorship**. ![Cancel sponsorship button](/assets/images/help/billing/edit-sponsor-billing.png) 4. Review the information about canceling your sponsorship, then click **OK**. diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md index 71d7d250f8..1f297f7e16 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-a-sponsorship.md @@ -19,5 +19,6 @@ When you upgrade your sponsorship tier, the change will become effective immedia {% data reusables.sponsors.navigate-to-sponsored-account %} {% data reusables.sponsors.sponsorship-dashboard %} +{% data reusables.sponsors.review-tiers-to-select %} {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.update-sponsorship %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md index 848bdc0cf1..cf968f72ed 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/upgrading-your-github-subscription.md @@ -58,7 +58,7 @@ You can upgrade your organization from {% data variables.product.prodname_free_t #### Next steps for organizations using {% data variables.product.prodname_ghe_cloud %} -If you upgraded your organization to {% data variables.product.prodname_ghe_cloud %}, you can set up identity and access management for your organization. For more information, see "[Managing SAML single sign-on for your organization](/articles/managing-saml-single-sign-on-for-your-organization)." +If you upgraded your organization to {% data variables.product.prodname_ghe_cloud %}, you can set up identity and access management for your organization. For more information, see "[Managing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization)." If you'd like to use an enterprise account with {% data variables.product.prodname_ghe_cloud %}, contact {% data variables.contact.contact_enterprise_sales %}. For more information, see "[About enterprise accounts](/articles/about-enterprise-accounts)." diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage.md index 3e9d1d052a..d4c7b9fea7 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage.md @@ -29,5 +29,5 @@ You can check how many seats your license includes and how many of them are curr ![Owned organization in {% data variables.product.prodname_GH_advanced_security %} section of enterprise billing settings](/assets/images/help/billing/ghas-orgs-list-enterprise-click-org.png) 6. On the "Security & analysis" settings page, scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section to see a detailed breakdown of usage by repository for this organization. ![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/enterprises/settings-security-analysis-ghas-repos-list.png) - For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." + For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md b/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md deleted file mode 100644 index 6e4d1b4eed..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Collaborating with groups in organizations -intro: Groups of people can collaborate across many projects at the same time in organization accounts. -redirect_from: - - /articles/creating-a-new-organization-account/ - - /articles/collaborating-with-groups-in-organizations -mapTopic: true -versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' -topics: - - organizations - - teams ---- - diff --git a/content/github/setting-up-and-managing-organizations-and-teams/index.md b/content/github/setting-up-and-managing-organizations-and-teams/index.md deleted file mode 100644 index 70a9607bb9..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/index.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Setting up and managing organizations and teams -shortTitle: Organizations and teams -intro: Collaborate across many projects while managing access to projects and data and customizing settings for your organization. -redirect_from: - - /articles/about-improved-organization-permissions/ - - /categories/setting-up-and-managing-organizations-and-teams -versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' -topics: - - organizations - - teams ---- - - -### Table of Contents - -{% topic_link_in_list /collaborating-with-groups-in-organizations %} - {% link_in_list /about-organizations %} - {% link_in_list /about-your-organization-dashboard %} - {% link_in_list /creating-a-new-organization-from-scratch %} - {% link_in_list /accessing-your-organizations-settings %} - {% link_in_list /about-your-organizations-news-feed %} - {% link_in_list /viewing-insights-for-your-organization %} -{% topic_link_in_list /managing-membership-in-your-organization %} - {% link_in_list /inviting-users-to-join-your-organization %} - {% link_in_list /canceling-or-editing-an-invitation-to-join-your-organization %} - - {% link_in_list /adding-people-to-your-organization %} - {% link_in_list /removing-a-member-from-your-organization %} - {% link_in_list /reinstating-a-former-member-of-your-organization %} - {% link_in_list /can-i-create-accounts-for-people-in-my-organization %} -{% topic_link_in_list /managing-peoples-access-to-your-organization-with-roles %} - {% link_in_list /permission-levels-for-an-organization %} - {% link_in_list /maintaining-ownership-continuity-for-your-organization %} - {% link_in_list /giving-team-maintainer-permissions-to-an-organization-member %} - {% link_in_list /adding-a-billing-manager-to-your-organization %} - {% link_in_list /removing-a-billing-manager-from-your-organization %} -{% topic_link_in_list /organizing-members-into-teams %} - {% link_in_list /about-teams %} - {% link_in_list /creating-a-team %} - {% link_in_list /setting-your-teams-profile-picture %} - {% link_in_list /adding-organization-members-to-a-team %} - {% link_in_list /managing-code-review-assignment-for-your-team %} - {% link_in_list /renaming-a-team %} - {% link_in_list /changing-team-visibility %} - {% link_in_list /synchronizing-a-team-with-an-identity-provider-group %} - {% link_in_list /moving-a-team-in-your-organizations-hierarchy %} - {% link_in_list /requesting-to-add-a-child-team %} - {% link_in_list /requesting-to-add-or-change-a-parent-team %} - {% link_in_list /removing-organization-members-from-a-team %} - {% link_in_list /disabling-team-discussions-for-your-organization %} - {% link_in_list /managing-scheduled-reminders-for-your-team %} - {% link_in_list /deleting-a-team %} -{% topic_link_in_list /collaborating-with-your-team %} - {% link_in_list /about-team-discussions %} - {% link_in_list /creating-a-team-discussion %} - {% link_in_list /editing-or-deleting-a-team-discussion %} - {% link_in_list /pinning-a-team-discussion %} -{% topic_link_in_list /managing-access-to-your-organizations-repositories %} - {% link_in_list /repository-permission-levels-for-an-organization %} - {% link_in_list /setting-base-permissions-for-an-organization %} - {% link_in_list /viewing-people-with-access-to-your-repository %} - {% link_in_list /managing-an-individuals-access-to-an-organization-repository %} - {% link_in_list /managing-team-access-to-an-organization-repository %} - {% link_in_list /adding-outside-collaborators-to-repositories-in-your-organization %} - {% link_in_list /canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization %} - {% link_in_list /removing-an-outside-collaborator-from-an-organization-repository %} - {% link_in_list /converting-an-organization-member-to-an-outside-collaborator %} - {% link_in_list /converting-an-outside-collaborator-to-an-organization-member %} - {% link_in_list /reinstating-a-former-outside-collaborators-access-to-your-organization %} -{% topic_link_in_list /managing-access-to-your-organizations-project-boards %} - {% link_in_list /project-board-permissions-for-an-organization %} - {% link_in_list /managing-access-to-a-project-board-for-organization-members %} - {% link_in_list /managing-team-access-to-an-organization-project-board %} - {% link_in_list /managing-an-individuals-access-to-an-organization-project-board %} - {% link_in_list /adding-an-outside-collaborator-to-a-project-board-in-your-organization %} - {% link_in_list /removing-an-outside-collaborator-from-an-organization-project-board %} -{% topic_link_in_list /managing-access-to-your-organizations-apps %} - {% link_in_list /adding-github-app-managers-in-your-organization %} - {% link_in_list /removing-github-app-managers-from-your-organization %} -{% topic_link_in_list /managing-organization-settings %} - {% link_in_list /verifying-your-organizations-domain %} - {% link_in_list /renaming-an-organization %} - {% link_in_list /transferring-organization-ownership %} - {% link_in_list /restricting-repository-creation-in-your-organization %} - {% link_in_list /setting-permissions-for-deleting-or-transferring-repositories %} - {% link_in_list /restricting-repository-visibility-changes-in-your-organization %} - {% link_in_list /managing-the-forking-policy-for-your-organization %} - {% link_in_list /disabling-or-limiting-github-actions-for-your-organization %} - {% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization %} - {% link_in_list /setting-permissions-for-adding-outside-collaborators %} - {% link_in_list /allowing-people-to-delete-issues-in-your-organization %}{% if currentVersion == "free-pro-team@latest" %} - {% link_in_list /managing-discussion-creation-for-repositories-in-your-organization %}{% endif %} - {% link_in_list /setting-team-creation-permissions-in-your-organization %} - {% link_in_list /managing-scheduled-reminders-for-your-organization %} - {% link_in_list /managing-the-default-branch-name-for-repositories-in-your-organization %} - {% link_in_list /managing-default-labels-for-repositories-in-your-organization %} - {% link_in_list /changing-the-visibility-of-your-organizations-dependency-insights %} - {% link_in_list /managing-the-display-of-member-names-in-your-organization %} - {% link_in_list /managing-updates-from-accounts-your-organization-sponsors %} - {% link_in_list /managing-the-publication-of-github-pages-sites-for-your-organization %} - {% link_in_list /deleting-an-organization-account %} - {% link_in_list /converting-an-organization-into-a-user %} - {% link_in_list /integrating-jira-with-your-organization-project-board %} - {% link_in_list /upgrading-to-the-corporate-terms-of-service %} -{% topic_link_in_list /migrating-to-improved-organization-permissions %} - {% link_in_list /converting-an-owners-team-to-improved-organization-permissions %} - {% link_in_list /converting-an-admin-team-to-improved-organization-permissions %} - {% link_in_list /migrating-admin-teams-to-improved-organization-permissions %} -{% topic_link_in_list /restricting-access-to-your-organizations-data %} - {% link_in_list /about-oauth-app-access-restrictions %} - {% link_in_list /enabling-oauth-app-access-restrictions-for-your-organization %} - {% link_in_list /disabling-oauth-app-access-restrictions-for-your-organization %} - {% link_in_list /approving-oauth-apps-for-your-organization %} - {% link_in_list /denying-access-to-a-previously-approved-oauth-app-for-your-organization %} -{% topic_link_in_list /keeping-your-organization-secure %} - {% link_in_list /viewing-whether-users-in-your-organization-have-2fa-enabled %} - {% link_in_list /preparing-to-require-two-factor-authentication-in-your-organization %} - {% link_in_list /requiring-two-factor-authentication-in-your-organization %} - {% link_in_list /managing-security-and-analysis-settings-for-your-organization %} - {% link_in_list /managing-allowed-ip-addresses-for-your-organization %} - {% link_in_list /restricting-email-notifications-to-an-approved-domain %} - {% link_in_list /reviewing-the-audit-log-for-your-organization %} - {% link_in_list /reviewing-your-organizations-installed-integrations %} -{% topic_link_in_list /managing-saml-single-sign-on-for-your-organization %} - {% link_in_list /about-identity-and-access-management-with-saml-single-sign-on %} - {% link_in_list /about-scim %} - {% link_in_list /connecting-your-identity-provider-to-your-organization %} - {% link_in_list /configuring-saml-single-sign-on-and-scim-using-okta %} - {% link_in_list /enabling-and-testing-saml-single-sign-on-for-your-organization %} - {% link_in_list /preparing-to-enforce-saml-single-sign-on-in-your-organization %} - {% link_in_list /enforcing-saml-single-sign-on-for-your-organization %} - {% link_in_list /downloading-your-organizations-saml-single-sign-on-recovery-codes %} - {% link_in_list /managing-team-synchronization-for-your-organization %} - {% link_in_list /accessing-your-organization-if-your-identity-provider-is-unavailable %} -{% topic_link_in_list /granting-access-to-your-organization-with-saml-single-sign-on %} - {% link_in_list /managing-bots-and-service-accounts-with-saml-single-sign-on %} - {% link_in_list /viewing-and-managing-a-members-saml-access-to-your-organization %} - {% link_in_list /about-two-factor-authentication-and-saml-single-sign-on %} -{% topic_link_in_list /managing-git-access-to-your-organizations-repositories %} - {% link_in_list /about-ssh-certificate-authorities %} - {% link_in_list /managing-your-organizations-ssh-certificate-authorities %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md b/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md deleted file mode 100644 index 62b65b07ce..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Keeping your organization secure -redirect_from: - - /articles/preventing-unauthorized-access-to-organization-information/ - - /articles/keeping-your-organization-secure -intro: 'Organization owners have several features to help them keep their projects and data secure. If you''re the owner of an organization, you should regularly review your organization''s audit log{% if currentVersion != "github-ae@latest" %}, member 2FA status,{% endif %} and application settings to ensure that no unauthorized or malicious activity has occurred.' -mapTopic: true -versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' -topics: - - organizations - - teams ---- - diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md deleted file mode 100644 index 2bdeee3631..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Managing access to your organization’s project boards -intro: 'As an organization owner or project board admin, you can give organization members, teams, and outside collaborators different levels of access to project boards owned by your organization.' -redirect_from: - - /articles/managing-access-to-your-organization-s-project-boards - - /articles/managing-access-to-your-organizations-project-boards -mapTopic: true -versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' -topics: - - organizations - - teams ---- - diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md deleted file mode 100644 index ed1fe22a09..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing access to your organization's repositories -intro: Organization owners can manage individual and team access to the organization's repositories. Team maintainers can also manage a team's repository access. -redirect_from: - - /articles/permission-levels-for-an-organization-repository/ - - /articles/managing-access-to-your-organization-s-repositories - - /articles/managing-access-to-your-organizations-repositories -mapTopic: true -versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' -topics: - - organizations - - teams ---- - diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md deleted file mode 100644 index 64b002f6bf..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Managing organization settings -intro: 'Organization administrators can change several settings, including the names of repositories that belong to the organization and Owners team membership. In addition, organization admins can delete the organization and all of its repositories.' -mapTopic: true -redirect_from: - - /articles/managing-organization-settings -versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' -topics: - - organizations - - teams ---- - diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization.md deleted file mode 100644 index f39fa938c3..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Managing SAML single sign-on for your organization -intro: Organization administrators can manage organization members' identities and access to the organization with SAML single sign-on (SSO). -mapTopic: true -redirect_from: - - /articles/managing-member-identity-and-access-in-your-organization-with-saml-single-sign-on/ - - /articles/managing-saml-single-sign-on-for-your-organization -versions: - free-pro-team: '*' -topics: - - organizations - - teams ---- - diff --git a/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md b/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md deleted file mode 100644 index b820de8bd8..0000000000 --- a/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Organizing members into teams -intro: You can group organization members into teams that reflect your company or group's structure with cascading access permissions and mentions. -redirect_from: - - /articles/setting-up-teams-improved-organization-permissions/ - - /articles/setting-up-teams-for-accessing-organization-repositories/ - - /articles/creating-teams/ - - /articles/adding-people-to-teams-in-an-organization/ - - /articles/removing-a-member-from-a-team-in-your-organization/ - - /articles/setting-up-teams/ - - /articles/maintaining-teams-improved-organization-permissions/ - - /articles/maintaining-teams/ - - /articles/organizing-members-into-teams -mapTopic: true -versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' -topics: - - organizations - - teams ---- - diff --git a/content/github/setting-up-and-managing-your-enterprise/connecting-an-azure-subscription-to-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/connecting-an-azure-subscription-to-your-enterprise.md index 97191e7ef8..9fade74df6 100644 --- a/content/github/setting-up-and-managing-your-enterprise/connecting-an-azure-subscription-to-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/connecting-an-azure-subscription-to-your-enterprise.md @@ -9,7 +9,7 @@ versions: --- ### About Azure subscriptions and {% data variables.product.product_name %} -{% data reusables.enterprise-accounts.billing-microsoft-ea-overview %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions) and "[About billing for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages)." +{% data reusables.enterprise-accounts.billing-microsoft-ea-overview %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions) and "[About billing for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages)." After you connect an Azure subscription, you can also manage your spending limit. For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-packages)" and "[Managing your spending limit for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/managing-your-spending-limit-for-github-actions)." @@ -23,7 +23,7 @@ To connect your Azure subscription, you must have owner permissions to the subsc {% data reusables.enterprise-accounts.payment-information-tab %} 1. Under "Payment Information", click **Add Azure Subscription**. 1. To sign in to your Microsoft account, follow the prompts. -1. Review the "Permissions requested" prompt. If you agree with the terms, click **Accept**. +1. Review the "Permissions requested" prompt. If you agree with the terms, click **Accept**. 1. Under "Select a subscription", select the Azure Subscription ID that you want to connect to your enterprise. 1. Click **Connect**. @@ -35,5 +35,5 @@ After you disconnect your Azure subscription from your enterprise account, your {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} {% data reusables.enterprise-accounts.payment-information-tab %} -1. Under "Azure subscription", to the right of the subscription ID you want to disconnect, click **{% octicon "trashcan" aria-label="The trashcan icon" %}**. +1. Under "Azure subscription", to the right of the subscription ID you want to disconnect, click **{% octicon "trash" aria-label="The trash icon" %}**. 1. Review the prompt, then click **Remove**. diff --git a/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md index 4743ba484e..f41af1c1b1 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account.md @@ -11,7 +11,7 @@ topics: ### About SAML single sign-on for enterprise accounts -{% data reusables.saml.dotcom-saml-explanation %} For more information, see "[About identity and access management with SAML single sign-on](/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on)." +{% data reusables.saml.dotcom-saml-explanation %} For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." {% data reusables.saml.about-saml-enterprise-accounts %} diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md index 8271ab0077..c3b98b6c68 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md @@ -51,7 +51,7 @@ Enterprise owners can restrict access to assets owned by organizations in an ent {% data reusables.identity-and-permissions.ip-allow-lists-enable %} -You can also configure allowed IP addresses for an individual organization. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization)." +You can also configure allowed IP addresses for an individual organization. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization)." #### Adding an allowed IP address diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md index cbe70eef28..5ad2d70c34 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md @@ -15,7 +15,7 @@ topics: ### Enforcing a policy for team discussions -Across all organizations owned by your enterprise account, you can enable or disable team discussions, or allow owners to administer the setting on the organization level. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions/)." +Across all organizations owned by your enterprise account, you can enable or disable team discussions, or allow owners to administer the setting on the organization level. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md index 6596a04d44..6b98fa4dff 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md @@ -39,7 +39,7 @@ Organization owners can invite new members to an organization by email address. While not required, we recommend that organization owners send an invitation to the same email address used for the {% data variables.product.prodname_vs %} subscriber's User Primary Name (UPN). When the email address on {% data variables.product.product_name %} matches the subscriber's UPN, you can ensure that another member of the organization does not claim the subscriber's license. -For more information, see "[Inviting users to join your organization](/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization)," "[Signing up for {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/signing-up-for-github)," and "[Managing email preferences](/github/setting-up-and-managing-your-github-user-account/managing-email-preferences)." +For more information, see "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)," "[Signing up for {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/signing-up-for-github)," and "[Managing email preferences](/github/setting-up-and-managing-your-github-user-account/managing-email-preferences)." ### Viewing {% data variables.product.prodname_enterprise %} licensing diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md index ef3f0b988a..7c5e14291d 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account.md @@ -19,7 +19,7 @@ If you use Azure AD as your IdP, you can enable team synchronization for your en {% data reusables.identity-and-permissions.team-sync-disable %} -You can also configure and manage team synchronization for an individual organization. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)." +You can also configure and manage team synchronization for an individual organization. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." ### Prerequisites diff --git a/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md b/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md index 651e15af7b..3a60254b42 100644 --- a/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md +++ b/content/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains.md @@ -11,7 +11,7 @@ topics: ### About email restrictions for your enterprise account -When you restrict email notifications to verified domains, enterprise members can only use an email address associated with a verified domain to receive email notifications about activity in organizations owned by your enterprise account. The domains can be inherited from the enterprise account or configured for the specific organization. For more information about email restrictions for organizations, see "[Restricting email notifications to an approved domain](/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain)." +When you restrict email notifications to verified domains, enterprise members can only use an email address associated with a verified domain to receive email notifications about activity in organizations owned by your enterprise account. The domains can be inherited from the enterprise account or configured for the specific organization. For more information about email restrictions for organizations, see "[Restricting email notifications to an approved domain](/organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain)." If email restrictions are enabled for an enterprise account, organization owners cannot disable email restrictions for any organization owned by the enterprise account. If changes occur that result in an organization having no verified domains, either inherited from an enterprise account that owns the organization or for the specific organization, email restrictions will be disabled for the organization. diff --git a/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md b/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md index 96714ca44c..0baf3c1664 100644 --- a/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md +++ b/content/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain.md @@ -14,7 +14,7 @@ topics: ### About domain verification -You can confirm that the websites and email addresses listed on the profiles of any organization owned by your enterprise account are controlled by your enterprise by verifying the domains. Verified domains for an enterprise account apply to every organization owned by the enterprise account, and organization owners can verify additional domains for their organizations. For more information, see "[Verifying your organization's domain](/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain)." +You can confirm that the websites and email addresses listed on the profiles of any organization owned by your enterprise account are controlled by your enterprise by verifying the domains. Verified domains for an enterprise account apply to every organization owned by the enterprise account, and organization owners can verify additional domains for their organizations. For more information, see "[Verifying your organization's domain](/organizations/managing-organization-settings/verifying-your-organizations-domain)." After you verify ownership of your enterprise account's domains, a "Verified" badge will display on the profile of each organization that has the domain listed on its profile. {% data reusables.organizations.verified-domains-details %} @@ -22,7 +22,7 @@ Organization owners will be able to verify the identity of organization members After you verify domains for your enterprise account, you can restrict email notifications to verified domains for all the organizations owned by your enterprise account. For more information, see "[Restricting email notifications for your enterprise account to approved domains](/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains)." -Even if you don't restrict email notifications for the enterprise account, if an organization owner has restricted email notifications for the organization, organization members will be able to receive notifications from any domains verified for the enterprise account, in addition to any domains verified for the organization. For more information about restricting notifications for an organization, see "[Restricting email notifications to an approved domain](/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain)." +Even if you don't restrict email notifications for the enterprise account, if an organization owner has restricted email notifications for the organization, organization members will be able to receive notifications from any domains verified for the enterprise account, in addition to any domains verified for the organization. For more information about restricting notifications for an organization, see "[Restricting email notifications to an approved domain](/organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain)." ### Verifying your enterprise account's domain diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md index 79372cb903..fceae001bb 100644 --- a/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md @@ -53,4 +53,4 @@ When you enable SAML single sign-on for your enterprise account, each enterprise ### Further reading -- "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization)" +- "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" diff --git a/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md b/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md index 0a158f8e14..14c6d1b4f4 100644 --- a/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md @@ -14,7 +14,7 @@ topics: You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories to the top of the page. -{% if currentVersion == "free-pro-team@latest" %}To confirm your organization's identity and display a "Verified" badge on your organization profile page, you must verify your organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying your organization's domain](/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain)." +{% if currentVersion == "free-pro-team@latest" %}To confirm your organization's identity and display a "Verified" badge on your organization profile page, you must verify your organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying your organization's domain](/organizations/managing-organization-settings/verifying-your-organizations-domain)." ![Sample verified organization profile page](/assets/images/help/profile/org_profile_verified.png) {% else %} @@ -23,4 +23,4 @@ You can optionally choose to add a description, location, website, and email add ### Further reading -- "[About organizations](/github/setting-up-and-managing-organizations-and-teams/about-organizations)" +- "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations)" diff --git a/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md b/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md index c5e362db8d..81a53fe920 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md +++ b/content/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address.md @@ -22,7 +22,7 @@ topics: ![Add another email address button](/assets/images/help/settings/add_another_email_address.png) 4. Under "Primary email address", use the drop-down menu to click the email address you'd like to set as your primary email address, and click **Save**. ![Set as primary button](/assets/images/help/settings/set_as_primary_email.png) -5. To remove the old email address from your account, next to the old email, click {% octicon "trashcan" aria-label="The trashcan symbol" %}. +5. To remove the old email address from your account, next to the old email, click {% octicon "trash" aria-label="The trash symbol" %}. {% if currentVersion == "free-pro-team@latest" %} 6. Verify your new primary email address. Without a verified email address, you won't be able to use all of {% data variables.product.product_name %}'s features. For more information, see "[Verifying your email address](/articles/verifying-your-email-address)." {% endif %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md index 73250f620d..7f6721362f 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md +++ b/content/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization.md @@ -55,7 +55,7 @@ You can also convert your personal user account directly into an organization. C {% tip %} -**Tip**: When you convert a user account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. You can then invite *outside collaborators* to become members of your new organization if you wish. For more information, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization#outside-collaborators)." +**Tip**: When you convert a user account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. You can then invite *outside collaborators* to become members of your new organization if you wish. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization#outside-collaborators)." {% endtip %} diff --git a/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md b/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md index ce6539cb9d..aabf30b994 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md @@ -60,4 +60,4 @@ Repositories owned by an organization can grant more granular access. For more i - "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-user-account)" - "[Removing a collaborator from a personal repository](/articles/removing-a-collaborator-from-a-personal-repository)" - "[Removing yourself from a collaborator's repository](/articles/removing-yourself-from-a-collaborator-s-repository)" -- "[Organizing members into teams](/articles/organizing-members-into-teams)" +- "[Organizing members into teams](/organizations/organizing-members-into-teams)" diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md b/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md index b199768a7b..e69c10b10b 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md @@ -28,4 +28,4 @@ When you create a new repository on {% data variables.product.product_location % ### Further reading -- "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)" +- "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)" diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md index 2284aaf647..b4fc8c5a9c 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders.md @@ -13,7 +13,7 @@ Scheduled reminders are used to make sure that users focus on the most important For certain events, you can also enable real-time alerts for scheduled reminders. Real-time alerts get sent to your Slack channel as soon as an important event, such as when you are assigned a review, takes place. -You can set scheduled reminders for personal or team-level review requests for pull requests in organizations you are a member of. Before you can create a scheduled reminder for yourself, an organization owner must authorize your Slack workspace. For more information, see "[Managing scheduled reminders for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization)." +You can set scheduled reminders for personal or team-level review requests for pull requests in organizations you are a member of. Before you can create a scheduled reminder for yourself, an organization owner must authorize your Slack workspace. For more information, see "[Managing scheduled reminders for your organization](/organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization)." {% data reusables.reminders.scheduled-reminders-limitations %} @@ -55,5 +55,5 @@ You can set scheduled reminders for personal or team-level review requests for p ### Further reading -- "[Managing scheduled reminders for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization)" -- "[Managing scheduled reminders for your team](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team)" +- "[Managing scheduled reminders for your organization](/organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization)" +- "[Managing scheduled reminders for your team](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team)" diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md index 609bb5e5a3..a23ad01464 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md @@ -1,25 +1,24 @@ --- title: Managing your theme settings -intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses light mode or dark mode.' +intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses a light or dark mode.' versions: free-pro-team: '*' topics: - accounts --- -{% note %} - -**Note:** Theme settings is currently in beta and subject to change. - -{% endnote %} - -For choice and flexibility in how and when you use {% data variables.product.product_name %}, you can configure theme settings to change how {% data variables.product.product_name %} looks to you. You can choose from two themes, light and dark, or you can configure {% data variables.product.product_name %} to follow your system settings. Some developers use dark theme for personal preference, to reduce power consumption on certain devices, or to reduce eye strain in low-light conditions. +For choice and flexibility in how and when you use {% data variables.product.product_name %}, you can configure theme settings to change how {% data variables.product.product_name %} looks to you. You can choose from themes that are light or dark, or you can configure {% data variables.product.product_name %} to follow your system settings. You may want to use a dark theme to reduce power consumption on certain devices, to reduce eye strain in low-light conditions, or because you prefer how the theme looks. {% data reusables.user_settings.access_settings %} 1. In the user settings sidebar, click **Appearance**. !["Appearance" tab in user settings sidebar](/assets/images/help/settings/appearance-tab.png) -1. Under "Theme", select a theme preference. - ![Radio buttons for theme settings](/assets/images/help/settings/theme-settings-radio-buttons.png) +1. Under "Theme mode", select the drop-down menu, then click a theme preference. + ![Drop-down menu under "Theme mode" for selection of theme preference](/assets/images/help/settings/theme-mode-drop-down-menu.png) +1. Click the theme you'd like to use. + - If you chose a single theme, click a theme. + ![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme.png) + - If you chose to follow your system settings, click a day theme and a night theme. + ![Buttons for the choice of a theme to sync with the system setting](/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync.png) ### Further reading diff --git a/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md b/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md index a1aa21b439..553aa7d0c6 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md @@ -28,7 +28,7 @@ While forks of private repositories are deleted when a collaborator is removed, {% data reusables.repositories.sidebar-settings %} {% if currentVersion == "free-pro-team@latest" %} {% data reusables.repositories.navigate-to-manage-access %} -4. To the right of the collaborator you want to remove, click {% octicon "trashcan" aria-label="The trashcan icon" %}. +4. To the right of the collaborator you want to remove, click {% octicon "trash" aria-label="The trash icon" %}. ![Button to remove collaborator](/assets/images/help/repository/collaborator-remove.png) {% else %} 3. In the left sidebar, click **Collaborators & teams**. diff --git a/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md b/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md index f646a305e4..cf61a31703 100644 --- a/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md +++ b/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md @@ -15,7 +15,7 @@ BY CLICKING THE "I AGREE" OR SIMILAR BUTTON OR BY USING ANY OF THE PRODUCTS (DEF This Agreement applies to the following GitHub offerings, as further defined below (collectively, the **"Products"**): -- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-On Software, and GitHub Enterprise Cloud) and GitHub One; +- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-On Software, and GitHub Enterprise Cloud); - Any Beta Previews; @@ -406,8 +406,6 @@ Some Service features may be subject to additional terms as set forth in the [Gi **"GitHub Insights"** or **“Insights”** means the Software feature which provides Customer with metrics, analytics, and recommendations relating to their use of the Software. GitHub Insights does not include legacy features of GitHub including Organization insights and repository insights. -**“GitHub One”** means the Product bundle which includes GitHub Enterprise, Advanced Security, Insights, Learning Lab for Enterprise Server, and Premium Plus or Engineering Direct Support. - **"Learning Lab for Enterprise Server"** means the Software feature that enables Users to learn about GitHub functionality, including associated Documentation. **"License Key"** means the data file used by the Software's access control mechanism that allows Customer to install, operate, and use the Software. diff --git a/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md b/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md index b58d9d35ad..6872bb4641 100644 --- a/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md +++ b/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md @@ -15,7 +15,7 @@ The following GitHub Supplemental Terms (including any applicable Order Forms) s These Supplemental Terms apply to the following GitHub Offerings, as further defined below (collectively, the "**Products**"): -- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-on Software, and GitHub Enterprise Cloud) and GitHub One; +- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-on Software, and GitHub Enterprise Cloud); - Any related Support; and @@ -274,8 +274,6 @@ In the event of a conflict between the Supplemental Terms, on one hand, and an O **"GitHub Insights"** or **“Insights”** means the Software feature which provides Customer with metrics, analytics, and recommendations relating to their use of the Software. GitHub Insights does not include legacy features of GitHub including organization insights and repository insights. -**“GitHub One”** means the Product bundle which includes GitHub Enterprise, Advanced Security, Insights, Learning Lab for Enterprise Server, and Premium Plus or Engineering Direct Support. - **"Learning Lab for Enterprise Server"** means the Software feature that enables Users to learn about GitHub functionality, including associated Documentation. **"License Key"** means the data file used by the Software's access control mechanism that allows Customer to install, operate, and use the Software. diff --git a/content/github/site-policy/github-corporate-terms-of-service.md b/content/github/site-policy/github-corporate-terms-of-service.md index abcec76772..fb8a4697ee 100644 --- a/content/github/site-policy/github-corporate-terms-of-service.md +++ b/content/github/site-policy/github-corporate-terms-of-service.md @@ -9,6 +9,8 @@ topics: - legal --- +_These terms apply to 1) GitHub.com (non-Enterprise) customers who have accepted the Corporate Terms of Service, and 2) Enterprise customers who licensed the Service prior to January 4, 2021. Enterprise customers who purchase Products or Services after that date are directed to https://github.com/enterprise-legal for current terms._ + THANK YOU FOR CHOOSING GITHUB FOR YOUR COMPANY’S BUSINESS NEEDS. PLEASE READ THIS AGREEMENT CAREFULLY AS IT GOVERNS USE OF THE PRODUCTS (AS DEFINED BELOW), UNLESS GITHUB HAS EXECUTED A SEPARATE WRITTEN AGREEMENT WITH CUSTOMER FOR THAT PURPOSE. BY CLICKING ON THE "I AGREE" OR SIMILAR BUTTON OR BY ACCESSING THE PRODUCTS, CUSTOMER ACCEPTS ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF CUSTOMER IS ENTERING INTO THIS AGREEMENT ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY, CUSTOMER REPRESENTS THAT IT HAS THE LEGAL AUTHORITY TO BIND THE COMPANY OR OTHER LEGAL ENTITY TO THIS AGREEMENT. diff --git a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md index a4b4d3fc5e..335eb3ea32 100644 --- a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md +++ b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md @@ -1,7 +1,6 @@ --- title: GitHub Insights and data protection for your organization intro: '{% data variables.product.prodname_insights %} analyzes your {% data variables.product.prodname_ghe_server %} data. This data could include personal data of individuals in your organization who may have the right to understand how such personal data is being used.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/github-insights-and-data-protection-for-your-organization - /enterprise-server@2.22/github/site-policy/github-insights-and-data-protection-for-your-organization @@ -14,8 +13,6 @@ topics: - legal --- -For more information about the terms that govern {% data variables.product.prodname_insights %}, see your {% data variables.product.prodname_ghe_one %} subscription agreement. - For the avoidance of doubt, none of the foregoing information should be considered legal advice provided by {% data variables.product.prodname_dotcom %}. You are responsible for securing your own legal analysis of the information provided herein and for your compliance with privacy and data protection laws. It is up to you whether to use {% data variables.product.prodname_insights %} to process your employees’ and users’ data, and if you do so, you are solely responsible for conducting such processing in compliance with applicable law. ### The organization’s roles and responsibilities diff --git a/content/github/site-policy/github-privacy-statement.md b/content/github/site-policy/github-privacy-statement.md index 974137d38e..50fe4dd423 100644 --- a/content/github/site-policy/github-privacy-statement.md +++ b/content/github/site-policy/github-privacy-statement.md @@ -192,7 +192,7 @@ Similarly, projects on GitHub may include publicly available User Personal Infor #### Organizations -You may indicate, through your actions on GitHub, that you are willing to share your User Personal Information. If you collaborate on or become a member of an Organization, then its Account owners may receive your User Personal Information. When you accept an invitation to an Organization, you will be notified of the types of information owners may be able to see (for more information, see [About Organization Membership](/github/setting-up-and-managing-your-github-user-account/about-organization-membership)). If you accept an invitation to an Organization with a [verified domain](/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain), then the owners of that Organization will be able to see your full email address(es) within that Organization's verified domain(s). +You may indicate, through your actions on GitHub, that you are willing to share your User Personal Information. If you collaborate on or become a member of an Organization, then its Account owners may receive your User Personal Information. When you accept an invitation to an Organization, you will be notified of the types of information owners may be able to see (for more information, see [About Organization Membership](/github/setting-up-and-managing-your-github-user-account/about-organization-membership)). If you accept an invitation to an Organization with a [verified domain](/organizations/managing-organization-settings/verifying-your-organizations-domain), then the owners of that Organization will be able to see your full email address(es) within that Organization's verified domain(s). Please note, GitHub may share your username, [Usage Information](#usage-information), and [Device Information](#device-information) with the owner(s) of the Organization you are a member of, to the extent that your User Personal Information is provided only to investigate or respond to a security incident that affects or compromises the security of that particular Organization. diff --git a/content/github/site-policy/github-subprocessors-and-cookies.md b/content/github/site-policy/github-subprocessors-and-cookies.md index c36e6115d1..09fc30434b 100644 --- a/content/github/site-policy/github-subprocessors-and-cookies.md +++ b/content/github/site-policy/github-subprocessors-and-cookies.md @@ -13,7 +13,7 @@ topics: - legal --- -Effective date: **January 29, 2021** +Effective date: **April 2, 2021** GitHub provides a great deal of transparency regarding how we use your data, how we collect your data, and with whom we share your data. To that end, we provide this page, which details [our subprocessors](#github-subprocessors), and how we use [cookies](#cookies-on-github). @@ -33,7 +33,6 @@ When we share your information with third party subprocessors, such as our vendo | MailChimp | Customer ticketing mail services provider | United States | United States | | Mailgun | Transactional mail services provider | United States | United States | | Microsoft | Microsoft Services | United States | United States | -| Monday.com | Team collaboration and project management platform | United States | Israel | | Nexmo | SMS notification provider | United States | United States | | Salesforce.com | Customer relations management | United States | United States | | Sentry.io | Application monitoring provider | United States | United States | diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md index 567107b3e5..5d9db83338 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -24,7 +24,9 @@ You can set a goal for your sponsorships. For more information, see "[Managing y ### Sponsorship tiers -{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)." +{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)." + +It's best to set up a range of different sponsorship options, including monthly and one-time tiers, to make it easy for anyone to support your work. In particular, one-time payments allow people to reward your efforts without worrying about whether their finances will support a regular payment schedule. ### Sponsorship payouts @@ -34,5 +36,9 @@ You can set a goal for your sponsorships. For more information, see "[Managing y For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors)." +### Sharing feedback about {% data variables.product.prodname_sponsors %} + +{% data reusables.sponsors.feedback %} + ### Further reading - "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md index 0169550a2d..a93f6df83a 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md @@ -37,7 +37,7 @@ To be eligible for the {% data variables.product.prodname_matching_fund %}, you ### Sharing feedback about {% data variables.product.prodname_sponsors %} -This is just the beginning — we'd love your input to make sure {% data variables.product.prodname_sponsors %} serves your needs into the future. Please send us your feedback or suggestions by contacting [{% data variables.contact.github_support %}](https://support.github.com/contact?form%5Bsubject%5D=GitHub+Sponsors). +{% data reusables.sponsors.feedback %} ### Further reading - "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md index 5b8efe069c..de523d754e 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md @@ -15,6 +15,8 @@ Your sponsors can choose whether they receive email updates about your work. For For sponsored developer accounts, the update will come from your user account's primary email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For sponsored organizations, the update will come from the organization's `noreply@github.com` email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." +You can also contact any one-time sponsors who contributed within the last 30 days and enabled updates. + ### Contacting your sponsors {% data reusables.sponsors.navigate-to-sponsors-dashboard %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md index 6623eceb6b..39d60b8feb 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md @@ -25,7 +25,7 @@ topics: {% link_in_list /setting-up-github-sponsors-for-your-organization %} {% link_in_list /editing-your-profile-details-for-github-sponsors %} {% link_in_list /managing-your-sponsorship-goal %} - {% link_in_list /changing-your-sponsorship-tiers %} + {% link_in_list /managing-your-sponsorship-tiers %} {% link_in_list /viewing-your-sponsors-and-sponsorships %} {% link_in_list /managing-your-payouts-from-github-sponsors %} {% link_in_list /configuring-webhooks-for-events-in-your-sponsored-account %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md index 1d9a6e18e3..9991858a58 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md @@ -13,6 +13,12 @@ You can set a funding goal for your sponsored account and share the goal with yo Your goal can set a target for the number of sponsors you want to have or the amount of money you want to earn each month. You can only set one goal up at a time. After you reach a goal, you can set another goal. +{% note %} + +**Note:** Goals are intended to help people track momentum so only monthly sponsors contribute toward your goal. + +{% endnote %} + ### Setting a goal {% data reusables.sponsors.navigate-to-sponsors-dashboard %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md similarity index 62% rename from content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md index f6d6dc0bd7..efb3ada4b5 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md @@ -1,8 +1,9 @@ --- -title: Changing your sponsorship tiers +title: Managing your sponsorship tiers intro: 'You can add a new sponsorship tier, or edit or retire an existing tier.' redirect_from: - /articles/changing-your-sponsorship-tiers + - /github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers versions: free-pro-team: '*' topics: @@ -32,3 +33,13 @@ topics: {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.tier-update %} {% data reusables.sponsors.retire-tier %} + +### Enabling tiers with custom amounts + +{% data reusables.sponsors.navigate-to-sponsors-dashboard %} +{% data reusables.sponsors.navigate-to-sponsor-tiers-tab %} +{% data reusables.sponsors.enable-custom-amounts %} + +### Disabling tiers with custom amounts + +You can disable tiers with custom amounts by deselecting the **Enable custom amounts** option on the **Sponsor tiers** tab. If you disable custom amounts, all custom tiers are retired. diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md index 5a7e674121..a73b66dc54 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -48,6 +48,7 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.review-and-publish-tier %} +{% data reusables.sponsors.enable-custom-amounts %} {% data reusables.sponsors.add-more-tiers %} ### Submitting your bank information diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md index 6104ee4c03..b42f036470 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md @@ -48,6 +48,7 @@ After {% data variables.product.prodname_dotcom %} reviews your application, you {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.review-and-publish-tier %} +{% data reusables.sponsors.enable-custom-amounts %} {% data reusables.sponsors.add-more-tiers %} ### Submitting your bank information diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md index c09ee905fb..aa7befca82 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md @@ -1,6 +1,6 @@ --- title: Sponsoring an open source contributor -intro: 'You can make a monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.' +intro: 'You can make a one-time or monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.' redirect_from: - /articles/sponsoring-a-developer - /articles/sponsoring-an-open-source-contributor @@ -24,11 +24,11 @@ You can sponsor an account on behalf of your user account to invest in projects - Developing brand awareness as an organization that values open source - Thanking open source developers for building libraries that complement the product your organization offers -You can use a credit card to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, [contact us](https://support.github.com/contact/org-sponsors-waitlist). +You use your normal payment method to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, [contact us](https://support.github.com/contact/org-sponsors-waitlist). {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %} +When you sponsor an account the change is effective immediately, unless you are sponsoring on behalf of an organization that pays by invoice. {% data reusables.sponsors.prorated-sponsorship %} Your sponsorship is included in the next scheduled payment to the sponsored account. {% data reusables.sponsors.manage-updates-for-orgs %} @@ -56,6 +56,7 @@ Before you can sponsor an account, you must have a verified email address. For m ![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png) 1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization. ![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png) +{% data reusables.sponsors.review-tiers-to-select %} {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.pay-prorated-amount %} {% data reusables.sponsors.select-sponsorship-billing %} diff --git a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md index 8715b60c43..902c498890 100644 --- a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md +++ b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md @@ -6,25 +6,19 @@ versions: topics: - repositories --- + ### Dependency graph availability -The dependency graph is available for every{% if currentVersion == "free-pro-team@latest" %} public{% endif %} repository that defines dependencies in a supported package ecosystem using a supported file format.{% if currentVersion == "free-pro-team@latest" %} Repository administrators can also set up the dependency graph for private repositories.{% endif %} +The dependency graph is available for every repository that defines dependencies in a supported package ecosystem using a supported file format. {% data reusables.repositories.enable-security-alerts %} ### About the dependency graph -The dependency graph is a summary of the manifest and lock files stored in a repository. For each repository, it shows{% if currentVersion == "free-pro-team@latest" %}: +The dependency graph is a summary of the manifest and lock files stored in a repository. For each repository, it shows dependencies, that is, the ecosystems and packages it depends on. {% data variables.product.prodname_ghe_server %} does not calculate information about dependents, the repositories and packages that depend on a repository. -- Dependencies, the ecosystems and packages it depends on -- Dependents, the repositories and packages that depend on it{% else %} dependencies, that is, the ecosystems and packages it depends on. {% data variables.product.prodname_ghe_server %} does not calculate information about dependents, the repositories and packages that depend on a repository.{% endif %} - -When you push a commit to {% data variables.product.product_name %} that changes or adds a supported manifest or lock file to the default branch, the dependency graph is automatically updated.{% if currentVersion == "free-pro-team@latest" %} In addition, the graph is updated when anyone pushes a change to the repository of one of your dependencies.{% endif %} For information on the supported ecosystems and manifest files, see "[Supported package ecosystems](#supported-package-ecosystems)" below. - -{% if currentVersion == "free-pro-team@latest" %} -When you create a pull request containing changes to dependencies that targets the default branch, {% data variables.product.prodname_dotcom %} uses the dependency graph to add dependency reviews to the pull request. These indicate whether the dependencies contain vulnerabilities and, if so, the version of the dependency in which the vulnerability was fixed. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)." -{% endif %} +When you push a commit to {% data variables.product.product_name %} that changes or adds a supported manifest or lock file to the default branch, the dependency graph is automatically updated. For information on the supported ecosystems and manifest files, see "[Supported package ecosystems](#supported-package-ecosystems)" below. ### Dependencies included @@ -33,40 +27,30 @@ The dependency graph includes all the dependencies of a repository that are deta - Direct dependencies, that are explicitly defined in a manifest or lock file - Indirect dependencies of these direct dependencies, also known as transitive dependencies or sub-dependencies -The dependency graph identifies indirect dependencies{% if currentVersion == "free-pro-team@latest" %} either explicitly from a lock file or by checking the dependencies of your direct dependencies. For the most reliable graph, you should use lock files (or their equivalent) because they define exactly which versions of the direct and indirect dependencies you currently use. If you use lock files, you also ensure that all contributors to the repository are using the same versions, which will make it easier for you to test and debug code{% else %} from the lock files{% endif %}. - -{% if currentVersion == "free-pro-team@latest" %} -### Dependents included - -For public repositories, only public repositories that depend on it or on packages that it publishes are reported. This information is not reported for private repositories.{% endif %} +The dependency graph identifies indirect dependencies. ### Using the dependency graph You can use the dependency graph to: -- Explore the repositories your code depends on{% if currentVersion == "free-pro-team@latest" %}, and those that depend on it{% endif %}. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)." {% if currentVersion == "free-pro-team@latest" %} -- View a summary of the dependencies used in your organization's repositories in a single dashboard. For more information, see "[Viewing insights for your organization](/articles/viewing-insights-for-your-organization#viewing-organization-dependency-insights)."{% endif %} -- View and update vulnerable dependencies for your repository. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."{% if currentVersion == "free-pro-team@latest" %} -- See information about vulnerable dependencies in pull requests. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."{% endif %} +- Explore the repositories your code depends on. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)." +- View and update vulnerable dependencies for your repository. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." ### Enabling the dependency graph -{% if currentVersion == "free-pro-team@latest" %}To generate a dependency graph, {% data variables.product.product_name %} needs read-only access to the dependency manifest and lock files for a repository. The dependency graph is automatically generated for all public repositories and you can choose to enable it for private repositories. For information about enabling or disabling it for private repositories, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)."{% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}If the dependency graph is not available in your system, your site administrator can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %} {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} If the dependency graph is not available in your system, your site administrator can enable the dependency graph and security alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)." {% endif %} -When the dependency graph is first enabled, any manifest and lock files for supported ecosystems are parsed immediately. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. Once enabled, the graph is automatically updated with every push to the repository{% if currentVersion == "free-pro-team@latest" %} and every push to other repositories in the graph{% endif %}. +When the dependency graph is first enabled, any manifest and lock files for supported ecosystems are parsed immediately. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. Once enabled, the graph is automatically updated with every push to the repository. ### Supported package ecosystems -The recommended formats explicitly define which versions are used for all direct and all indirect dependencies. If you use these formats, your dependency graph is more accurate. It also reflects the current build set up and enables the dependency graph to report vulnerabilities in both direct and indirect dependencies.{% if currentVersion == "free-pro-team@latest" %} Indirect dependencies that are inferred from a manifest file (or equivalent) are excluded from the checks for vulnerable dependencies.{% endif %} +The recommended formats explicitly define which versions are used for all direct and all indirect dependencies. If you use these formats, your dependency graph is more accurate. It also reflects the current build set up and enables the dependency graph to report vulnerabilities in both direct and indirect dependencies. -{% if currentVersion == "free-pro-team@latest" %}The ecosystems listed below are supported for the dependency graph, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_dependabot_security_updates %}.{% endif %} -{% if currentVersion ver_gt "enterprise-server@2.21" %}The ecosystems listed below are supported for the dependency graph and {% data variables.product.prodname_dependabot_alerts %}.{% endif %} +The ecosystems listed below are supported for the dependency graph and {% if currentVersion == "enterprise-server@2.22" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}. | Package manager | Languages | Recommended formats | All supported formats | | --- | --- | --- | ---| @@ -87,7 +71,4 @@ The recommended formats explicitly define which versions are used for all direct ### Further reading - "[Dependency graph](https://en.wikipedia.org/wiki/Dependency_graph)" on Wikipedia -- "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)"{% if currentVersion == "free-pro-team@latest" %} -- "[Viewing insights for your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization)" -- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)"{% endif %} +- "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)" diff --git a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md index 56d82c7dea..7e2c1e2851 100644 --- a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md +++ b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md @@ -6,30 +6,20 @@ versions: topics: - repositories --- + ### Viewing the dependency graph {% data reusables.repositories.enable-security-alerts %} -The dependency graph shows the dependencies{% if currentVersion == "free-pro-team@latest" %} and dependents{% endif %} of your repository. For information about the detection of dependencies and which ecosystems are supported, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +The dependency graph shows the dependencies of your repository. For information about the detection of dependencies and which ecosystems are supported, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -{% data reusables.repositories.click-dependency-graph %}{% if currentVersion == "free-pro-team@latest" %} -4. Optionally, under "Dependency graph", click **Dependents**. -![Dependents tab on the dependency graph page](/assets/images/help/graphs/dependency-graph-dependents-tab.png){% endif %} +{% data reusables.repositories.click-dependency-graph %} #### Dependencies view -{% if currentVersion == "free-pro-team@latest" %} -Dependencies are grouped by ecosystem. You can expand a dependency to view its dependencies. For dependencies on public repositories hosted on {% data variables.product.product_name %}, you can also click a dependency to view the repository. Dependencies on private repositories, private packages, or unrecognized files are shown in plain text. - -If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_alerts %}. - -![Dependencies graph](/assets/images/help/graphs/dependencies_graph.png) - -{% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_alerts %}. @@ -56,60 +46,8 @@ Any direct and indirect dependencies that are specified in the repository's mani {% endif %} -{% if currentVersion == "free-pro-team@latest" %} -#### Dependents view - -For public repositories, the dependents view shows how the repository is used by other repositories. To show only the repositories that contain a library in a package manager, click **NUMBER Packages** immediately above the list of dependent repositories. The dependent counts are approximate and may not always match the dependents listed. - -![Dependents graph](/assets/images/help/graphs/dependents_graph.png) - -### Enabling and disabling the dependency graph for a private repository - -Repository administrators can enable or disable the dependency graph for private repositories. - -You can also enable or disable the dependency graph for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.repositories.navigate-to-security-and-analysis %} -4. Read the message about granting {% data variables.product.product_name %} read-only access to the repository data to enable the dependency graph, then next to "Dependency Graph", click **Enable**. - !["Enable" button for the dependency graph](/assets/images/help/repository/dependency-graph-enable-button.png) - -You can disable the dependency graph at any time by clicking **Disable** next to "Dependency Graph" on the Security & analysis tab. - -### Changing the "Used by" package - -If the dependency graph is enabled, and your repository contains a package that's published on a supported package ecosystem, {% data variables.product.prodname_dotcom %} displays a "Used by" section in the sidebar of the **Code** tab of your repository. For more information about the supported package ecosystems, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." - -The "Used by" section shows the number of public references to the package that were found, and displays the avatars of some of the owners of the dependent projects. - -!["Used by" sidebar section](/assets/images/help/repository/used-by-section.png) - -Clicking any item in this section takes you to the **Dependents** tab of the dependency graph. - -The "Used by" section represents a single package from the repository. If you have admin permissions to a repository that contains multiple packages, you can choose which package the "Used by" section represents. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.repositories.navigate-to-security-and-analysis %} -4. Under "Configure security and analysis features", click the drop-down menu in the "Used by counter" section and choose a package. - ![Choose a "Used by" package](/assets/images/help/repository/choose-used-by-package.png) - -{% endif %} - ### Troubleshooting the dependency graph If your dependency graph is empty, there may be a problem with the file containing your dependencies. Check the file to ensure that it's correctly formatted for the file type. -{% if currentVersion == "free-pro-team@latest" %} -If the file is correctly formatted, then check its size. The dependency graph ignores individual manifest and lock files that are over 0.5 Mb, unless you are a {% data variables.product.prodname_enterprise %} user. It processes up to 20 manifest or lock files per repository by default, so you can split dependencies into smaller files in subdirectories of the repository.{% endif %} - If a manifest or lock file is not processed, its dependencies are omitted from the dependency graph and they can't be checked for vulnerable dependencies. - -### Further reading - -- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"{% if currentVersion == "free-pro-team@latest" %} -- "[Viewing insights for your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization)" -- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" -- "[Understanding how {% data variables.product.product_name %} uses and protects your data](/github/understanding-how-github-uses-and-protects-your-data)" -{% endif %} diff --git a/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md b/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md index 82c8aa865b..a7657b346f 100644 --- a/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md +++ b/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md @@ -1,6 +1,6 @@ --- title: About GitHub Premium Support for GitHub Enterprise Cloud -intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_one %} customers.' +intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_ghe_cloud %} customers.' redirect_from: - /articles/about-github-premium-support - /articles/about-github-premium-support-for-github-enterprise-cloud diff --git a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md index 5886cb0717..f1e473fd00 100644 --- a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md +++ b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md @@ -23,7 +23,7 @@ To create a heading, add one to six `#` symbols before your heading text. The nu ### Styling text -You can indicate emphasis with bold, italic, or strikethrough text. +You can indicate emphasis with bold, italic, or strikethrough text in comment fields and `.md` files. | Style | Syntax | Keyboard shortcut | Example | Output | | --- | --- | --- | --- | --- | @@ -205,6 +205,10 @@ Content attachments will not be displayed for URLs that are part of a markdown l For more information about building a {% data variables.product.prodname_github_app %} that uses content attachments, see "[Using Content Attachments](/apps/using-content-attachments)." +### Uploading assets + +You can upload assets like images by dragging and dropping, selecting from a file browser, or pasting. You can upload assets to issues, pull requests, comments, and `.md` files in your repository. + ### Using emoji You can add emoji to your writing by typing `:EMOJICODE:`. diff --git a/content/graphql/overview/breaking-changes.md b/content/graphql/overview/breaking-changes.md index 6cdf450bef..4b22e72a42 100644 --- a/content/graphql/overview/breaking-changes.md +++ b/content/graphql/overview/breaking-changes.md @@ -27,7 +27,7 @@ We'll announce upcoming breaking changes at least three months before making cha {% for change in date[1] %}
    -
  • {% if change.criticality == 'breaking' %}Breaking{% else %}Dangerous{% endif %} A change will be made to {{ change.location }}. +
  • {% if change.criticality == 'breaking' %}Breaking{% else %}Dangerous{% endif %} A change will be made to {{ change.location }}.

    Description: {{ change.description }}

    diff --git a/content/graphql/reference/input-objects.md b/content/graphql/reference/input-objects.md index 35065838c7..5750a94381 100644 --- a/content/graphql/reference/input-objects.md +++ b/content/graphql/reference/input-objects.md @@ -19,6 +19,5 @@ For example, [`CommitAuthor`](/graphql/reference/input-objects#commitauthor) tak For more information, see "[About mutations](/graphql/guides/forming-calls-with-graphql#about-mutations)." -{% for item in graphql.schemaForCurrentVersion.inputObjects %} - {% include graphql-input-object %} -{% endfor %} + + diff --git a/content/index.md b/content/index.md index 8a144eecbf..82990b3fbb 100644 --- a/content/index.md +++ b/content/index.md @@ -13,5 +13,43 @@ featuredLinks: - /github/getting-started-with-github/managing-remote-repositories - /github/working-with-github-pages versions: '*' +children: + - github + - admin + - organizations + - code-security + - actions + - packages + - developers + - rest + - graphql + - insights + - discussions + - communities + - pages + - education + - desktop + - early-access +externalProducts: + cli: + id: cli + name: GitHub CLI + href: 'https://cli.github.com/manual' + external: true + atom: + id: atom + name: Atom + href: 'https://atom.io/docs' + external: true + electron: + id: electron + name: Electron + href: 'https://electronjs.org/docs' + external: true + codeql: + id: codeql + name: 'CodeQL' + href: 'https://codeql.github.com/docs' + external: true --- diff --git a/content/insights/exploring-your-usage-of-github-enterprise/metrics-available-with-github-insights.md b/content/insights/exploring-your-usage-of-github-enterprise/metrics-available-with-github-insights.md index 5fd646f6fb..7ecd3979d8 100644 --- a/content/insights/exploring-your-usage-of-github-enterprise/metrics-available-with-github-insights.md +++ b/content/insights/exploring-your-usage-of-github-enterprise/metrics-available-with-github-insights.md @@ -1,6 +1,5 @@ --- title: Metrics available with GitHub Insights -product: '{% data reusables.gated-features.github-insights %}' intro: '{% data variables.product.prodname_insights %} includes a variety of metrics to give you visibility into your team''s software delivery process.' redirect_from: - /github/installing-and-configuring-github-insights/metrics-available-with-github-insights diff --git a/content/insights/exploring-your-usage-of-github-enterprise/navigating-between-github-enterprise-and-github-insights.md b/content/insights/exploring-your-usage-of-github-enterprise/navigating-between-github-enterprise-and-github-insights.md index 2896caf64e..795fdf2ffb 100644 --- a/content/insights/exploring-your-usage-of-github-enterprise/navigating-between-github-enterprise-and-github-insights.md +++ b/content/insights/exploring-your-usage-of-github-enterprise/navigating-between-github-enterprise-and-github-insights.md @@ -1,7 +1,6 @@ --- title: Navigating between GitHub Enterprise and GitHub Insights intro: '' -product: '{% data reusables.gated-features.github-insights %}' permissions: 'Anyone with access to {% data variables.product.prodname_insights %} can navigate between {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_insights %}.' versions: enterprise-server: '*' diff --git a/content/insights/exploring-your-usage-of-github-enterprise/setting-your-timezone-for-github-insights.md b/content/insights/exploring-your-usage-of-github-enterprise/setting-your-timezone-for-github-insights.md index d8b614cf20..17c91b8cbe 100644 --- a/content/insights/exploring-your-usage-of-github-enterprise/setting-your-timezone-for-github-insights.md +++ b/content/insights/exploring-your-usage-of-github-enterprise/setting-your-timezone-for-github-insights.md @@ -1,7 +1,6 @@ --- title: Setting your timezone for GitHub Insights intro: 'You can set the timezone for metrics you view in {% data variables.product.prodname_insights %}.' -product: '{% data reusables.gated-features.github-insights %}' permissions: 'Anyone with access to {% data variables.product.prodname_insights %} can set their own timezone.' versions: enterprise-server: '*' diff --git a/content/insights/exploring-your-usage-of-github-enterprise/viewing-key-metrics-and-reports.md b/content/insights/exploring-your-usage-of-github-enterprise/viewing-key-metrics-and-reports.md index 31703a70f5..cb07224139 100644 --- a/content/insights/exploring-your-usage-of-github-enterprise/viewing-key-metrics-and-reports.md +++ b/content/insights/exploring-your-usage-of-github-enterprise/viewing-key-metrics-and-reports.md @@ -1,7 +1,6 @@ --- title: Viewing key metrics and reports intro: You can view and filter key metrics and reports to help you understand and improve your software delivery process through data. -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/viewing-and-filtering-key-metrics-and-reports permissions: 'Anyone with access to {% data variables.product.prodname_insights %} can view key metrics and reports.' diff --git a/content/insights/installing-and-configuring-github-insights/about-data-in-github-insights.md b/content/insights/installing-and-configuring-github-insights/about-data-in-github-insights.md index 90bf3a0747..f47e9ebe36 100644 --- a/content/insights/installing-and-configuring-github-insights/about-data-in-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/about-data-in-github-insights.md @@ -1,7 +1,6 @@ --- title: About data in GitHub Insights intro: 'The data included in {% data variables.product.prodname_insights %} metrics is highly customizable.' -product: '{% data reusables.gated-features.github-insights %}' permissions: '' versions: enterprise-server: '*' diff --git a/content/insights/installing-and-configuring-github-insights/about-github-insights.md b/content/insights/installing-and-configuring-github-insights/about-github-insights.md index 05fcc49f86..0bc475ceed 100644 --- a/content/insights/installing-and-configuring-github-insights/about-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/about-github-insights.md @@ -1,7 +1,6 @@ --- title: About GitHub Insights intro: '{% data variables.product.prodname_insights %} provides metrics and analytical reports to help engineering teams understand and improve their software delivery process.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/about-github-insights versions: diff --git a/content/insights/installing-and-configuring-github-insights/configuring-the-connection-between-github-insights-and-github-enterprise.md b/content/insights/installing-and-configuring-github-insights/configuring-the-connection-between-github-insights-and-github-enterprise.md index 6cbf5de5cc..93f8e312b3 100644 --- a/content/insights/installing-and-configuring-github-insights/configuring-the-connection-between-github-insights-and-github-enterprise.md +++ b/content/insights/installing-and-configuring-github-insights/configuring-the-connection-between-github-insights-and-github-enterprise.md @@ -1,7 +1,6 @@ --- title: Configuring the connection between GitHub Insights and GitHub Enterprise intro: 'You can manage how {% data variables.product.prodname_insights %} connects to {% data variables.product.prodname_enterprise %}.' -product: '{% data reusables.gated-features.github-insights %}' permissions: 'People with admin permissions to {% data variables.product.prodname_insights %} can configure the connection to {% data variables.product.prodname_enterprise %}.' versions: enterprise-server: '*' diff --git a/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md b/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md index 1a459b1fe1..6c04c47614 100644 --- a/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md +++ b/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md @@ -1,7 +1,6 @@ --- title: Enabling a link between GitHub Insights and GitHub Enterprise intro: 'You can enable a link that will allow users to navigate from {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_insights %}.' -product: '{% data reusables.gated-features.github-insights %}' permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} can enable a link between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_insights %}.' redirect_from: - /github/installing-and-configuring-github-insights/navigating-between-github-insights-and-github-enterprise diff --git a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md index 60e25e8f1a..e992afa2bd 100644 --- a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md @@ -1,7 +1,6 @@ --- title: Installing GitHub Insights intro: 'You can install {% data variables.product.prodname_insights %} and connect the standalone application to {% data variables.product.prodname_ghe_server %}.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/installing-github-insights permissions: 'Organization owners in {% data variables.product.prodname_enterprise %} with read permissions to the `github/insights-releases` repository and administrative access to the application server can install {% data variables.product.prodname_insights %}.' diff --git a/content/insights/installing-and-configuring-github-insights/managing-available-metrics-and-reports.md b/content/insights/installing-and-configuring-github-insights/managing-available-metrics-and-reports.md index 63ef9134f5..8dcd5e92f5 100644 --- a/content/insights/installing-and-configuring-github-insights/managing-available-metrics-and-reports.md +++ b/content/insights/installing-and-configuring-github-insights/managing-available-metrics-and-reports.md @@ -1,7 +1,6 @@ --- title: Managing available metrics and reports intro: 'You can enable and disable specific metrics across {% data variables.product.prodname_insights %}.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/managing-settings-in-github-insights permissions: 'People with admin permissions to {% data variables.product.prodname_insights %} can manage available metrics and reports.' diff --git a/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md b/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md index 7c054d9bdb..ddeaeca37c 100644 --- a/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md +++ b/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md @@ -1,7 +1,6 @@ --- title: Managing contributors and teams intro: You can manage the people and teams included in metrics and reports. -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/managing-contributors-and-teams permissions: 'People with admin permissions in {% data variables.product.prodname_insights %} can manage contributors and teams.' @@ -81,7 +80,7 @@ You can merge contributors manually or automatically, based on contributors {% d ### Managing teams in {% data variables.product.prodname_insights %} -There are two types of teams in {% data variables.product.prodname_insights %}: teams imported from {% data variables.product.product_name %} and custom teams. +There are two types of teams in {% data variables.product.prodname_insights %}: teams imported from {% data variables.product.product_name %} and custom teams. When an organization is added to {% data variables.product.prodname_insights %}, all of the organization's teams are imported from {% data variables.product.product_name %}. You can search and filter by these teams in {% data variables.product.prodname_insights %}. You can manage the teams in {% data variables.product.product_name %}. @@ -111,8 +110,8 @@ You can create and manage custom teams in {% data variables.product.prodname_ins {% data reusables.github-insights.settings-tab %} {% data reusables.github-insights.teams-tab %} {% data reusables.github-insights.edit-team %} -3. To the right of the contributor you'd like to remove, click {% octicon "trashcan" aria-label="The trashcan icon" %}. - ![Trashcan button](/assets/images/help/insights/contributor-trashcan.png) +3. To the right of the contributor you'd like to remove, click {% octicon "trash" aria-label="The trash icon" %}. + ![trash button](/assets/images/help/insights/contributor-trashcan.png) #### Renaming a custom team diff --git a/content/insights/installing-and-configuring-github-insights/managing-events.md b/content/insights/installing-and-configuring-github-insights/managing-events.md index e857b38f09..fc4ae321a2 100644 --- a/content/insights/installing-and-configuring-github-insights/managing-events.md +++ b/content/insights/installing-and-configuring-github-insights/managing-events.md @@ -1,7 +1,6 @@ --- title: Managing events intro: '{% data reusables.github-insights.events %}' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/creating-and-managing-events permissions: 'People with admin permissions to {% data variables.product.prodname_insights %} can manage events.' @@ -33,6 +32,6 @@ After you create an event in {% data variables.product.prodname_insights %}, any {% data reusables.github-insights.settings-tab %} {% data reusables.github-insights.events-tab %} -3. To the right of the event you want to delete, click **{% octicon "trashcan" aria-label="The trashcan icon" %}**. +3. To the right of the event you want to delete, click **{% octicon "trash" aria-label="The trash icon" %}**. ![Trash can button](/assets/images/help/insights/trashcan-button.png) 4. Click **Confirm**. diff --git a/content/insights/installing-and-configuring-github-insights/managing-goals.md b/content/insights/installing-and-configuring-github-insights/managing-goals.md index 302025dbe3..20f15a6e95 100644 --- a/content/insights/installing-and-configuring-github-insights/managing-goals.md +++ b/content/insights/installing-and-configuring-github-insights/managing-goals.md @@ -1,7 +1,6 @@ --- title: Managing goals intro: You can use goals to set targets for key metrics and measure success reaching those targets. -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/creating-and-managing-goals permissions: 'Anyone with access to {% data variables.product.prodname_insights %} can manage goals.' diff --git a/content/insights/installing-and-configuring-github-insights/managing-organizations.md b/content/insights/installing-and-configuring-github-insights/managing-organizations.md index e4cf45dbab..ebdcc9ee7f 100644 --- a/content/insights/installing-and-configuring-github-insights/managing-organizations.md +++ b/content/insights/installing-and-configuring-github-insights/managing-organizations.md @@ -1,7 +1,6 @@ --- title: Managing organizations intro: 'You can manage the {% data variables.product.prodname_enterprise %} organizations that are included in metrics.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/managing-organizations permissions: 'People with admin permissions in {% data variables.product.prodname_insights %} can manage organizations.' diff --git a/content/insights/installing-and-configuring-github-insights/managing-permissions-in-github-insights.md b/content/insights/installing-and-configuring-github-insights/managing-permissions-in-github-insights.md index f747452514..8bf8c4d001 100644 --- a/content/insights/installing-and-configuring-github-insights/managing-permissions-in-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/managing-permissions-in-github-insights.md @@ -1,7 +1,6 @@ --- title: Managing permissions in GitHub Insights intro: 'You can update a user''s permissions in {% data variables.product.prodname_insights %}.' -product: '{% data reusables.gated-features.github-insights %}' permissions: 'People with admin permissions to {% data variables.product.prodname_insights %} can manage permissions.' versions: enterprise-server: '*' diff --git a/content/insights/installing-and-configuring-github-insights/managing-repositories.md b/content/insights/installing-and-configuring-github-insights/managing-repositories.md index 6f25f6b333..266e428652 100644 --- a/content/insights/installing-and-configuring-github-insights/managing-repositories.md +++ b/content/insights/installing-and-configuring-github-insights/managing-repositories.md @@ -1,7 +1,6 @@ --- title: Managing repositories intro: 'You can manage the repositories connected to {% data variables.product.prodname_insights %} and the data included in metrics for each repository.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/managing-repositories permissions: 'People with admin permissions in {% data variables.product.prodname_insights %} can manage repositories. ' diff --git a/content/insights/installing-and-configuring-github-insights/system-overview-for-github-insights.md b/content/insights/installing-and-configuring-github-insights/system-overview-for-github-insights.md index e42f1f43c2..17a49b1c4a 100644 --- a/content/insights/installing-and-configuring-github-insights/system-overview-for-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/system-overview-for-github-insights.md @@ -1,7 +1,6 @@ --- title: System overview for GitHub Insights intro: '{% data variables.product.prodname_insights %} is a standalone application which interfaces with {% data variables.product.prodname_enterprise %}.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/system-overview-for-github-insights versions: diff --git a/content/insights/installing-and-configuring-github-insights/updating-github-insights.md b/content/insights/installing-and-configuring-github-insights/updating-github-insights.md index e17b23f341..20cca11a52 100644 --- a/content/insights/installing-and-configuring-github-insights/updating-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/updating-github-insights.md @@ -1,7 +1,6 @@ --- title: Updating GitHub Insights intro: 'You can update to the latest version of {% data variables.product.prodname_insights %} to benefit from improvements and bug fixes.' -product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/updating-github-insights permissions: 'People with read permissions to the `github/insights-releases` repository and administrative access to the application server can update {% data variables.product.prodname_insights %}.' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md b/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md rename to content/organizations/collaborating-with-groups-in-organizations/about-organizations.md index 9b777b5eee..f2dda89e95 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md +++ b/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md @@ -3,6 +3,7 @@ title: About organizations intro: Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. redirect_from: - /articles/about-organizations + - /github/setting-up-and-managing-organizations-and-teams/about-organizations versions: free-pro-team: '*' enterprise-server: '*' @@ -23,7 +24,7 @@ For organizations that belong to an enterprise account, billing is managed at th {% data reusables.gated-features.enterprise-accounts %} -{% data reusables.organizations.org-ownership-recommendation %} For more information, see "[Maintaining ownership continuity for your organization](/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization)." +{% data reusables.organizations.org-ownership-recommendation %} For more information, see "[Maintaining ownership continuity for your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization)." ### Terms of service and data protection for organizations diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md b/content/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md rename to content/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard.md index c2c416383a..6b42ae2b62 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md +++ b/content/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard.md @@ -3,6 +3,7 @@ title: About your organization dashboard intro: 'As an organization member, you can visit your organization''s dashboard throughout the day to stay updated on recent activity and keep track of issues and pull requests you''re working on or following in the organization.' redirect_from: - /articles/about-your-organization-dashboard + - /github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md b/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md rename to content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md index daa42f63eb..0716148ce9 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md +++ b/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md @@ -5,6 +5,7 @@ redirect_from: - /articles/news-feed/ - /articles/about-your-organization-s-news-feed - /articles/about-your-organizations-news-feed + - /github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md b/content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md rename to content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md index cbddd686f4..77c054c4be 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md +++ b/content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md @@ -8,6 +8,7 @@ redirect_from: - /articles/managing-an-organization-s-settings/ - /articles/accessing-your-organization-s-settings - /articles/accessing-your-organizations-settings + - /github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings intro: 'The organization account settings page provides several ways to manage the account, such as billing, team membership, and repository settings.' versions: free-pro-team: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md b/content/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md rename to content/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch.md index db638bafff..160442e4f7 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md +++ b/content/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch.md @@ -8,6 +8,7 @@ versions: redirect_from: - /articles/creating-a-new-organization-from-scratch - /admin/user-management/creating-organizations + - /github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch topics: - organizations - teams diff --git a/content/organizations/collaborating-with-groups-in-organizations/index.md b/content/organizations/collaborating-with-groups-in-organizations/index.md new file mode 100644 index 0000000000..1cff1af763 --- /dev/null +++ b/content/organizations/collaborating-with-groups-in-organizations/index.md @@ -0,0 +1,22 @@ +--- +title: Collaborating with groups in organizations +intro: Groups of people can collaborate across many projects at the same time in organization accounts. +redirect_from: + - /articles/creating-a-new-organization-account/ + - /articles/collaborating-with-groups-in-organizations + - /github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +{% link_in_list /about-organizations %} +{% link_in_list /about-your-organization-dashboard %} +{% link_in_list /creating-a-new-organization-from-scratch %} +{% link_in_list /accessing-your-organizations-settings %} +{% link_in_list /about-your-organizations-news-feed %} +{% link_in_list /viewing-insights-for-your-organization %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md b/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md similarity index 82% rename from content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md rename to content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md index ff36847928..d5302d7056 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md +++ b/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'Organization insights provide data about your organization''s activity, product: '{% data reusables.gated-features.org-insights %}' redirect_from: - /articles/viewing-insights-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization versions: free-pro-team: '*' topics: @@ -50,9 +51,8 @@ With dependency insights you can view vulnerabilities, licenses, and other impor 7. You can click on {% octicon "package" aria-label="The package icon" %} **dependents** next to each vulnerability to see which dependents in your organization are using each library. ![My organizations vulnerable dependents](/assets/images/help/organizations/org-insights-dependencies-vulnerable-item.png) - ### Further reading - - - "[About organizations](/github/setting-up-and-managing-organizations-and-teams/about-organizations)" - - "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)" - - "[Changing the visibility of your organization's dependency insights](/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights)" - - "[Enforcing a policy on dependency insights in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account)" +### Further reading + - "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations)" + - "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)" + - "[Changing the visibility of your organization's dependency insights](/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights)" + - "[Enforcing a policy on dependency insights in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-team-discussions.md b/content/organizations/collaborating-with-your-team/about-team-discussions.md similarity index 90% rename from content/github/setting-up-and-managing-organizations-and-teams/about-team-discussions.md rename to content/organizations/collaborating-with-your-team/about-team-discussions.md index d95bfccf08..fd015fd529 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-team-discussions.md +++ b/content/organizations/collaborating-with-your-team/about-team-discussions.md @@ -4,6 +4,7 @@ intro: 'Your team can plan together, update one another, or talk about any topic redirect_from: - /articles/about-team-discussions - /github/building-a-strong-community/about-team-discussions + - /github/setting-up-and-managing-organizations-and-teams/about-team-discussions versions: free-pro-team: '*' enterprise-server: '*' @@ -18,7 +19,7 @@ Any organization member can post on your team's page or participate in a public ![Discussions tab of team page with public and private discussions](/assets/images/help/organizations/team-page-discussions-tab.png) -You can link to any team discussion to reference it elsewhere. You can pin important posts to your team's page for quick reference later. For more information, see "[Pinning a team discussion](/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion)." +You can link to any team discussion to reference it elsewhere. You can pin important posts to your team's page for quick reference later. For more information, see "[Pinning a team discussion](/organizations/collaborating-with-your-team/pinning-a-team-discussion)." ![Pinned discussions tab of team page with pinned discussion](/assets/images/help/organizations/team-discussions-pinned.png) @@ -44,5 +45,5 @@ For more information, see {% if currentVersion == "free-pro-team@latest" or curr - "[About conversations on {% data variables.product.prodname_dotcom %}](/articles/about-conversations-on-github)" - "[About teams](/articles/about-teams)" -- "[Creating a team discussion](/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion)" -- "[Editing or deleting a team discussion](/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion)" +- "[Creating a team discussion](/organizations/collaborating-with-your-team/creating-a-team-discussion)" +- "[Editing or deleting a team discussion](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion.md b/content/organizations/collaborating-with-your-team/creating-a-team-discussion.md similarity index 69% rename from content/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion.md rename to content/organizations/collaborating-with-your-team/creating-a-team-discussion.md index 968a93eef7..db647d762e 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion.md +++ b/content/organizations/collaborating-with-your-team/creating-a-team-discussion.md @@ -4,6 +4,7 @@ intro: 'Any organization member can create a _public_ team discussion post. To c redirect_from: - /articles/creating-a-team-discussion - /github/building-a-strong-community/creating-a-team-discussion + - /github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion versions: free-pro-team: '*' enterprise-server: '*' @@ -12,7 +13,7 @@ topics: - community --- -{% data reusables.organizations.team-discussions-permissions %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." +{% data reusables.organizations.team-discussions-permissions %} For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} @@ -27,6 +28,6 @@ topics: ### Further reading - - "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" - - "[Editing or deleting a team discussion](/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion)" - - "[Pinning a team discussion](/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion)" + - "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)" + - "[Editing or deleting a team discussion](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion)" + - "[Pinning a team discussion](/organizations/collaborating-with-your-team/pinning-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion.md b/content/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion.md similarity index 72% rename from content/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion.md rename to content/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion.md index 7397639d74..164e1f2abb 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion.md +++ b/content/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion.md @@ -4,6 +4,7 @@ intro: 'Organization members can edit or delete discussions on a team''s page. I redirect_from: - /articles/editing-or-deleting-a-team-discussion - /github/building-a-strong-community/editing-or-deleting-a-team-discussion + - /github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion versions: free-pro-team: '*' enterprise-server: '*' @@ -24,6 +25,6 @@ topics: ### Further reading - - "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" - - "[Creating a team discussion](/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion)" - - "[Pinning a team discussion](/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion)" + - "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)" + - "[Creating a team discussion](/organizations/collaborating-with-your-team/creating-a-team-discussion)" + - "[Pinning a team discussion](/organizations/collaborating-with-your-team/pinning-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team.md b/content/organizations/collaborating-with-your-team/index.md similarity index 56% rename from content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team.md rename to content/organizations/collaborating-with-your-team/index.md index cb4c12309f..a2dcb31f02 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team.md +++ b/content/organizations/collaborating-with-your-team/index.md @@ -1,10 +1,10 @@ --- title: Collaborating with your team intro: 'Within an organization, your team can work together across projects using team discussions.' -mapTopic: true redirect_from: - /articles/collaborating-with-your-team - /github/building-a-strong-community/collaborating-with-your-team + - /github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team versions: free-pro-team: '*' enterprise-server: '*' @@ -13,3 +13,7 @@ topics: - community --- +{% link_in_list /about-team-discussions %} +{% link_in_list /creating-a-team-discussion %} +{% link_in_list /editing-or-deleting-a-team-discussion %} +{% link_in_list /pinning-a-team-discussion %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion.md b/content/organizations/collaborating-with-your-team/pinning-a-team-discussion.md similarity index 66% rename from content/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion.md rename to content/organizations/collaborating-with-your-team/pinning-a-team-discussion.md index 42459e82a6..e2d8c368ae 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion.md +++ b/content/organizations/collaborating-with-your-team/pinning-a-team-discussion.md @@ -4,6 +4,7 @@ intro: 'You can pin important discussions to your organization''s team pages for redirect_from: - /articles/pinning-a-team-discussion - /github/building-a-strong-community/pinning-a-team-discussion + - /github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion versions: free-pro-team: '*' enterprise-server: '*' @@ -21,6 +22,6 @@ topics: ### Further reading - - "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" - - "[Creating a team discussion](/github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion)" - - "[Editing or deleting a team discussion](/github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion)" + - "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)" + - "[Creating a team discussion](/organizations/collaborating-with-your-team/creating-a-team-discussion)" + - "[Editing or deleting a team discussion](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on.md b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on.md rename to content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md index d061e78d3a..b2449806a3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on.md +++ b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/about-two-factor-authentication-and-saml-single-sign-on.md @@ -4,6 +4,7 @@ intro: Organizations administrators can enable both SAML single sign-on and two- product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/about-two-factor-authentication-and-saml-single-sign-on + - /github/setting-up-and-managing-organizations-and-teams/about-two-factor-authentication-and-saml-single-sign-on versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on.md b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/index.md similarity index 53% rename from content/github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on.md rename to content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/index.md index 80c5ff6848..9406a2c559 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on.md +++ b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/index.md @@ -1,9 +1,9 @@ --- title: Granting access to your organization with SAML single sign-on intro: 'Organization administrators can grant access to their organization with SAML single sign-on. This access can be granted to organization members, bots, and service accounts.' -mapTopic: true redirect_from: - /articles/granting-access-to-your-organization-with-saml-single-sign-on + - /github/setting-up-and-managing-organizations-and-teams/granting-access-to-your-organization-with-saml-single-sign-on versions: free-pro-team: '*' topics: @@ -11,3 +11,6 @@ topics: - teams --- +{% link_in_list /managing-bots-and-service-accounts-with-saml-single-sign-on %} +{% link_in_list /viewing-and-managing-a-members-saml-access-to-your-organization %} +{% link_in_list /about-two-factor-authentication-and-saml-single-sign-on %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on.md b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on.md rename to content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md index f16c843a4e..a55b5ad411 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on.md +++ b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md @@ -4,6 +4,7 @@ intro: Organizations that have enabled SAML single sign-on can retain access for product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/managing-bots-and-service-accounts-with-saml-single-sign-on + - /github/setting-up-and-managing-organizations-and-teams/managing-bots-and-service-accounts-with-saml-single-sign-on versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md rename to content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md index 484baa617a..d1e9d2dd81 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md +++ b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md @@ -6,6 +6,7 @@ product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/viewing-and-revoking-organization-members-authorized-access-tokens - /github/setting-up-and-managing-organizations-and-teams/viewing-and-revoking-organization-members-authorized-access-tokens + - /github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization versions: free-pro-team: '*' topics: diff --git a/content/organizations/index.md b/content/organizations/index.md new file mode 100644 index 0000000000..0cfd817912 --- /dev/null +++ b/content/organizations/index.md @@ -0,0 +1,32 @@ +--- +title: Organizations and teams +shortTitle: Organizations +intro: Collaborate across many projects while managing access to projects and data and customizing settings for your organization. +redirect_from: + - /articles/about-improved-organization-permissions/ + - /categories/setting-up-and-managing-organizations-and-teams + - /github/setting-up-and-managing-organizations-and-teams +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +{% link_with_intro /collaborating-with-groups-in-organizations %} +{% link_with_intro /managing-membership-in-your-organization %} +{% link_with_intro /managing-peoples-access-to-your-organization-with-roles %} +{% link_with_intro /organizing-members-into-teams %} +{% link_with_intro /collaborating-with-your-team %} +{% link_with_intro /managing-access-to-your-organizations-repositories %} +{% link_with_intro /managing-access-to-your-organizations-project-boards %} +{% link_with_intro /managing-access-to-your-organizations-apps %} +{% link_with_intro /managing-organization-settings %} +{% link_with_intro /restricting-access-to-your-organizations-data %} +{% link_with_intro /keeping-your-organization-secure %} +{% link_with_intro /managing-saml-single-sign-on-for-your-organization %} +{% link_with_intro /granting-access-to-your-organization-with-saml-single-sign-on %} +{% link_with_intro /managing-git-access-to-your-organizations-repositories %} +{% link_with_intro /migrating-to-improved-organization-permissions %} diff --git a/content/organizations/keeping-your-organization-secure/index.md b/content/organizations/keeping-your-organization-secure/index.md new file mode 100644 index 0000000000..f3cdc109bd --- /dev/null +++ b/content/organizations/keeping-your-organization-secure/index.md @@ -0,0 +1,24 @@ +--- +title: Keeping your organization secure +intro: 'Organization owners have several features to help them keep their projects and data secure. If you''re the owner of an organization, you should regularly review your organization''s audit log{% if currentVersion != "github-ae@latest" %}, member 2FA status,{% endif %} and application settings to ensure that no unauthorized or malicious activity has occurred.' +redirect_from: + - /articles/preventing-unauthorized-access-to-organization-information/ + - /articles/keeping-your-organization-secure + - /github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +{% link_in_list /viewing-whether-users-in-your-organization-have-2fa-enabled %} +{% link_in_list /preparing-to-require-two-factor-authentication-in-your-organization %} +{% link_in_list /requiring-two-factor-authentication-in-your-organization %} +{% link_in_list /managing-security-and-analysis-settings-for-your-organization %} +{% link_in_list /managing-allowed-ip-addresses-for-your-organization %} +{% link_in_list /restricting-email-notifications-to-an-approved-domain %} +{% link_in_list /reviewing-the-audit-log-for-your-organization %} +{% link_in_list /reviewing-your-organizations-installed-integrations %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md rename to content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md index 7b77503d4f..07f45a891f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization.md @@ -2,6 +2,8 @@ title: Managing allowed IP addresses for your organization intro: You can restrict access to your organization's assets by configuring a list of IP addresses that are allowed to connect. product: '{% data reusables.gated-features.allowed-ip-addresses %}' +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization versions: free-pro-team: '*' github-ae: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md similarity index 99% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md rename to content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md index 2bb4b4ebc4..76c750732d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'You can control features that secure and analyze the code in your organi permissions: Organization owners can manage security and analysis settings for repositories in the organization. redirect_from: - /github/setting-up-and-managing-organizations-and-teams/managing-secret-scanning-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization versions: free-pro-team: '*' enterprise-server: '>=3.0' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization.md b/content/organizations/keeping-your-organization-secure/preparing-to-require-two-factor-authentication-in-your-organization.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization.md rename to content/organizations/keeping-your-organization-secure/preparing-to-require-two-factor-authentication-in-your-organization.md index 8c14803057..6f803db18c 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/preparing-to-require-two-factor-authentication-in-your-organization.md @@ -3,6 +3,7 @@ title: Preparing to require two-factor authentication in your organization intro: 'Before requiring two-factor authentication (2FA), you can notify users about the upcoming change and verify who already uses 2FA.' redirect_from: - /articles/preparing-to-require-two-factor-authentication-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/preparing-to-require-two-factor-authentication-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md b/content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md rename to content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md index cb8e427fcf..282a76b677 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization.md @@ -3,6 +3,7 @@ title: Requiring two-factor authentication in your organization intro: 'Organization owners can require {% if currentVersion == "free-pro-team@latest" %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} to enable two-factor authentication for their personal accounts, making it harder for malicious actors to access an organization''s repositories and settings.' redirect_from: - /articles/requiring-two-factor-authentication-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -37,7 +38,7 @@ You can also require two-factor authentication for organizations in an enterpris Before you can require {% if currentVersion == "free-pro-team@latest" %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} to use two-factor authentication, you must enable two-factor authentication for your account on {% data variables.product.product_name %}. For more information, see "[Securing your account with two-factor authentication (2FA)](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)." -Before you require use of two-factor authentication, we recommend notifying {% if currentVersion == "free-pro-team@latest" %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} and asking them to set up 2FA for their accounts. You can see if members and outside collaborators already use 2FA. For more information, see "[Viewing whether users in your organization have 2FA enabled](/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled)." +Before you require use of two-factor authentication, we recommend notifying {% if currentVersion == "free-pro-team@latest" %}organization members, outside collaborators, and billing managers{% else %}organization members and outside collaborators{% endif %} and asking them to set up 2FA for their accounts. You can see if members and outside collaborators already use 2FA. For more information, see "[Viewing whether users in your organization have 2FA enabled](/organizations/keeping-your-organization-secure/viewing-whether-users-in-your-organization-have-2fa-enabled)." ### Requiring two-factor authentication in your organization diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain.md b/content/organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain.md similarity index 88% rename from content/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain.md rename to content/organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain.md index 75f20036b2..d4e2d5c231 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain.md +++ b/content/organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.restrict-email-domain %}' redirect_from: - /articles/restricting-email-notifications-about-organization-activity-to-an-approved-email-domain/ - /articles/restricting-email-notifications-to-an-approved-domain + - /github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain versions: free-pro-team: '*' topics: @@ -16,7 +17,7 @@ topics: When restricted email notifications are enabled in an organization, members can only use an email address associated with the organization's verified domains to receive email notifications about organization activity. For more information, see "[Verifying your organization's domain](/articles/verifying-your-organization-s-domain)." -Outside collaborators are not subject to restrictions on email notifications for verified domains. For more information on outside collaborators, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization#outside-collaborators)." +Outside collaborators are not subject to restrictions on email notifications for verified domains. For more information on outside collaborators, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization#outside-collaborators)." If your organization is owned by an enterprise account, organization members will be able to receive notifications from any domains verified for the enterprise account, in addition to any domains verified for the organization. For more information, see "[Verifying your enterprise account's domain](/github/setting-up-and-managing-your-enterprise/verifying-your-enterprise-accounts-domain)." diff --git a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md new file mode 100644 index 0000000000..a34f22b84f --- /dev/null +++ b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -0,0 +1,677 @@ +--- +title: Reviewing the audit log for your organization +intro: 'The audit log allows organization admins to quickly review the actions performed by members of your organization. It includes details such as who performed the action, what the action was, and when it was performed.' +miniTocMaxHeadingLevel: 4 +redirect_from: + - /articles/reviewing-the-audit-log-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +### Accessing the audit log + +The audit log lists events triggered by activities that affect your organization within the last 90 days. Only owners can access an organization's audit log. + +{% data reusables.profile.access_profile %} +{% data reusables.profile.access_org %} +{% data reusables.organizations.org_settings %} +{% data reusables.audit_log.audit_log_sidebar_for_org_admins %} + +### Searching the audit log + +{% data reusables.audit_log.audit-log-search %} + +#### Search based on the action performed + +To search for specific events, use the `action` qualifier in your query. Actions listed in the audit log are grouped within the following categories: + +| Category name | Description +|------------------|-------------------{% if currentVersion == "free-pro-team@latest" %} +| [`account`](#account-category-actions) | Contains all activities related to your organization account. +| [`advisory_credit`](#advisory_credit-category-actions) | Contains all activities related to crediting a contributor for a security advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing. +| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in new repositories created in the organization. +| [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." +| [`dependabot_security_updates_new_repos`](#dependabot_security_updates_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization. +| [`dependency_graph`](#dependency_graph-category-actions) | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +| [`dependency_graph_new_repos`](#dependency_graph_new_repos-category-actions) | Contains organization-level configuration activities for new repositories created in the organization.{% endif %} +| [`discussion_post`](#discussion_post-category-actions) | Contains all activities related to discussions posted to a team page. +| [`discussion_post_reply`](#discussion_post_reply-category-actions) | Contains all activities related to replies to discussions posted to a team page. +| [`hook`](#hook-category-actions) | Contains all activities related to webhooks. +| [`integration_installation_request`](#integration_installation_request-category-actions) | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. | +| [`issue`](#issue-category-actions) | Contains activities related to deleting an issue. {% if currentVersion == "free-pro-team@latest" %} +| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. +| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +| [`members_can_create_pages`](#members_can_create_pages-category-actions) | Contains all activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." | {% endif %} +| [`org`](#org-category-actions) | Contains activities related to organization membership.{% if currentVersion == "free-pro-team@latest" %} +| [`org_credential_authorization`](#org_credential_authorization-category-actions) | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} +| [`organization_label`](#organization_label-category-actions) | Contains all activities related to default labels for repositories in your organization.{% endif %} +| [`oauth_application`](#oauth_application-category-actions) | Contains all activities related to OAuth Apps.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +| [`packages`](#packages-category-actions) | Contains all activities related to {% data variables.product.prodname_registry %}.{% endif %}{% if currentVersion == "free-pro-team@latest" %} +| [`payment_method`](#payment_method-category-actions) | Contains all activities related to how your organization pays for GitHub.{% endif %} +| [`profile_picture`](#profile_picture-category-actions) | Contains all activities related to your organization's profile picture. +| [`project`](#project-category-actions) | Contains all activities related to project boards. +| [`protected_branch`](#protected_branch-category-actions) | Contains all activities related to protected branches. +| [`repo`](#repo-category-actions) | Contains activities related to the repositories owned by your organization.{% if currentVersion == "free-pro-team@latest" %} +| [`repository_advisory`](#repository_advisory-category-actions) | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| [`repository_content_analysis`](#repository_content_analysis-category-actions) | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).{% endif %}{% if currentVersion != "github-ae@latest" %} +| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +| [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %}{% if currentVersion != "github-ae@latest" %} +| [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% if currentVersion == "free-pro-team@latest" %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +| [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% endif %}{% if currentVersion == "free-pro-team@latest" %} +| [`sponsors`](#sponsors-category-actions) | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %} +| [`team`](#team-category-actions) | Contains all activities related to teams in your organization. +| [`team_discussions`](#team_discussions-category-actions) | Contains activities related to managing team discussions for an organization. + +You can search for specific sets of actions using these terms. For example: + + * `action:team` finds all events grouped within the team category. + * `-action:hook` excludes all events in the webhook category. + +Each category has a set of associated actions that you can filter on. For example: + + * `action:team.create` finds all events where a team was created. + * `-action:hook.events_changed` excludes all events where the events on a webhook have been altered. + +#### Search based on time of action + +Use the `created` qualifier to filter events in the audit log based on when they occurred. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} + +{% data reusables.search.date_gt_lt %} + +For example: + + * `created:2014-07-08` finds all events that occurred on July 8th, 2014. + * `created:>=2014-07-08` finds all events that occurred on or after July 8th, 2014. + * `created:<=2014-07-08` finds all events that occurred on or before July 8th, 2014. + * `created:2014-07-01..2014-07-31` finds all events that occurred in the month of July 2014. + +The audit log contains data for the past 90 days, but you can use the `created` qualifier to search for events earlier than that. + +#### Search based on location + +Using the qualifier `country`, you can filter events in the audit log based on the originating country. You can use a country's two-letter short code or its full name. Keep in mind that countries with spaces in their name will need to be wrapped in quotation marks. For example: + + * `country:de` finds all events that occurred in Germany. + * `country:Mexico` finds all events that occurred in Mexico. + * `country:"United States"` all finds events that occurred in the United States. + +{% if currentVersion == "free-pro-team@latest" %} +### Exporting the audit log + +{% data reusables.audit_log.export-log %} +{% data reusables.audit_log.exported-log-keys-and-values %} +{% endif %} + +### Using the audit log API + +You can interact with the audit log using the GraphQL API{% if currentVersion == "free-pro-team@latest" %} or the REST API{% endif %}. + +{% if currentVersion == "free-pro-team@latest" %} + +#### Using the GraphQL API + +{% endif %} + +{% note %} + +**Note**: The audit log GraphQL API is available for organizations using {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info-org-products %} + +{% endnote %} + +To ensure a secure IP and maintain compliance for your organization, you can use the audit log GraphQL API to keep copies of your audit log data and monitor: +{% data reusables.audit_log.audit-log-api-info %} + +{% if currentVersion == "free-pro-team@latest" %} +Note that you can't retrieve Git events using the GraphQL API. To retrieve Git events, use the REST API instead. For more information, see "[`git` category actions](#git-category-actions)." +{% endif %} + +The GraphQL response can include data for up to 90 to 120 days. + +For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/graphql/reference/interfaces#auditentry/)." + +{% if currentVersion == "free-pro-team@latest" %} + +#### Using the REST API + +{% note %} + +**Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. + +{% endnote %} + +To ensure a secure IP and maintain compliance for your organization, you can use the audit log REST API to keep copies of your audit log data and monitor: +{% data reusables.audit_log.audit-log-api-info %} +* Git events, such as cloning, fetching, and pushing + +{% data reusables.audit_log.audit-log-git-events-retention %} + +For more information about the audit log REST API, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)." + +{% endif %} + +### Audit log actions + +An overview of some of the most common actions that are recorded as events in the audit log. + +{% if currentVersion == "free-pro-team@latest" %} + +#### `account` category actions + +| Action | Description +|------------------|------------------- +| `billing_plan_change` | Triggered when an organization's [billing cycle](/articles/changing-the-duration-of-your-billing-cycle) changes. +| `plan_change` | Triggered when an organization's [subscription](/articles/about-billing-for-github-accounts) changes. +| `pending_plan_change` | Triggered when an organization owner or billing manager [cancels or downgrades a paid subscription](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process/). +| `pending_subscription_change` | Triggered when a [{% data variables.product.prodname_marketplace %} free trial starts or expires](/articles/about-billing-for-github-marketplace/). + +#### `advisory_credit` category actions + +| Action | Description +|------------------|------------------- +| `accept` | Triggered when someone accepts credit for a security advisory. For more information, see "[Editing a security advisory](/github/managing-security-vulnerabilities/editing-a-security-advisory)." +| `create` | Triggered when the administrator of a security advisory adds someone to the credit section. +| `decline` | Triggered when someone declines credit for a security advisory. +| `destroy` | Triggered when the administrator of a security advisory removes someone from the credit section. + +#### `billing` category actions + +| Action | Description +|------------------|------------------- +| `change_billing_type` | Triggered when your organization [changes how it pays for {% data variables.product.prodname_dotcom %}](/articles/adding-or-editing-a-payment-method). +| `change_email` | Triggered when your organization's [billing email address](/articles/setting-your-billing-email) changes. + +#### `dependabot_alerts` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_alerts %} for all existing {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_alerts %} for all existing {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. + +#### `dependabot_alerts_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_alerts %} for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_alerts %} for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. + +#### `dependabot_security_updates` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_security_updates %} for all existing repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_security_updates %} for all existing repositories. + +#### `dependabot_security_updates_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_security_updates %} for all new repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_security_updates %} for all new repositories. + +#### `dependency_graph` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables the dependency graph for all existing repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables the dependency graph for all existing repositories. + +#### `dependency_graph_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables the dependency graph for all new repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +| `enable` | Triggered when an organization owner enables the dependency graph for all new repositories. + +{% endif %} + +#### `discussion_post` category actions + +| Action | Description +|------------------|------------------- +| `update` | Triggered when [a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment). +| `destroy` | Triggered when [a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment). + +#### `discussion_post_reply` category actions + +| Action | Description +|------------------|------------------- +| `update` | Triggered when [a reply to a team discussion post is edited](/articles/managing-disruptive-comments/#editing-a-comment). +| `destroy` | Triggered when [a reply to a team discussion post is deleted](/articles/managing-disruptive-comments/#deleting-a-comment). + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +#### `enterprise` category actions + +{% data reusables.actions.actions-audit-events-for-enterprise %} + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +#### `environment` category actions + +| Action | Description +|------------------|------------------- +| `create_actions_secret` | Triggered when a secret is created in an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `delete` | Triggered when an environment is deleted. For more information, see ["Deleting an environment](/actions/reference/environments#deleting-an-environment)." +| `remove_actions_secret` | Triggered when a secret is removed from an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `update_actions_secret` | Triggered when a secret in an environment is updated. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +#### `git` category actions + +{% note %} + +**Note:** To access Git events in the audit log, you must use the audit log REST API. The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. For more information, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)." + +{% endnote %} + +{% data reusables.audit_log.audit-log-git-events-retention %} + +| Action | Description +|---------|---------------------------- +| `clone` | Triggered when a repository is cloned. +| `fetch` | Triggered when changes are fetched from a repository. +| `push` | Triggered when changes are pushed to a repository. + +{% endif %} + +#### `hook` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when [a new hook was added](/articles/creating-webhooks) to a repository owned by your organization. +| `config_changed` | Triggered when an existing hook has its configuration altered. +| `destroy` | Triggered when an existing hook was removed from a repository. +| `events_changed` | Triggered when the events on a hook have been altered. + +#### `integration_installation_request` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when an organization member requests that an organization owner install an integration for use in the organization. +| `close` | Triggered when a request to install an integration for use in an organization is either approved or denied by an organization owner, or canceled by the organization member who opened the request. + +#### `issue` category actions + +| Action | Description +|------------------|------------------- +| `destroy` | Triggered when an organization owner or someone with admin permissions in a repository deletes an issue from an organization-owned repository. + +{% if currentVersion == "free-pro-team@latest" %} + +#### `marketplace_agreement_signature` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement. + +#### `marketplace_listing` category actions + +| Action | Description +|------------------|------------------- +| `approve` | Triggered when your listing is approved for inclusion in {% data variables.product.prodname_marketplace %}. +| `create` | Triggered when you create a listing for your app in {% data variables.product.prodname_marketplace %}. +| `delist` | Triggered when your listing is removed from {% data variables.product.prodname_marketplace %}. +| `redraft` | Triggered when your listing is sent back to draft state. +| `reject` | Triggered when your listing is not accepted for inclusion in {% data variables.product.prodname_marketplace %}. + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + +#### `members_can_create_pages` category actions + +For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." + +| Action | Description | +| :- | :- | +| `enable` | Triggered when an organization owner enables publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. | +| `disable` | Triggered when an organization owner disables publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. | + +{% endif %} + +#### `org` category actions + +| Action | Description +|------------------|-------------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %} +| `advanced_security_policy_selected_member_disabled` | Triggered when an enterprise owner prevents {% data variables.product.prodname_GH_advanced_security %} features from being enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %} +| `advanced_security_policy_selected_member_enabled` | Triggered when an enterprise owner allows {% data variables.product.prodname_GH_advanced_security %} features to be enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %}{% endif %}{% if currentVersion == "free-pro-team@latest" %} +| `audit_log_export` | Triggered when an organization admin [creates an export of the organization audit log](#exporting-the-audit-log). If the export included a query, the log will list the query used and the number of audit log entries matching that query. +| `block_user` | Triggered when an organization owner [blocks a user from accessing the organization's repositories](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization). +| `cancel_invitation` | Triggered when an organization invitation has been revoked. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `create_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is created for an organization. For more information, see "[Creating encrypted secrets for an organization](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization)."{% endif %} {% if currentVersion == "free-pro-team@latest"%} +| `disable_oauth_app_restrictions` | Triggered when an owner [disables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/disabling-oauth-app-access-restrictions-for-your-organization) for your organization. +| `disable_saml` | Triggered when an organization admin disables SAML single sign-on for an organization.{% endif %} +| `disable_member_team_creation_permission` | Triggered when an organization owner limits team creation to owners. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |{% if currentVersion != "github-ae@latest" %} +| `disable_two_factor_requirement` | Triggered when an owner disables a two-factor authentication requirement for all members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators in an organization.{% endif %}{% if currentVersion == "free-pro-team@latest" %} +| `enable_oauth_app_restrictions` | Triggered when an owner [enables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/enabling-oauth-app-access-restrictions-for-your-organization) for your organization. +| `enable_saml` | Triggered when an organization admin [enables SAML single sign-on](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization) for an organization.{% endif %} +| `enable_member_team_creation_permission` | Triggered when an organization owner allows members to create teams. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |{% if currentVersion != "github-ae@latest" %} +| `enable_two_factor_requirement` | Triggered when an owner requires two-factor authentication for all members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators in an organization.{% endif %} +| `invite_member` | Triggered when [a new user was invited to join your organization](/articles/adding-organization-members-to-a-team).{% if currentVersion == "free-pro-team@latest" %} +| `oauth_app_access_approved` | Triggered when an owner [grants organization access to an {% data variables.product.prodname_oauth_app %}](/articles/approving-oauth-apps-for-your-organization/). +| `oauth_app_access_denied` | Triggered when an owner [disables a previously approved {% data variables.product.prodname_oauth_app %}'s access](/articles/denying-access-to-a-previously-approved-oauth-app-for-your-organization) to your organization. +| `oauth_app_access_requested` | Triggered when an organization member requests that an owner grant an {% data variables.product.prodname_oauth_app %} access to your organization.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an organization](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)." +| `remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed.{% endif %}{% if currentVersion == "free-pro-team@latest"%} +| `remove_billing_manager` | Triggered when an [owner removes a billing manager from an organization](/articles/removing-a-billing-manager-from-your-organization/) or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and a billing manager doesn't use 2FA or disables 2FA. |{% endif %} +| `remove_member` | Triggered when an [owner removes a member from an organization](/articles/removing-a-member-from-your-organization/){% if currentVersion != "github-ae@latest" %} or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an organization member doesn't use 2FA or disables 2FA{% endif %}. Also triggered when an [organization member removes themselves](/articles/removing-yourself-from-an-organization/) from an organization.| +| `remove_outside_collaborator` | Triggered when an owner removes an outside collaborator from an organization{% if currentVersion != "github-ae@latest" %} or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an outside collaborator does not use 2FA or disables 2FA{% endif %}. |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from an organization](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization)." {% endif %}{% if currentVersion == "free-pro-team@latest" %} +| `revoke_external_identity` | Triggered when an organization owner revokes a member's linked identity. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." +| `revoke_sso_session` | Triggered when an organization owner revokes a member's SAML session. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)." +| `runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." +| `runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." +| `runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see [Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). +| `runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)." +| `runner_group_runners_updated`| Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)."{% endif %}{% if currentVersion == "free-pro-team@latest"%}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %} +| `unblock_user` | Triggered when an organization owner [unblocks a user from an organization](/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization).{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `update_actions_secret` |Triggered when a {% data variables.product.prodname_actions %} secret is updated.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +| `update_new_repository_default_branch_setting` | Triggered when an owner changes the name of the default branch for new repositories in the organization. For more information, see "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)."{% endif %} +| `update_default_repository_permission` | Triggered when an owner changes the default repository permission level for organization members. +| `update_member` | Triggered when an owner changes a person's role from owner to member or member to owner. +| `update_member_repository_creation_permission` | Triggered when an owner changes the create repository permission for organization members.{% if currentVersion == "free-pro-team@latest" %} +| `update_saml_provider_settings` | Triggered when an organization's SAML provider settings are updated. +| `update_terms_of_service` | Triggered when an organization changes between the Standard Terms of Service and the Corporate Terms of Service. For more information, see "[Upgrading to the Corporate Terms of Service](/articles/upgrading-to-the-corporate-terms-of-service)."{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +#### `org_credential_authorization` category actions + +| Action | Description +|------------------|------------------- +| `grant` | Triggered when a member [authorizes credentials for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on). +| `deauthorized` | Triggered when a member [deauthorizes credentials for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on). +| `revoke` | Triggered when an owner [revokes authorized credentials](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization). + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} +#### `organization_label` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a default label is created. +| `update` | Triggered when a default label is edited. +| `destroy` | Triggered when a default label is deleted. + +{% endif %} + +#### `oauth_application` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a new {% data variables.product.prodname_oauth_app %} is created. +| `destroy` | Triggered when an existing {% data variables.product.prodname_oauth_app %} is deleted. +| `reset_secret` | Triggered when an {% data variables.product.prodname_oauth_app %}'s client secret is reset. +| `revoke_tokens` | Triggered when an {% data variables.product.prodname_oauth_app %}'s user tokens are revoked. +| `transfer` | Triggered when an existing {% data variables.product.prodname_oauth_app %} is transferred to a new organization. + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +#### `packages` category actions + +| Action | Description | +|--------|-------------| +| `package_version_published` | Triggered when a package version is published. | +| `package_version_deleted` | Triggered when a specific package version is deleted. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." +| `package_deleted` | Triggered when an entire package is deleted. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." +| `package_version_restored` | Triggered when a specific package version is deleted. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." +| `package_restored` | Triggered when an entire package is restored. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} + +#### `payment_method` category actions + +| Action | Description +|------------------|------------------- +| `clear` | Triggered when a payment method on file is [removed](/articles/removing-a-payment-method). +| `create` | Triggered when a new payment method is added, such as a new credit card or PayPal account. +| `update` | Triggered when an existing payment method is updated. + +{% endif %} + +#### `profile_picture` category actions +| Action | Description +|------------------|------------------- +| update | Triggered when you set or update your organization's profile picture. + +#### `project` category actions + +| Action | Description +|--------------------|--------------------- +| `create` | Triggered when a project board is created. +| `link` | Triggered when a repository is linked to a project board. +| `rename` | Triggered when a project board is renamed. +| `update` | Triggered when a project board is updated. +| `delete` | Triggered when a project board is deleted. +| `unlink` | Triggered when a repository is unlinked from a project board. +| `update_org_permission` | Triggered when the base-level permission for all organization members is changed or removed. | +| `update_team_permission` | Triggered when a team's project board permission level is changed or when a team is added or removed from a project board. | +| `update_user_permission` | Triggered when an organization member or outside collaborator is added to or removed from a project board or has their permission level changed.| + +#### `protected_branch` category actions + +| Action | Description +|--------------------|--------------------- +| `create ` | Triggered when branch protection is enabled on a branch. +| `destroy` | Triggered when branch protection is disabled on a branch. +| `update_admin_enforced ` | Triggered when branch protection is enforced for repository administrators. +| `update_require_code_owner_review ` | Triggered when enforcement of required Code Owner review is updated on a branch. +| `dismiss_stale_reviews ` | Triggered when enforcement of dismissing stale pull requests is updated on a branch. +| `update_signature_requirement_enforcement_level ` | Triggered when enforcement of required commit signing is updated on a branch. +| `update_pull_request_reviews_enforcement_level ` | Triggered when enforcement of required pull request reviews is updated on a branch. +| `update_required_status_checks_enforcement_level ` | Triggered when enforcement of required status checks is updated on a branch. +| `update_strict_required_status_checks_policy` | Triggered when the requirement for a branch to be up to date before merging is changed. +| `rejected_ref_update ` | Triggered when a branch update attempt is rejected. +| `policy_override ` | Triggered when a branch protection requirement is overridden by a repository administrator.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} +| `update_allow_force_pushes_enforcement_level ` | Triggered when force pushes are enabled or disabled for a protected branch. +| `update_allow_deletions_enforcement_level ` | Triggered when branch deletion is enabled or disabled for a protected branch. +| `update_linear_history_requirement_enforcement_level ` | Triggered when required linear commit history is enabled or disabled for a protected branch. +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +#### `pull_request` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a pull request is created. +| `close` | Triggered when a pull request is closed without being merged. +| `reopen` | Triggered when a pull request is reopened after previously being closed. +| `merge` | Triggered when a pull request is merged. +| `indirect_merge` | Triggered when a pull request is considered merged because its commits were merged into the target branch. +| `ready_for_review` | Triggered when a pull request is marked as ready for review. +| `converted_to_draft` | Triggered when a pull request is converted to a draft. +| `create_review_request` | Triggered when a review is requested. +| `remove_review_request` | Triggered when a review request is removed. + +#### `pull_request_review` category actions + +| Action | Description +|------------------|------------------- +| `submit` | Triggered when a review is submitted. +| `dismiss` | Triggered when a review is dismissed. +| `delete` | Triggered when a review is deleted. + +#### `pull_request_review_comment` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when a review comment is added. +| `update` | Triggered when a review comment is changed. +| `delete` | Triggered when a review comment is deleted. +{% endif %} + +#### `repo` category actions + +| Action | Description +|------------------|------------------- +| `access` | Triggered when a user [changes the visibility](/github/administering-a-repository/setting-repository-visibility) of a repository in the organization. +| `actions_enabled` | Triggered when {% data variables.product.prodname_actions %} is enabled for a repository. Can be viewed using the UI. This event is not included when you access the audit log using the REST API. For more information, see "[Using the REST API](#using-the-rest-api)." +| `add_member` | Triggered when a user accepts an [invitation to have collaboration access to a repository](/articles/inviting-collaborators-to-a-personal-repository). +| `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %} +| `advanced_security_disabled` | Triggered when a repository administrator disables {% data variables.product.prodname_GH_advanced_security %} features for the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +| `advanced_security_enabled` | Triggered when a repository administrator enables {% data variables.product.prodname_GH_advanced_security %} features for the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository).".{% endif %} +| `archived` | Triggered when a repository admin [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion %} +| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. +| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access). +| `config.unlock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %} +| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository).{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `create_actions_secret` |Triggered when a {% data variables.product.prodname_actions %} secret is created for a repository. For more information, see "[Creating encrypted secrets for a repository](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)."{% endif %} +| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% if currentVersion == "free-pro-team@latest" %} +| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %} +| `enable` | Triggered when a repository is reenabled.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed.{% endif %} +| `remove_member` | Triggered when a user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository).{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to a repository](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)." +| `remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from a repository](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)." {% endif %} +| `remove_topic` | Triggered when a repository admin removes a topic from a repository. +| `rename` | Triggered when [a repository is renamed](/articles/renaming-a-repository).{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %} +| `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). +| `transfer_start` | Triggered when a repository transfer is about to occur. +| `unarchived` | Triggered when a repository admin unarchives a repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| `update_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is updated.{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} + +#### `repository_advisory` category actions + +| Action | Description +|------------------|------------------- +| `close` | Triggered when someone closes a security advisory. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." +| `cve_request` | Triggered when someone requests a CVE (Common Vulnerabilities and Exposures) number from {% data variables.product.prodname_dotcom %} for a draft security advisory. +| `github_broadcast` | Triggered when {% data variables.product.prodname_dotcom %} makes a security advisory public in the {% data variables.product.prodname_advisory_database %}. +| `github_withdraw` | Triggered when {% data variables.product.prodname_dotcom %} withdraws a security advisory that was published in error. +| `open` | Triggered when someone opens a draft security advisory. +| `publish` | Triggered when someone publishes a security advisory. +| `reopen` | Triggered when someone reopens as draft security advisory. +| `update` | Triggered when someone edits a draft or published security advisory. + +#### `repository_content_analysis` category actions + +| Action | Description +|------------------|------------------- +| `enable` | Triggered when an organization owner or person with admin access to the repository [enables data use settings for a private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository). +| `disable` | Triggered when an organization owner or person with admin access to the repository [disables data use settings for a private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository). + +{% endif %}{% if currentVersion != "github-ae@latest" %} + +#### `repository_dependency_graph` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when a repository owner or person with admin access to the repository disables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +| `enable` | Triggered when a repository owner or person with admin access to the repository enables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. + +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +#### `repository_secret_scanning` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when a repository owner or person with admin access to the repository disables secret scanning for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when a repository owner or person with admin access to the repository enables secret scanning for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. + +{% endif %}{% if currentVersion != "github-ae@latest" %} +#### `repository_vulnerability_alert` category actions + +| Action | Description +|------------------|------------------- +| `create` | Triggered when {% data variables.product.product_name %} creates a {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert about a vulnerable dependency. +| `resolve` | Triggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency. + +{% endif %}{% if currentVersion == "free-pro-team@latest" %} +#### `repository_vulnerability_alerts` category actions + +| Action | Description +|------------------|------------------- +| `authorized_users_teams` | Triggered when an organization owner or a person with admin permissions to the repository updates the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies in the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." +| `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}. +| `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}. + +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +#### `secret_scanning` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables secret scanning for all existing{% if currentVersion == "free-pro-team@latest" %}, private{% endif %} repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when an organization owner enables secret scanning for all existing{% if currentVersion == "free-pro-team@latest" %}, private{% endif %} repositories. + +#### `secret_scanning_new_repos` category actions + +| Action | Description +|------------------|------------------- +| `disable` | Triggered when an organization owner disables secret scanning for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." +| `enable` | Triggered when an organization owner enables secret scanning for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. + +{% endif %} + +{% if currentVersion == "free-pro-team@latest" %} +#### `sponsors` category actions + +| Action | Description +|------------------|------------------- +| `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") +| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") +| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") +| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled +| `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +{% endif %} + +#### `team` category actions + +| Action | Description +|------------------|------------------- +| `add_member` | Triggered when a member of an organization is [added to a team](/articles/adding-organization-members-to-a-team). +| `add_repository` | Triggered when a team is given control of a repository. +| `change_parent_team` | Triggered when a child team is created or [a child team's parent is changed](/articles/moving-a-team-in-your-organization-s-hierarchy). +| `change_privacy` | Triggered when a team's privacy level is changed. +| `create` | Triggered when a new team is created.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +`demote_maintainer` | Triggered when a user was demoted from a team maintainer to a team member. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)."{% endif %} +| `destroy` | Triggered when a team is deleted from the organization.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +`team.promote_maintainer` | Triggered when a user was promoted from a team member to a team maintainer. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)."{% endif %} +| `remove_member` | Triggered when a member of an organization is [removed from a team](/articles/removing-organization-members-from-a-team). +| `remove_repository` | Triggered when a repository is no longer under a team's control. + +#### `team_discussions` category actions + +| Action | Description +|---|---| +| `disable` | Triggered when an organization owner disables team discussions for an organization. For more information, see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)." +| `enable` | Triggered when an organization owner enables team discussions for an organization. + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest"%} +#### `workflows` category actions + +{% data reusables.actions.actions-audit-events-workflow %} + +{% endif %} + +### Further reading + +- "[Keeping your organization secure](/articles/keeping-your-organization-secure)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md b/content/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md rename to content/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations.md index 9250fa7013..751729a899 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md +++ b/content/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations.md @@ -4,6 +4,7 @@ intro: You can review the permission levels for your organization's installed in redirect_from: - /articles/reviewing-your-organization-s-installed-integrations - /articles/reviewing-your-organizations-installed-integrations + - /github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled.md b/content/organizations/keeping-your-organization-secure/viewing-whether-users-in-your-organization-have-2fa-enabled.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled.md rename to content/organizations/keeping-your-organization-secure/viewing-whether-users-in-your-organization-have-2fa-enabled.md index 3b499d3b26..62c8a59596 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled.md +++ b/content/organizations/keeping-your-organization-secure/viewing-whether-users-in-your-organization-have-2fa-enabled.md @@ -3,6 +3,7 @@ title: Viewing whether users in your organization have 2FA enabled intro: 'You can see which organization owners, members, and outside collaborators have enabled two-factor authentication.' redirect_from: - /articles/viewing-whether-users-in-your-organization-have-2fa-enabled + - /github/setting-up-and-managing-organizations-and-teams/viewing-whether-users-in-your-organization-have-2fa-enabled versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md b/content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md rename to content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md index 3af305e777..6f89ab06d6 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-apps/adding-github-app-managers-in-your-organization.md @@ -3,6 +3,7 @@ title: Adding GitHub App managers in your organization intro: 'Organization owners can grant users the ability to manage some or all {% data variables.product.prodname_github_app %}s owned by the organization.' redirect_from: - /articles/adding-github-app-managers-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md b/content/organizations/managing-access-to-your-organizations-apps/index.md similarity index 65% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md rename to content/organizations/managing-access-to-your-organizations-apps/index.md index 722baa5e9d..07610efc3f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md +++ b/content/organizations/managing-access-to-your-organizations-apps/index.md @@ -4,7 +4,7 @@ intro: 'As an organization owner, you can allow individual organization members redirect_from: - /articles/managing-access-to-your-organization-s-apps - /articles/managing-access-to-your-organizations-apps -mapTopic: true + - /github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps versions: free-pro-team: '*' enterprise-server: '*' @@ -14,3 +14,5 @@ topics: - teams --- +{% link_in_list /adding-github-app-managers-in-your-organization %} +{% link_in_list /removing-github-app-managers-from-your-organization %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md b/content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md rename to content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md index a5f65d7e72..d7b5fa1a25 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-apps/removing-github-app-managers-from-your-organization.md @@ -3,6 +3,7 @@ title: Removing GitHub App managers from your organization intro: 'Organization owners can revoke {% data variables.product.prodname_github_app %} manager permissions that were granted to a member of the organization.' redirect_from: - /articles/removing-github-app-managers-from-your-organization + - /github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md b/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md rename to content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md index 0332b57bcf..74731a14fc 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md @@ -3,6 +3,7 @@ title: Adding an outside collaborator to a project board in your organization intro: 'As an organization owner or project board admin, you can add an outside collaborator and customize their permissions to a project board.' redirect_from: - /articles/adding-an-outside-collaborator-to-a-project-board-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/index.md b/content/organizations/managing-access-to-your-organizations-project-boards/index.md new file mode 100644 index 0000000000..22f18b40c8 --- /dev/null +++ b/content/organizations/managing-access-to-your-organizations-project-boards/index.md @@ -0,0 +1,22 @@ +--- +title: Managing access to your organization’s project boards +intro: 'As an organization owner or project board admin, you can give organization members, teams, and outside collaborators different levels of access to project boards owned by your organization.' +redirect_from: + - /articles/managing-access-to-your-organization-s-project-boards + - /articles/managing-access-to-your-organizations-project-boards + - /github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +{% link_in_list /project-board-permissions-for-an-organization %} +{% link_in_list /managing-access-to-a-project-board-for-organization-members %} +{% link_in_list /managing-team-access-to-an-organization-project-board %} +{% link_in_list /managing-an-individuals-access-to-an-organization-project-board %} +{% link_in_list /adding-an-outside-collaborator-to-a-project-board-in-your-organization %} +{% link_in_list /removing-an-outside-collaborator-from-an-organization-project-board %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md rename to content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md index b15db3e0cc..bc492c6b95 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md @@ -3,6 +3,7 @@ title: Managing access to a project board for organization members intro: 'As an organization owner or project board admin, you can set a default permission level for a project board for all organization members.' redirect_from: - /articles/managing-access-to-a-project-board-for-organization-members + - /github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md rename to content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md index 3141574194..17aa501e92 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md @@ -4,6 +4,7 @@ intro: 'As an organization owner or project board admin, you can manage an indiv redirect_from: - /articles/managing-an-individual-s-access-to-an-organization-project-board - /articles/managing-an-individuals-access-to-an-organization-project-board + - /github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md rename to content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md index c1659ebf20..8a29b69761 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md @@ -3,6 +3,7 @@ title: Managing team access to an organization project board intro: 'As an organization owner or project board admin, you can give a team access to a project board owned by your organization.' redirect_from: - /articles/managing-team-access-to-an-organization-project-board + - /github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board versions: free-pro-team: '*' enterprise-server: '*' @@ -51,5 +52,5 @@ If a team's access to a project board is inherited from a parent team, you must {% data reusables.organizations.specific_team %} 4. Above the team's conversation, click {% octicon "project" aria-label="The Projects icon" %} **Projects**. ![The team repositories tab](/assets/images/help/organizations/team-project-board-button.png) -5. To change permissions levels, to the right of the project board you want to update, use the drop-down. To remove a project board, click **{% octicon "trashcan" aria-label="The trashcan icon" %}**. +5. To change permissions levels, to the right of the project board you want to update, use the drop-down. To remove a project board, click **{% octicon "trash" aria-label="The trash icon" %}**. ![Remove a project board from your team trash button](/assets/images/help/organizations/trash-button.png) diff --git a/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md b/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md rename to content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md index c774786ca2..76290ae69f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md @@ -3,6 +3,7 @@ title: Project board permissions for an organization intro: 'Organization owners and people with project board admin permissions can customize who has read, write, and admin permissions to your organization’s project boards.' redirect_from: - /articles/project-board-permissions-for-an-organization + - /github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md b/content/organizations/managing-access-to-your-organizations-project-boards/removing-an-outside-collaborator-from-an-organization-project-board.md similarity index 87% rename from content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md rename to content/organizations/managing-access-to-your-organizations-project-boards/removing-an-outside-collaborator-from-an-organization-project-board.md index 8dfd92496e..4c2d3ff3cf 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/removing-an-outside-collaborator-from-an-organization-project-board.md @@ -3,6 +3,7 @@ title: Removing an outside collaborator from an organization project board intro: 'As an organization owner or project board admin, you can remove an outside collaborator''s access to a project board.' redirect_from: - /articles/removing-an-outside-collaborator-from-an-organization-project-board + - /github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md rename to content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md index 66a47afe1f..5e2a791f01 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md @@ -3,6 +3,7 @@ title: Adding outside collaborators to repositories in your organization intro: 'An *outside collaborator* is a person who isn''t explicitly a member of your organization, but who has Read, Write, or Admin permissions to one or more repositories in your organization.' redirect_from: - /articles/adding-outside-collaborators-to-repositories-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md rename to content/organizations/managing-access-to-your-organizations-repositories/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md index 221fd32ac7..fd25a1d7ff 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md @@ -2,6 +2,8 @@ title: Canceling an invitation to become an outside collaborator in your organization intro: You can cancel all invitations for a person to become an outside collaborator on repositories owned by your organization. permissions: Organization owners can cancel an invitation to become an outside collaborator in the organization. +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md b/content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md rename to content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md index 0d2f02074d..c026e8b1a2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/converting-an-organization-member-to-an-outside-collaborator.md @@ -3,6 +3,7 @@ title: Converting an organization member to an outside collaborator intro: 'If a current member of your organization only needs access to certain repositories, such as consultants or temporary employees, you can convert them to an *outside collaborator*.' redirect_from: - /articles/converting-an-organization-member-to-an-outside-collaborator + - /github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator versions: free-pro-team: '*' enterprise-server: '*' @@ -23,7 +24,7 @@ After converting an organization member to an outside collaborator, they'll only - @mention any visible team - Be a team maintainer -For more information, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization)." +For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." We recommend reviewing the organization member's access to repositories to ensure their access is as you expect. For more information, see "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md b/content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md rename to content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md index 81ece0d1b2..3c8419917d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member.md @@ -3,6 +3,7 @@ title: Converting an outside collaborator to an organization member intro: 'If you would like to give an outside collaborator on your organization''s repositories broader permissions within your organization, you can {% if currentVersion == "free-pro-team@latest" %}invite them to become a member of{% else %}make them a member of{% endif %} the organization.' redirect_from: - /articles/converting-an-outside-collaborator-to-an-organization-member + - /github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/organizations/managing-access-to-your-organizations-repositories/index.md b/content/organizations/managing-access-to-your-organizations-repositories/index.md new file mode 100644 index 0000000000..b8b30ba6d4 --- /dev/null +++ b/content/organizations/managing-access-to-your-organizations-repositories/index.md @@ -0,0 +1,28 @@ +--- +title: Managing access to your organization's repositories +intro: Organization owners can manage individual and team access to the organization's repositories. Team maintainers can also manage a team's repository access. +redirect_from: + - /articles/permission-levels-for-an-organization-repository/ + - /articles/managing-access-to-your-organization-s-repositories + - /articles/managing-access-to-your-organizations-repositories + - /github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +{% link_in_list /repository-permission-levels-for-an-organization %} +{% link_in_list /setting-base-permissions-for-an-organization %} +{% link_in_list /viewing-people-with-access-to-your-repository %} +{% link_in_list /managing-an-individuals-access-to-an-organization-repository %} +{% link_in_list /managing-team-access-to-an-organization-repository %} +{% link_in_list /adding-outside-collaborators-to-repositories-in-your-organization %} +{% link_in_list /canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization %} +{% link_in_list /removing-an-outside-collaborator-from-an-organization-repository %} +{% link_in_list /converting-an-organization-member-to-an-outside-collaborator %} +{% link_in_list /converting-an-outside-collaborator-to-an-organization-member %} +{% link_in_list /reinstating-a-former-outside-collaborators-access-to-your-organization %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md b/content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md rename to content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md index f7dcde666d..6f0267fc1d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository.md @@ -5,6 +5,7 @@ redirect_from: - /articles/managing-an-individual-s-access-to-an-organization-repository-early-access-program/ - /articles/managing-an-individual-s-access-to-an-organization-repository - /articles/managing-an-individuals-access-to-an-organization-repository + - /github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md b/content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md rename to content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md index dca7e05e67..a5b068c85a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository.md @@ -4,6 +4,7 @@ intro: 'You can give a team access to a repository, remove a team''s access to a redirect_from: - /articles/managing-team-access-to-an-organization-repository-early-access-program/ - /articles/managing-team-access-to-an-organization-repository + - /github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md rename to content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md index 042cca36ba..1b5f9e2ac5 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md @@ -4,6 +4,7 @@ intro: 'You can reinstate a former outside collaborator''s access permissions fo redirect_from: - /articles/reinstating-a-former-outside-collaborator-s-access-to-your-organization - /articles/reinstating-a-former-outside-collaborators-access-to-your-organization + - /github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md b/content/organizations/managing-access-to-your-organizations-repositories/removing-an-outside-collaborator-from-an-organization-repository.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md rename to content/organizations/managing-access-to-your-organizations-repositories/removing-an-outside-collaborator-from-an-organization-repository.md index 434d773e95..67d232afc6 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/removing-an-outside-collaborator-from-an-organization-repository.md @@ -3,6 +3,7 @@ title: Removing an outside collaborator from an organization repository intro: Owners and repository admins can remove an outside collaborator's access to a repository. redirect_from: - /articles/removing-an-outside-collaborator-from-an-organization-repository + - /github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md rename to content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md index a3c245ff74..759b55fe65 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md @@ -5,6 +5,7 @@ miniTocMaxHeadingLevel: 4 redirect_from: - /articles/repository-permission-levels-for-an-organization-early-access-program/ - /articles/repository-permission-levels-for-an-organization + - /github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -33,7 +34,7 @@ From least access to most access, the permission levels for an organization repo For more information about giving people and teams access to repositories, see "[Managing access to your organization's repositories](/articles/managing-access-to-your-organizations-repositories)." -Organization owners can set base permissions that apply to all members of an organization when accessing any of the organization's repositories. For more information, see "[Setting base permissions for an organization](/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization#setting-base-permissions)." +Organization owners can set base permissions that apply to all members of an organization when accessing any of the organization's repositories. For more information, see "[Setting base permissions for an organization](/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization#setting-base-permissions)." Organization owners can also choose to further limit access to certain settings and actions across the organization. For more information on options for specific settings, see "[Managing organization settings](/articles/managing-organization-settings)." @@ -105,7 +106,7 @@ In addition to managing organization-level settings, organization owners have ad | Delete an issue (see "[Deleting an issue](/articles/deleting-an-issue)") | | | | | **X** | | Merge pull requests on protected branches, even if there are no approving reviews | | | | | **X** | | [Define code owners for a repository](/articles/about-code-owners) | | | | | **X** | -| Add a repository to a team (see "[Managing team access to an organization repository](/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository#giving-a-team-access-to-a-repository)" for details) | | | | | **X** | +| Add a repository to a team (see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository#giving-a-team-access-to-a-repository)" for details) | | | | | **X** | | [Manage outside collaborator access to a repository](/articles/adding-outside-collaborators-to-repositories-in-your-organization) | | | | | **X** | | [Change a repository's visibility](/articles/restricting-repository-visibility-changes-in-your-organization) | | | | | **X** | | Make a repository a template (see "[Creating a template repository](/articles/creating-a-template-repository)") | | | | | **X** | @@ -139,12 +140,12 @@ In addition to managing organization-level settings, organization owners have ad In this section, you can find the repository permission levels required for security features, such as {% data variables.product.prodname_advanced_security %} features. | Repository action | Read | Triage | Write | Maintain | Admin | -|:---|:---:|:---:|:---:|:---:|:---:|{% if currentVersion == "free-pro-team@latest" %} -| Receive [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a repository | | | | | **X** | -| [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository) | | | | | **X** | -| [Designate additional people or teams to receive {% data variables.product.prodname_dependabot_alerts %}](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) for vulnerable dependencies | | | | | **X** | -| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} -| Manage access to {% data variables.product.prodname_GH_advanced_security %} features (see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)") | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" %} +|:---|:---:|:---:|:---:|:---:|:---:|{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| Receive [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies) in a repository | | | | | **X** | +| [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository) | | | | | **X** | +| [Designate additional people or teams to receive {% data variables.product.prodname_dependabot_alerts %}](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) for vulnerable dependencies | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" %} +| Create [security advisories](/code-security/security-advisories/about-github-security-advisories) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +| Manage access to {% data variables.product.prodname_GH_advanced_security %} features (see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)") | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" %} | [Enable the dependency graph](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository) for a private repository | | | | | **X** | | [View dependency reviews](/code-security/supply-chain-security/about-dependency-review) | **X** | **X** | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} | [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests) | **X** | **X** | **X** | **X** | **X** | diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md similarity index 77% rename from content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md rename to content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md index 64daf7b01f..2c22db47e3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization.md @@ -2,6 +2,8 @@ title: Setting base permissions for an organization intro: You can set base permissions for the repositories that an organization owns. permissions: Organization owners can set base permissions for an organization. +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -32,5 +34,5 @@ If someone with admin permissions to an organization's repository grants a membe ### Further reading -- "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)" -- "[Adding outside collaborators to repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization)" +- "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)" +- "[Adding outside collaborators to repositories in your organization](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md b/content/organizations/managing-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md rename to content/organizations/managing-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository.md index eda9a879d3..6d7cacd9b6 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository.md @@ -3,6 +3,7 @@ title: Viewing people with access to your repository intro: 'Organization owners can view people’s access to a repository within an organization. Owners of organizations using {% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %} can also export a CSV list of people who have access to a repository.' redirect_from: - /articles/viewing-people-with-access-to-your-repository + - /github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md similarity index 98% rename from content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md rename to content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md index a61f9370d5..7b371b9ae4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md +++ b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md @@ -4,6 +4,7 @@ intro: 'With an SSH certificate authority, your organization or enterprise accou product: '{% data reusables.gated-features.ssh-certificate-authorities %}' redirect_from: - /articles/about-ssh-certificate-authorities + - /github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md b/content/organizations/managing-git-access-to-your-organizations-repositories/index.md similarity index 71% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md rename to content/organizations/managing-git-access-to-your-organizations-repositories/index.md index 0070b8eba7..8bdd4f0224 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md +++ b/content/organizations/managing-git-access-to-your-organizations-repositories/index.md @@ -1,11 +1,11 @@ --- title: Managing Git access to your organization's repositories intro: You can add an SSH certificate authority (CA) to your organization and allow members to access the organization's repositories over Git using keys signed by the SSH CA. -mapTopic: true product: '{% data reusables.gated-features.ssh-certificate-authorities %}' redirect_from: - /articles/managing-git-access-to-your-organizations-repositories-using-ssh-certificate-authorities/ - /articles/managing-git-access-to-your-organizations-repositories + - /github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories versions: free-pro-team: '*' enterprise-server: '*' @@ -15,3 +15,5 @@ topics: - teams --- +{% link_in_list /about-ssh-certificate-authorities %} +{% link_in_list /managing-your-organizations-ssh-certificate-authorities %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md b/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md rename to content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md index 1d363a5cc7..775efdaa45 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md +++ b/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md @@ -4,6 +4,7 @@ intro: You can add or delete SSH certificate authorities from your organization. product: '{% data reusables.gated-features.ssh-certificate-authorities %}' redirect_from: - /articles/managing-your-organizations-ssh-certificate-authorities + - /github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization.md b/content/organizations/managing-membership-in-your-organization/adding-people-to-your-organization.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization.md rename to content/organizations/managing-membership-in-your-organization/adding-people-to-your-organization.md index dad0eb63df..a152a42a7a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/adding-people-to-your-organization.md @@ -3,6 +3,7 @@ title: Adding people to your organization intro: 'You can make anyone a member of your organization using their {% data variables.product.product_name %} username or email address.' redirect_from: - /articles/adding-people-to-your-organization + - /github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization versions: enterprise-server: '*' github-ae: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization.md b/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization.md rename to content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md index 27a51a313a..f13fa6a80f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization.md +++ b/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md @@ -1,9 +1,10 @@ --- title: Can I create accounts for people in my organization? +intro: 'While you can add users to an organization you''ve created, you can''t create personal user accounts on behalf of another person.' redirect_from: - /articles/can-i-create-accounts-for-those-in-my-organization/ - /articles/can-i-create-accounts-for-people-in-my-organization -intro: 'While you can add users to an organization you''ve created, you can''t create personal user accounts on behalf of another person.' + - /github/setting-up-and-managing-organizations-and-teams/can-i-create-accounts-for-people-in-my-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization.md b/content/organizations/managing-membership-in-your-organization/canceling-or-editing-an-invitation-to-join-your-organization.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization.md rename to content/organizations/managing-membership-in-your-organization/canceling-or-editing-an-invitation-to-join-your-organization.md index 2e14f7e102..200cdfdc4b 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/canceling-or-editing-an-invitation-to-join-your-organization.md @@ -3,6 +3,7 @@ title: Canceling or editing an invitation to join your organization intro: Organization owners can edit or cancel an invitation to become a member of your organization any time before the user accepts. redirect_from: - /articles/canceling-or-editing-an-invitation-to-join-your-organization + - /github/setting-up-and-managing-organizations-and-teams/canceling-or-editing-an-invitation-to-join-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md b/content/organizations/managing-membership-in-your-organization/index.md similarity index 52% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md rename to content/organizations/managing-membership-in-your-organization/index.md index 497c8251f9..f28c95e40d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/index.md @@ -4,7 +4,7 @@ intro: 'After you create your organization, you can {% if currentVersion == "fre redirect_from: - /articles/removing-a-user-from-your-organization/ - /articles/managing-membership-in-your-organization -mapTopic: true + - /github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -14,3 +14,10 @@ topics: - teams --- +{% link_in_list /inviting-users-to-join-your-organization %} +{% link_in_list /canceling-or-editing-an-invitation-to-join-your-organization %} + +{% link_in_list /adding-people-to-your-organization %} +{% link_in_list /removing-a-member-from-your-organization %} +{% link_in_list /reinstating-a-former-member-of-your-organization %} +{% link_in_list /can-i-create-accounts-for-people-in-my-organization %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization.md b/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md similarity index 80% rename from content/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization.md rename to content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md index 7f2c029ce4..abef80d8f6 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md @@ -5,6 +5,7 @@ permissions: Organization owners can invite users to join an organization. redirect_from: - /articles/adding-or-inviting-members-to-a-team-in-an-organization/ - /articles/inviting-users-to-join-your-organization + - /github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization versions: free-pro-team: '*' topics: @@ -16,7 +17,7 @@ topics: **Tips**: - If your organization has a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-expiration %} -- If your organization requires members to use two-factor authentication, users that you invite must enable two-factor authentication before accepting the invitation. For more information, see "[Requiring two-factor authentication in your organization](/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization)" and "[Securing your account with two-factor authentication (2FA)](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)." +- If your organization requires members to use two-factor authentication, users that you invite must enable two-factor authentication before accepting the invitation. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)" and "[Securing your account with two-factor authentication (2FA)](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)." {% endtip %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md b/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md rename to content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md index 5df6e4477f..7f78562df3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md @@ -3,6 +3,7 @@ title: Reinstating a former member of your organization intro: 'Organization owners can {% if currentVersion == "free-pro-team@latest" %}invite former organization members to rejoin{% else %}add former members to{% endif%} your organization, and choose whether to restore the person''s former role, access permissions, forks, and settings.' redirect_from: - /articles/reinstating-a-former-member-of-your-organization + - /github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md rename to content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index 27a9d304b2..6bdae0a2f8 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -3,6 +3,7 @@ title: Removing a member from your organization intro: 'If members of your organization no longer require access to any repositories owned by the organization, you can remove them from the organization.' redirect_from: - /articles/removing-a-member-from-your-organization + - /github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md b/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md rename to content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md index 9c994b1884..203fa34c9d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md +++ b/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md @@ -3,6 +3,7 @@ title: Allowing people to delete issues in your organization intro: Organization owners can allow certain people to delete issues in repositories owned by your organization. redirect_from: - /articles/allowing-people-to-delete-issues-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights.md b/content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights.md rename to content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md index 790a56e104..353bd29d2e 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights.md +++ b/content/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights.md @@ -4,6 +4,7 @@ intro: You can allow all organization members to view dependency insights for yo product: '{% data reusables.gated-features.org-insights %}' redirect_from: - /articles/changing-the-visibility-of-your-organizations-dependency-insights + - /github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md b/content/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md similarity index 81% rename from content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md rename to content/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md index 967d47bdf4..a10c0b1708 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md +++ b/content/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md @@ -1,6 +1,8 @@ --- title: Configuring the retention period for GitHub Actions artifacts and logs in your organization intro: 'You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your organization.' +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization versions: free-pro-team: '*' enterprise-server: '>=2.23' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user.md b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user.md rename to content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md index f12e2987df..134897705c 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user.md +++ b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md @@ -3,6 +3,7 @@ title: Converting an organization into a user intro: 'It''s not possible to convert an organization into a personal user account, but you can create a new user account and transfer the organization''s repositories to it.' redirect_from: - /articles/converting-an-organization-into-a-user + - /github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md b/content/organizations/managing-organization-settings/deleting-an-organization-account.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md rename to content/organizations/managing-organization-settings/deleting-an-organization-account.md index ab490ccd8f..ba2ac612ec 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md +++ b/content/organizations/managing-organization-settings/deleting-an-organization-account.md @@ -3,6 +3,7 @@ title: Deleting an organization account intro: 'When you delete an organization, all repositories, forks of private repositories, wikis, issues, pull requests, and Project or Organization Pages are deleted as well. {% if currentVersion == "free-pro-team@latest" %}The organization name becomes available for use on a new user or organization account, and your billing will end.{% endif %}' redirect_from: - /articles/deleting-an-organization-account + - /github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md rename to content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index d21c9c8b6f..ca813fdfe1 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -1,6 +1,8 @@ --- title: Disabling or limiting GitHub Actions for your organization intro: 'Organization owners can disable, enable, and limit GitHub Actions for an organization.' +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization versions: free-pro-team: '*' enterprise-server: '>=2.22' diff --git a/content/organizations/managing-organization-settings/index.md b/content/organizations/managing-organization-settings/index.md new file mode 100644 index 0000000000..407237383f --- /dev/null +++ b/content/organizations/managing-organization-settings/index.md @@ -0,0 +1,39 @@ +--- +title: Managing organization settings +intro: 'Organization administrators can change several settings, including the names of repositories that belong to the organization and Owners team membership. In addition, organization admins can delete the organization and all of its repositories.' +redirect_from: + - /articles/managing-organization-settings + - /github/setting-up-and-managing-organizations-and-teams/managing-organization-settings +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +{% link_in_list /verifying-your-organizations-domain %} +{% link_in_list /renaming-an-organization %} +{% link_in_list /transferring-organization-ownership %} +{% link_in_list /restricting-repository-creation-in-your-organization %} +{% link_in_list /setting-permissions-for-deleting-or-transferring-repositories %} +{% link_in_list /restricting-repository-visibility-changes-in-your-organization %} +{% link_in_list /managing-the-forking-policy-for-your-organization %} +{% link_in_list /disabling-or-limiting-github-actions-for-your-organization %} +{% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization %} +{% link_in_list /setting-permissions-for-adding-outside-collaborators %} +{% link_in_list /allowing-people-to-delete-issues-in-your-organization %}{% if currentVersion == "free-pro-team@latest" %} +{% link_in_list /managing-discussion-creation-for-repositories-in-your-organization %}{% endif %} +{% link_in_list /setting-team-creation-permissions-in-your-organization %} +{% link_in_list /managing-scheduled-reminders-for-your-organization %} +{% link_in_list /managing-the-default-branch-name-for-repositories-in-your-organization %} +{% link_in_list /managing-default-labels-for-repositories-in-your-organization %} +{% link_in_list /changing-the-visibility-of-your-organizations-dependency-insights %} +{% link_in_list /managing-the-display-of-member-names-in-your-organization %} +{% link_in_list /managing-updates-from-accounts-your-organization-sponsors %} +{% link_in_list /managing-the-publication-of-github-pages-sites-for-your-organization %} +{% link_in_list /deleting-an-organization-account %} +{% link_in_list /converting-an-organization-into-a-user %} +{% link_in_list /integrating-jira-with-your-organization-project-board %} +{% link_in_list /upgrading-to-the-corporate-terms-of-service %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board.md b/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board.md rename to content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md index 6a3cf2daff..53d4e71637 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board.md +++ b/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md @@ -3,6 +3,7 @@ title: Integrating Jira with your organization project board intro: 'You can integrate Jira Cloud with your organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.' redirect_from: - /articles/integrating-jira-with-your-organization-project-board + - /github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board versions: enterprise-server: '*' github-ae: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md rename to content/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization.md index 7ec3f9f8c4..6392e569c0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization.md @@ -3,6 +3,7 @@ title: Managing default labels for repositories in your organization intro: You can customize the labels that are included in every new repository in your organization. redirect_from: - /articles/managing-default-labels-for-repositories-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization versions: free-pro-team: '*' enterprise-server: '>=2.20' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization.md rename to content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md index 59557ff8e9..6a193d77a0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md @@ -1,6 +1,8 @@ --- title: Managing discussion creation for repositories in your organization intro: You can choose the permission levels that members require to create discussions in repositories owned by your organization. +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization permissions: Organization owners can manage discussion creation for repositories owned by the organization. versions: free-pro-team: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization.md b/content/organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization.md rename to content/organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization.md index 1d046ad5ee..40031825db 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization.md @@ -1,6 +1,8 @@ --- title: Managing scheduled reminders for your organization intro: You can get reminders in Slack for all pull requests that teams in your organization have been requested to review. +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization versions: free-pro-team: '*' topics: @@ -62,4 +64,4 @@ Organization owners can schedule a reminder for one or more teams in their organ ### Further reading - "[Managing your scheduled reminders](/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders)" -- "[Managing scheduled reminders for your team](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team)" +- "[Managing scheduled reminders for your team](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md rename to content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md index d0c412bd38..e92f24b39b 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md @@ -1,6 +1,8 @@ --- title: Managing the default branch name for repositories in your organization intro: 'You can set the default branch name for repositories that members create in your organization on {% data variables.product.product_location %}.' +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization permissions: Organization owners can manage the default branch name for new repositories in the organization. versions: free-pro-team: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md b/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md rename to content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md index 2ea1724010..792d2ee771 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization.md @@ -4,6 +4,7 @@ intro: You can allow members of your organization to see a comment author's prof product: '{% data reusables.gated-features.display-names %}' redirect_from: - /articles/managing-the-display-of-member-names-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md rename to content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index d0c4ef8fe6..705fe3f867 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'You can can allow or prevent the forking of any private{% if currentVers redirect_from: - /articles/allowing-people-to-fork-private-repositories-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization permissions: Organization owners can manage the forking policy for an organization. versions: free-pro-team: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md rename to content/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization.md index c081293b50..153a8dc7c0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization.md @@ -9,6 +9,7 @@ versions: github-ae: '*' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization topics: - organizations - teams diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md rename to content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md index d849f0d8b8..a3e01ff5a7 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors.md +++ b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md @@ -1,6 +1,8 @@ --- title: Managing updates from accounts your organization sponsors intro: You can manage the email address that receives updates from accounts your organization sponsors. +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors versions: free-pro-team: '*' permissions: Organization owners can manage updates from accounts the organization sponsors. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md b/content/organizations/managing-organization-settings/renaming-an-organization.md similarity index 79% rename from content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md rename to content/organizations/managing-organization-settings/renaming-an-organization.md index 9a63d45940..238a4c1df0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md +++ b/content/organizations/managing-organization-settings/renaming-an-organization.md @@ -4,6 +4,7 @@ intro: 'If your project or company has changed names, you can update the name of redirect_from: - /articles/what-happens-when-i-change-my-organization-s-name/ - /articles/renaming-an-organization + - /github/setting-up-and-managing-organizations-and-teams/renaming-an-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -34,7 +35,8 @@ After changing your organization's name, your old organization name becomes avai After changing your organization's name: - Links to your previous organization profile page, such as `https://{% data variables.command_line.backticks %}/previousorgname`, will return a 404 error. We recommend you update links to your organization from other sites{% if currentVersion == "free-pro-team@latest" %}, such as your LinkedIn or Twitter profiles{% endif %}. - API requests that use the old organization's name will return a 404 error. We recommend you update the old organization name in your API requests. -- There are no automatic [@mention](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) redirects for teams that use the old organization's name. +- There are no automatic [@mention](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) redirects for teams that use the old organization's name.{% if currentVersion == "free-pro-team@latest" %} +- If SAML single sign-on (SSO) is enabled for the organization, you must update the organization name in the application for {% data variables.product.prodname_ghe_cloud %} on your identity provider (IdP). If you don't update the organization name on your IdP, members of the organization will no longer be able to authenticate with your IdP to access the organization's resources. For more information, see "[Connecting your identity provider to your organization](/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization)."{% endif %} ### Changing your organization's name diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md similarity index 90% rename from content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md rename to content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index 8c3dd0b4e0..330971580a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -3,6 +3,7 @@ title: Restricting repository creation in your organization intro: 'To protect your organization''s data, you can configure permissions for creating repositories in your organization.' redirect_from: - /articles/restricting-repository-creation-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -20,7 +21,7 @@ Organization owners can always create any type of repository. {% warning %} -**Warning**: This setting only restricts the visibility options available when repositories are created and does not restrict the ability to change repository visibility at a later time. For more information about restricting changes to existing repositories' visibilities, see "[Restricting repository visibility changes in your organization](/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization)." +**Warning**: This setting only restricts the visibility options available when repositories are created and does not restrict the ability to change repository visibility at a later time. For more information about restricting changes to existing repositories' visibilities, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." {% endwarning %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md rename to content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md index 0e9ff0ecde..f6beab6468 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md @@ -3,6 +3,7 @@ title: Restricting repository visibility changes in your organization intro: 'To protect your organization''s data, you can configure permissions for changing repository visibility in your organization.' redirect_from: - /articles/restricting-repository-visibility-changes-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md b/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md rename to content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md index 118d2a24a5..266479e4f3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md +++ b/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.restict-add-collaborator %}' redirect_from: - /articles/restricting-the-ability-to-add-outside-collaborators-to-organization-repositories/ - /articles/setting-permissions-for-adding-outside-collaborators + - /github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md b/content/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories.md similarity index 90% rename from content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md rename to content/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories.md index aaa629acd2..ad92065f80 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md +++ b/content/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories.md @@ -4,6 +4,7 @@ intro: 'You can allow organization members with admin permissions to a repositor redirect_from: - /articles/setting-permissions-for-deleting-or-transferring-repositories-in-your-organization/ - /articles/setting-permissions-for-deleting-or-transferring-repositories + - /github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md b/content/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md rename to content/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization.md index 522a15d7f5..aef8790320 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md +++ b/content/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization.md @@ -3,6 +3,7 @@ title: Setting team creation permissions in your organization intro: You can allow all organization members to create teams or limit team creation to organization owners. redirect_from: - /articles/setting-team-creation-permissions-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md b/content/organizations/managing-organization-settings/transferring-organization-ownership.md similarity index 84% rename from content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md rename to content/organizations/managing-organization-settings/transferring-organization-ownership.md index 1fc1cea562..36919bf9d1 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md +++ b/content/organizations/managing-organization-settings/transferring-organization-ownership.md @@ -1,9 +1,10 @@ --- title: Transferring organization ownership +intro: 'To make someone else the owner of an organization account, you must add a new owner{% if currentVersion == "free-pro-team@latest" %}, ensure that the billing information is updated,{% endif %} and then remove yourself from the account.' redirect_from: - /articles/needs-polish-how-do-i-give-ownership-to-an-organization-to-someone-else/ - /articles/transferring-organization-ownership -intro: 'To make someone else the owner of an organization account, you must add a new owner{% if currentVersion == "free-pro-team@latest" %}, ensure that the billing information is updated,{% endif %} and then remove yourself from the account.' + - /github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership versions: free-pro-team: '*' enterprise-server: '*' @@ -13,7 +14,7 @@ topics: - teams --- -1. If you're the only member with *owner* privileges, give another organization member the owner role. For more information, see "[Appointing an organization owner](/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)." +1. If you're the only member with *owner* privileges, give another organization member the owner role. For more information, see "[Appointing an organization owner](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)." 2. Contact the new owner and make sure he or she is able to [access the organization's settings](/articles/accessing-your-organization-s-settings). {% if currentVersion == "free-pro-team@latest" %} 3. If you are currently responsible for paying for GitHub in your organization, you'll also need to have the new owner or a [billing manager](/articles/adding-a-billing-manager-to-your-organization/) update the organization's payment information. For more information, see "[Adding or editing a payment method](/articles/adding-or-editing-a-payment-method)." diff --git a/content/github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service.md b/content/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service.md rename to content/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service.md index 2d8302bb1d..21875d86ab 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service.md +++ b/content/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service.md @@ -3,6 +3,7 @@ title: Upgrading to the Corporate Terms of Service intro: Organizations can upgrade from the Standard Terms of Service to the Corporate Terms of Service. redirect_from: - /articles/upgrading-to-the-corporate-terms-of-service + - /github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain.md b/content/organizations/managing-organization-settings/verifying-your-organizations-domain.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain.md rename to content/organizations/managing-organization-settings/verifying-your-organizations-domain.md index 2aaf181720..196904f48c 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain.md +++ b/content/organizations/managing-organization-settings/verifying-your-organizations-domain.md @@ -4,6 +4,7 @@ intro: 'You can verify the domains controlled by your organization to confirm yo redirect_from: - /articles/verifying-your-organization-s-domain - /articles/verifying-your-organizations-domain + - /github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization.md rename to content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md index f9ae9677a0..f8b2075ce9 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md @@ -3,6 +3,7 @@ title: Adding a billing manager to your organization intro: 'A *billing manager* is a user who manages the billing settings for your organization, such as updating payment information. This is a great option if regular members of your organization don''t typically have access to billing resources.' redirect_from: - /articles/adding-a-billing-manager-to-your-organization + - /github/setting-up-and-managing-organizations-and-teams/adding-a-billing-manager-to-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md rename to content/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member.md index 5153f6a357..8a2a80a2a4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member.md @@ -4,6 +4,7 @@ intro: 'An organization owner can promote any member of the organization to *tea redirect_from: - /articles/giving-team-maintainer-permissions-to-an-organization-member-early-access-program/ - /articles/giving-team-maintainer-permissions-to-an-organization-member + - /github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md similarity index 56% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md rename to content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md index 9d14684e91..a6fedeb7bc 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md @@ -4,7 +4,7 @@ intro: 'A person''s role in your organization defines their level of access to y redirect_from: - /articles/managing-people-s-access-to-your-organization-with-roles - /articles/managing-peoples-access-to-your-organization-with-roles -mapTopic: true + - /github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles versions: free-pro-team: '*' enterprise-server: '*' @@ -14,3 +14,8 @@ topics: - teams --- +{% link_in_list /permission-levels-for-an-organization %} +{% link_in_list /maintaining-ownership-continuity-for-your-organization %} +{% link_in_list /giving-team-maintainer-permissions-to-an-organization-member %} +{% link_in_list /adding-a-billing-manager-to-your-organization %} +{% link_in_list /removing-a-billing-manager-from-your-organization %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization.md similarity index 80% rename from content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md rename to content/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization.md index 76c0456caa..28d578f6d1 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization.md @@ -5,6 +5,8 @@ redirect_from: - /articles/changing-a-person-s-role-to-owner - /articles/changing-a-persons-role-to-owner - /github/setting-up-and-managing-organizations-and-teams/changing-a-persons-role-to-owner + - /github/setting-up-and-managing-organizations-and-teams/managing-ownership-continuity-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization permissions: Organization owners can promote any member of an organization to an organization owner. versions: free-pro-team: '*' @@ -21,6 +23,12 @@ topics: Organization owners have full administrative access to the organization. {% data reusables.organizations.new-org-permissions-more-info %} +{% note %} + +**Note**: As an organization owner, you can change the role of other organization members and owners. You can't change your own role. + +{% endnote %} + ### Appointing an organization owner {% data reusables.profile.access_profile %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md similarity index 83% rename from content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md rename to content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md index ae61a1ad66..818a082bfa 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md @@ -4,6 +4,7 @@ intro: 'After you [create an organization](/articles/creating-a-new-organization redirect_from: - /articles/permission-levels-for-an-organization-early-access-program/ - /articles/permission-levels-for-an-organization + - /github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -17,7 +18,7 @@ topics: Organization members can have *owner*{% if currentVersion == "free-pro-team@latest" %}, *billing manager*,{% endif %} or *member* roles: -- **Owners** have complete administrative access to your organization. This role should be limited, but to no less than two people, in your organization. For more information, see "[Maintaining ownership continuity for your organization](/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization)." +- **Owners** have complete administrative access to your organization. This role should be limited, but to no less than two people, in your organization. For more information, see "[Maintaining ownership continuity for your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization)." {% if currentVersion == "free-pro-team@latest" %} - **Billing managers** allow a person to manage billing settings. For more information, see "[Adding a billing manager to your organization](/articles/adding-a-billing-manager-to-your-organization)". {% endif %} @@ -36,13 +37,13 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | Reinstate former members to the organization | **X** | | | | Add and remove people from **all teams** | **X** | | | | Promote organization members to *team maintainer* | **X** | | | -| Configure code review assignments (see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)") | **X** | | | +| Configure code review assignments (see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)") | **X** | | | | Set scheduled reminders (see "[Managing scheduled reminders for pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests)") | **X** | | | | Add collaborators to **all repositories** | **X** | | | | Access the organization audit log | **X** | | | | Edit the organization's profile page (see "[About your organization's profile](/articles/about-your-organization-s-profile)" for details) | **X** | | | | Verify the organization's domains (see "[Verifying your organization's domain](/articles/verifying-your-organization-s-domain)" for details) | **X** | | | -| Restrict email notifications to verified domains (see "[Restricting email notifications to an approved domain](/github/setting-up-and-managing-organizations-and-teams/restricting-email-notifications-to-an-approved-domain)" for details) | **X** | | | +| Restrict email notifications to verified domains (see "[Restricting email notifications to an approved domain](/organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain)" for details) | **X** | | | | Delete **all teams** | **X** | | | | Delete the organization account, including all repositories | **X** | | | | Create teams (see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)" for details) | **X** | **X** | | @@ -52,35 +53,35 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | @mention any visible team | **X** | **X** | | | Can be made a *team maintainer* | **X** | **X** | | | View organization insights (see "[Viewing insights for your organization](/articles/viewing-insights-for-your-organization)" for details) | **X** | **X** | | -| View and post public team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | **X** | | -| View and post private team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | | | +| View and post public team discussions to **all teams** (see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)" for details) | **X** | **X** | | +| View and post private team discussions to **all teams** (see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)" for details) | **X** | | | | Edit and delete team discussions in **all teams** (see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)" for details) | **X** | | | | Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | | | Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | | | Manage viewing of organization dependency insights (see "[Changing the visibility of your organization's dependency insights](/articles/changing-the-visibility-of-your-organizations-dependency-insights)" for details) | **X** | | | | Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | | | Sponsor accounts and manage the organization's sponsorships (see "[Sponsoring open-source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" for details) | **X** | **X** | | -| Manage email updates from sponsored accounts (see "[Managing updates from accounts your organization's sponsors](/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors)" for details) | **X** | | | +| Manage email updates from sponsored accounts (see "[Managing updates from accounts your organization's sponsors](/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors)" for details) | **X** | | | | Attribute your sponsorships to another organization (see "[Attributing sponsorships to your organization](/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization)" for details ) | **X** | | | -| Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | | | -| Manage security and analysis settings (see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" for details) | **X** | | | +| Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | | | +| Manage security and analysis settings (see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" for details) | **X** | | | | Enable and enforce [SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on) | **X** | | | -| [Manage a user's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization) | **X** | | | +| [Manage a user's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization) | **X** | | | | Manage an organization's SSH certificate authorities (see "[Managing your organization's SSH certificate authorities](/articles/managing-your-organizations-ssh-certificate-authorities)" for details) | **X** | | | | Transfer repositories | **X** | | | | Purchase, install, manage billing for, and cancel {% data variables.product.prodname_marketplace %} apps | **X** | | | | List apps in {% data variables.product.prodname_marketplace %} | **X** | | | | Receive [{% data variables.product.prodname_dependabot_alerts %} about vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) for all of an organization's repositories | **X** | | | | Manage {% data variables.product.prodname_dependabot_security_updates %} (see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)") | **X** | | | -| [Manage the forking policy](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization) | **X** | | | +| [Manage the forking policy](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization) | **X** | | | | [Limit activity in public repositories in an organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization) | **X** | | | | Pull (read), push (write), and clone (copy) *all repositories* in the organization | **X** | | | | Convert organization members to [outside collaborators](#outside-collaborators) | **X** | | | | [View people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository) | **X** | | | | [Export a list of people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository/#exporting-a-list-of-people-with-access-to-your-repository) | **X** | | | -| Manage the default branch name (see "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)") | **X** | | | +| Manage the default branch name (see "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)") | **X** | | | | Manage default labels (see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)") | **X** | | | -| Enable team synchronization (see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" for details) | **X** | | | +| Enable team synchronization (see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" for details) | **X** | | | {% else %} @@ -93,7 +94,7 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | Reinstate former members to the organization | **X** | | | | Add and remove people from **all teams** | **X** | | | Promote organization members to *team maintainer* | **X** | |{% if currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} -| Configure code review assignments (see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)") | **X** | |{% endif %} +| Configure code review assignments (see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)") | **X** | |{% endif %} | Add collaborators to **all repositories** | **X** | | | Access the organization audit log | **X** | | | Edit the organization's profile page (see "[About your organization's profile](/articles/about-your-organization-s-profile)" for details) | **X** | | | @@ -106,13 +107,13 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | Transfer repositories | **X** | | | Manage an organization's SSH certificate authorities (see "[Managing your organization's SSH certificate authorities](/articles/managing-your-organizations-ssh-certificate-authorities)" for details) | **X** | | | Create project boards (see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" for details) | **X** | **X** | | -| View and post public team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | **X** | | -| View and post private team discussions to **all teams** (see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)" for details) | **X** | | | +| View and post public team discussions to **all teams** (see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)" for details) | **X** | **X** | | +| View and post private team discussions to **all teams** (see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)" for details) | **X** | | | | Edit and delete team discussions in **all teams** (for more information, see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)) | **X** | | | | Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | **X** | | Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | | | Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | |{% if currentVersion ver_gt "enterprise-server@3.0" %} -| Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | |{% endif %} +| Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | |{% endif %} | [Move teams in an organization's hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy) | **X** | | | | Pull (read), push (write), and clone (copy) *all repositories* in the organization | **X** | | | Convert organization members to [outside collaborators](#outside-collaborators) | **X** | | diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization.md rename to content/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization.md index cc855248da..aa6186ab70 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization.md @@ -3,6 +3,7 @@ title: Removing a billing manager from your organization intro: 'If a person with the *billing manager* role no longer needs to view or change your organization''s billing information, you can remove their access to the organization.' redirect_from: - /articles/removing-a-billing-manager-from-your-organization + - /github/setting-up-and-managing-organizations-and-teams/removing-a-billing-manager-from-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md similarity index 87% rename from content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md index 154855ba68..683f583260 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md @@ -4,6 +4,7 @@ intro: 'If you centrally manage your users'' identities and applications with an product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/about-identity-and-access-management-with-saml-single-sign-on + - /github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on versions: free-pro-team: '*' topics: @@ -21,7 +22,7 @@ Organization owners can enforce SAML SSO for an individual organization, or ente {% data reusables.saml.outside-collaborators-exemption %} -Before enabling SAML SSO for your organization, you'll need to connect your IdP to your organization. For more information, see "[Connecting your identity provider to your organization](/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization)." +Before enabling SAML SSO for your organization, you'll need to connect your IdP to your organization. For more information, see "[Connecting your identity provider to your organization](/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization)." For an organization, SAML SSO can be disabled, enabled but not enforced, or enabled and enforced. After you enable SAML SSO for your organization and your organization's members successfully authenticate with your IdP, you can enforce the SAML SSO configuration. For more information about enforcing SAML SSO for your {% data variables.product.prodname_dotcom %} organization, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)." @@ -29,7 +30,7 @@ Members must periodically authenticate with your IdP to authenticate and gain ac To access the organization's protected resources using the API and Git on the command line, members must authorize and authenticate with a personal access token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." -The first time a member uses SAML SSO to access your organization, {% data variables.product.prodname_dotcom %} automatically creates a record that links your organization, the member's {% data variables.product.prodname_dotcom %} account, and the member's account on your IdP. You can view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[Viewing and managing a user's SAML access to your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account)." +The first time a member uses SAML SSO to access your organization, {% data variables.product.prodname_dotcom %} automatically creates a record that links your organization, the member's {% data variables.product.prodname_dotcom %} account, and the member's account on your IdP. You can view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[Viewing and managing a user's SAML access to your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account)." If members are signed in with a SAML SSO session when they create a new repository, the default visibility of that repository is private. Otherwise, the default visibility is public. For more information on repository visibility, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." @@ -41,7 +42,7 @@ Organization members must also have an active SAML session to authorize an {% da {% data reusables.saml.saml-supported-idps %} -Some IdPs support provisioning access to a {% data variables.product.prodname_dotcom %} organization via SCIM. For more information, see "[About SCIM](/github/setting-up-and-managing-organizations-and-teams/about-scim)." +Some IdPs support provisioning access to a {% data variables.product.prodname_dotcom %} organization via SCIM. For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." ### Adding members to an organization using SAML SSO @@ -49,7 +50,7 @@ After you enable SAML SSO, there are multiple ways you can add new members to yo To provision new users without an invitation from an organization owner, you can use the URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, replacing _ORGANIZATION_ with the name of your organization. For example, you can configure your IdP so that anyone with access to the IdP can click a link on the IdP's dashboard to join your {% data variables.product.prodname_dotcom %} organization. -If your IdP supports SCIM, {% data variables.product.prodname_dotcom %} can automatically invite members to join your organization when you grant access on your IdP. If you remove a member's access to your {% data variables.product.prodname_dotcom %} organization on your SAML IdP, the member will be automatically removed from the {% data variables.product.prodname_dotcom %} organization. For more information, see "[About SCIM](/github/setting-up-and-managing-organizations-and-teams/about-scim)." +If your IdP supports SCIM, {% data variables.product.prodname_dotcom %} can automatically invite members to join your organization when you grant access on your IdP. If you remove a member's access to your {% data variables.product.prodname_dotcom %} organization on your SAML IdP, the member will be automatically removed from the {% data variables.product.prodname_dotcom %} organization. For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." {% data reusables.organizations.team-synchronization %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/about-scim.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md index 36f06c2387..f2803a2adc 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim.md @@ -4,6 +4,7 @@ intro: 'With System for Cross-domain Identity Management (SCIM), administrators product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/about-scim + - /github/setting-up-and-managing-organizations-and-teams/about-scim versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable.md index 6cea7ad0bd..799e031b02 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable.md @@ -4,6 +4,7 @@ intro: 'Organization administrators can sign into {% data variables.product.prod product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/accessing-your-organization-if-your-identity-provider-is-unavailable + - /github/setting-up-and-managing-organizations-and-teams/accessing-your-organization-if-your-identity-provider-is-unavailable versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md similarity index 87% rename from content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md index effe8a36c8..f2cb111b81 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md @@ -1,6 +1,8 @@ --- title: Configuring SAML single sign-on and SCIM using Okta intro: 'You can use Security Assertion Markup Language (SAML) single sign-on (SSO) and System for Cross-domain Identity Management (SCIM) with Okta to automatically manage access to your organization on {% data variables.product.prodname_dotcom %}.' +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta product: '{% data reusables.gated-features.saml-sso %}' permissions: Organization owners can configure SAML SSO and SCIM using Okta for an organization. versions: @@ -14,7 +16,7 @@ topics: You can control access to your {% data variables.product.prodname_dotcom %} organization and other web applications from one central interface by configuring the organization to use SAML SSO and SCIM with Okta, an Identity Provider (IdP). -SAML SSO controls and secures access to organization resources like repositories, issues, and pull requests. SCIM automatically adds, manages, and removes members' access to your {% data variables.product.prodname_dotcom %} organization when you make changes in Okta. For more information, see "[About identity and access management with SAML single sign-on](/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on)" and "[About SCIM](/github/setting-up-and-managing-organizations-and-teams/about-scim)." +SAML SSO controls and secures access to organization resources like repositories, issues, and pull requests. SCIM automatically adds, manages, and removes members' access to your {% data variables.product.prodname_dotcom %} organization when you make changes in Okta. For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" and "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." After you enable SCIM, the following provisioning features are available for any users that you assign your {% data variables.product.prodname_ghe_cloud %} application to in Okta. @@ -49,7 +51,7 @@ After you enable SCIM, the following provisioning features are available for any {% data reusables.saml.assign-yourself-to-okta %} {% data reusables.saml.okta-sign-on-tab %} {% data reusables.saml.okta-view-setup-instructions %} -6. Enable and test SAML SSO on {% data variables.product.prodname_dotcom %} using the sign on URL, issuer URL, and public certificates from the "How to Configure SAML 2.0" guide. For more information, see "[Enabling and testing SAML single sign-on for your organization](/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization)." +6. Enable and test SAML SSO on {% data variables.product.prodname_dotcom %} using the sign on URL, issuer URL, and public certificates from the "How to Configure SAML 2.0" guide. For more information, see "[Enabling and testing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization)." ### Configuring access provisioning with SCIM in Okta @@ -79,6 +81,6 @@ After you enable SCIM, the following provisioning features are available for any ### Further reading - "[Configuring SAML single sign-on and SCIM for your enterprise account using Okta](/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta)" -- "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization#enabling-team-synchronization-for-okta)" +- "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization#enabling-team-synchronization-for-okta)" - [Understanding SAML](https://developer.okta.com/docs/concepts/saml/) in the Okta documentation - [Understanding SCIM](https://developer.okta.com/docs/concepts/scim/) in the Okta documentation diff --git a/content/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md index 1196bdc9b3..a8c18184eb 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md @@ -4,6 +4,7 @@ intro: 'To use SAML single sign-on and SCIM, you must connect your identity prov product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/connecting-your-identity-provider-to-your-organization + - /github/setting-up-and-managing-organizations-and-teams/connecting-your-identity-provider-to-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md index fe2af11379..1a5907b496 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md @@ -4,6 +4,7 @@ intro: 'Organization administrators should download their organization''s SAML s redirect_from: - /articles/downloading-your-organization-s-saml-single-sign-on-recovery-codes - /articles/downloading-your-organizations-saml-single-sign-on-recovery-codes + - /github/setting-up-and-managing-organizations-and-teams/downloading-your-organizations-saml-single-sign-on-recovery-codes product: '{% data reusables.gated-features.saml-sso %}' versions: free-pro-team: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md index 8f3fc489a1..e5084e8f26 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md @@ -4,6 +4,7 @@ intro: Organization owners and admins can enable SAML single sign-on to add an e product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/enabling-and-testing-saml-single-sign-on-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/enabling-and-testing-saml-single-sign-on-for-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md index 08241fc58b..65065df85a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md @@ -4,6 +4,7 @@ intro: Organization owners and admins can enforce SAML SSO so that all organizat product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/enforcing-saml-single-sign-on-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization versions: free-pro-team: '*' topics: diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md new file mode 100644 index 0000000000..6dc52297a3 --- /dev/null +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md @@ -0,0 +1,24 @@ +--- +title: Managing SAML single sign-on for your organization +intro: Organization administrators can manage organization members' identities and access to the organization with SAML single sign-on (SSO). +redirect_from: + - /articles/managing-member-identity-and-access-in-your-organization-with-saml-single-sign-on/ + - /articles/managing-saml-single-sign-on-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/managing-saml-single-sign-on-for-your-organization +versions: + free-pro-team: '*' +topics: + - organizations + - teams +--- + +{% link_in_list /about-identity-and-access-management-with-saml-single-sign-on %} +{% link_in_list /about-scim %} +{% link_in_list /connecting-your-identity-provider-to-your-organization %} +{% link_in_list /configuring-saml-single-sign-on-and-scim-using-okta %} +{% link_in_list /enabling-and-testing-saml-single-sign-on-for-your-organization %} +{% link_in_list /preparing-to-enforce-saml-single-sign-on-in-your-organization %} +{% link_in_list /enforcing-saml-single-sign-on-for-your-organization %} +{% link_in_list /downloading-your-organizations-saml-single-sign-on-recovery-codes %} +{% link_in_list /managing-team-synchronization-for-your-organization %} +{% link_in_list /accessing-your-organization-if-your-identity-provider-is-unavailable %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md index afbdb5dfe0..a12f67af14 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md @@ -6,6 +6,7 @@ redirect_from: - /articles/synchronizing-teams-between-your-identity-provider-and-github - /github/setting-up-and-managing-organizations-and-teams/synchronizing-teams-between-your-identity-provider-and-github - /github/articles/synchronizing-teams-between-okta-and-github + - /github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization permissions: Organization owners can manage team synchronization for an organization. miniTocMaxHeadingLevel: 4 versions: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/preparing-to-enforce-saml-single-sign-on-in-your-organization.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization.md rename to content/organizations/managing-saml-single-sign-on-for-your-organization/preparing-to-enforce-saml-single-sign-on-in-your-organization.md index c94b189833..0e370456c8 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/preparing-to-enforce-saml-single-sign-on-in-your-organization.md @@ -4,6 +4,7 @@ intro: 'Before you enforce SAML single sign-on in your organization, you should product: '{% data reusables.gated-features.saml-sso %}' redirect_from: - /articles/preparing-to-enforce-saml-single-sign-on-in-your-organization + - /github/setting-up-and-managing-organizations-and-teams/preparing-to-enforce-saml-single-sign-on-in-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md similarity index 94% rename from content/github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions.md rename to content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md index c706237e94..30f8dcea86 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md @@ -4,6 +4,7 @@ intro: 'If your organization was created after September 2015, your organization redirect_from: - /articles/converting-your-previous-admin-team-to-the-improved-organization-permissions/ - /articles/converting-an-admin-team-to-improved-organization-permissions + - /github/setting-up-and-managing-organizations-and-teams/converting-an-admin-team-to-improved-organization-permissions versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions.md rename to content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md index 1caafa06b9..ea280612e1 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md @@ -5,6 +5,7 @@ redirect_from: - /articles/converting-your-previous-owners-team-to-the-improved-organization-permissions-early-access-program/ - /articles/converting-your-previous-owners-team-to-the-improved-organization-permissions/ - /articles/converting-an-owners-team-to-improved-organization-permissions + - /github/setting-up-and-managing-organizations-and-teams/converting-an-owners-team-to-improved-organization-permissions versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/index.md similarity index 66% rename from content/github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions.md rename to content/organizations/migrating-to-improved-organization-permissions/index.md index ccaaf3494e..5a0539da2a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/index.md @@ -1,12 +1,12 @@ --- title: Migrating to improved organization permissions intro: 'If your organization was created after September 2015, your organization includes improved organization permissions by default. Organizations created before September 2015 may need to migrate older Owners and Admin teams to the improved organization permissions model.' -mapTopic: true redirect_from: - /articles/improved-organization-permissions/ - /articles/github-direct-organization-membership-pre-release-guide/ - /articles/migrating-your-organization-to-improved-organization-permissions/ - /articles/migrating-to-improved-organization-permissions + - /github/setting-up-and-managing-organizations-and-teams/migrating-to-improved-organization-permissions versions: free-pro-team: '*' enterprise-server: '*' @@ -15,3 +15,6 @@ topics: - teams --- +{% link_in_list /converting-an-owners-team-to-improved-organization-permissions %} +{% link_in_list /converting-an-admin-team-to-improved-organization-permissions %} +{% link_in_list /migrating-admin-teams-to-improved-organization-permissions %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions.md rename to content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md index 47a3e880a4..b29dc59631 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md @@ -4,6 +4,7 @@ intro: 'If your organization was created after September 2015, your organization redirect_from: - /articles/migrating-your-previous-admin-teams-to-the-improved-organization-permissions/ - /articles/migrating-admin-teams-to-improved-organization-permissions + - /github/setting-up-and-managing-organizations-and-teams/migrating-admin-teams-to-improved-organization-permissions versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md b/content/organizations/organizing-members-into-teams/about-teams.md similarity index 97% rename from content/github/setting-up-and-managing-organizations-and-teams/about-teams.md rename to content/organizations/organizing-members-into-teams/about-teams.md index aa9b95d1fd..cf887f548a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md +++ b/content/organizations/organizing-members-into-teams/about-teams.md @@ -3,6 +3,7 @@ title: About teams intro: Teams are groups of organization members that reflect your company or group's structure with cascading access permissions and mentions. redirect_from: - /articles/about-teams + - /github/setting-up-and-managing-organizations-and-teams/about-teams versions: free-pro-team: '*' enterprise-server: '*' @@ -39,7 +40,7 @@ You can also use LDAP Sync to synchronize {% data variables.product.product_loca Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page. -Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." +Organization members can create and participate in discussions with the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." ![Team page listing team members and discussions](/assets/images/help/organizations/team-page-discussions-tab.png) diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md b/content/organizations/organizing-members-into-teams/adding-organization-members-to-a-team.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md rename to content/organizations/organizing-members-into-teams/adding-organization-members-to-a-team.md index e1152db89d..71f787437d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md +++ b/content/organizations/organizing-members-into-teams/adding-organization-members-to-a-team.md @@ -4,6 +4,7 @@ intro: 'People with owner or team maintainer permissions can add organization me redirect_from: - /articles/adding-organization-members-to-a-team-early-access-program/ - /articles/adding-organization-members-to-a-team + - /github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md b/content/organizations/organizing-members-into-teams/changing-team-visibility.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md rename to content/organizations/organizing-members-into-teams/changing-team-visibility.md index 262113a3a3..02a93f9013 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md +++ b/content/organizations/organizing-members-into-teams/changing-team-visibility.md @@ -3,6 +3,7 @@ title: Changing team visibility intro: Team maintainers and organization owners can determine whether a team is *visible* or *secret*. redirect_from: - /articles/changing-team-visibility + - /github/setting-up-and-managing-organizations-and-teams/changing-team-visibility versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md b/content/organizations/organizing-members-into-teams/creating-a-team.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md rename to content/organizations/organizing-members-into-teams/creating-a-team.md index 4bba443eb8..e3884e45df 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md +++ b/content/organizations/organizing-members-into-teams/creating-a-team.md @@ -4,6 +4,7 @@ intro: You can create independent or nested teams to manage repository permissio redirect_from: - /articles/creating-a-team-early-access-program/ - /articles/creating-a-team + - /github/setting-up-and-managing-organizations-and-teams/creating-a-team versions: free-pro-team: '*' enterprise-server: '*' @@ -24,7 +25,7 @@ Only organization owners and maintainers of a parent team can create a new child {% data reusables.organizations.team_description %} {% data reusables.organizations.create-team-choose-parent %} {% if currentVersion == "free-pro-team@latest" %} -1. Optionally, if your organization or enterprise account uses team synchronization, to connect an identity provider group to your team, use the "Identity Provider Groups" drop-down menu, and select up to 5 identity provider groups. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." +1. Optionally, if your organization or enterprise account uses team synchronization, to connect an identity provider group to your team, use the "Identity Provider Groups" drop-down menu, and select up to 5 identity provider groups. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png) {% endif %} {% data reusables.organizations.team_visibility %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md b/content/organizations/organizing-members-into-teams/deleting-a-team.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md rename to content/organizations/organizing-members-into-teams/deleting-a-team.md index 5509cc6d98..505eca7bb5 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md +++ b/content/organizations/organizing-members-into-teams/deleting-a-team.md @@ -3,6 +3,7 @@ title: Deleting a team intro: Organization owners can delete teams at any time from the team's settings page. redirect_from: - /articles/deleting-a-team + - /github/setting-up-and-managing-organizations-and-teams/deleting-a-team versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md b/content/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization.md similarity index 83% rename from content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md rename to content/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization.md index 99b423896d..105a28d2bb 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md +++ b/content/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization.md @@ -3,6 +3,7 @@ title: Disabling team discussions for your organization intro: Organization owners can choose to disable or enable team discussions across the organization. redirect_from: - /articles/disabling-team-discussions-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization versions: free-pro-team: '*' enterprise-server: '*' @@ -12,7 +13,7 @@ topics: - teams --- -{% data reusables.organizations.team-discussions-default %} For more information on team discussions, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." +{% data reusables.organizations.team-discussions-default %} For more information on team discussions, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} diff --git a/content/organizations/organizing-members-into-teams/index.md b/content/organizations/organizing-members-into-teams/index.md new file mode 100644 index 0000000000..0efd481006 --- /dev/null +++ b/content/organizations/organizing-members-into-teams/index.md @@ -0,0 +1,38 @@ +--- +title: Organizing members into teams +intro: You can group organization members into teams that reflect your company or group's structure with cascading access permissions and mentions. +redirect_from: + - /articles/setting-up-teams-improved-organization-permissions/ + - /articles/setting-up-teams-for-accessing-organization-repositories/ + - /articles/creating-teams/ + - /articles/adding-people-to-teams-in-an-organization/ + - /articles/removing-a-member-from-a-team-in-your-organization/ + - /articles/setting-up-teams/ + - /articles/maintaining-teams-improved-organization-permissions/ + - /articles/maintaining-teams/ + - /articles/organizing-members-into-teams + - /github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +topics: + - organizations + - teams +--- + +{% link_in_list /about-teams %} +{% link_in_list /creating-a-team %} +{% link_in_list /setting-your-teams-profile-picture %} +{% link_in_list /adding-organization-members-to-a-team %} +{% link_in_list /managing-code-review-assignment-for-your-team %} +{% link_in_list /renaming-a-team %} +{% link_in_list /changing-team-visibility %} +{% link_in_list /synchronizing-a-team-with-an-identity-provider-group %} +{% link_in_list /moving-a-team-in-your-organizations-hierarchy %} +{% link_in_list /requesting-to-add-a-child-team %} +{% link_in_list /requesting-to-add-or-change-a-parent-team %} +{% link_in_list /removing-organization-members-from-a-team %} +{% link_in_list /disabling-team-discussions-for-your-organization %} +{% link_in_list /managing-scheduled-reminders-for-your-team %} +{% link_in_list /deleting-a-team %} \ No newline at end of file diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md b/content/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md rename to content/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team.md index 3ba913f229..2d0a1adbf3 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md +++ b/content/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team.md @@ -1,6 +1,8 @@ --- title: Managing code review assignment for your team intro: Code review assignments clearly indicate which members of a team are expected to submit a review for a pull request. +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team product: '{% data reusables.gated-features.code-review-assignment %}' versions: free-pro-team: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team.md b/content/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team.md rename to content/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team.md index be3b2ef9c0..6ae379265f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team.md +++ b/content/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team.md @@ -3,6 +3,7 @@ title: Managing scheduled reminders for your team intro: You can get reminders in Slack when your team has pull requests waiting for review. redirect_from: - /github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests + - /github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your team versions: free-pro-team: '*' topics: @@ -14,7 +15,7 @@ topics: {% data reusables.reminders.about-scheduled-reminders-teams-orgs %} -Team maintainers and organization owners can set scheduled reminders for any pull requests that a team has been requested to review. Before you can create a scheduled reminder for your team, an organization owner must authorize your Slack workspace. For more information, see "[Managing scheduled reminders for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization)." +Team maintainers and organization owners can set scheduled reminders for any pull requests that a team has been requested to review. Before you can create a scheduled reminder for your team, an organization owner must authorize your Slack workspace. For more information, see "[Managing scheduled reminders for your organization](/organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization)." {% data reusables.reminders.scheduled-reminders-limitations %} @@ -64,5 +65,5 @@ Team maintainers and organization owners can set scheduled reminders for any pul ### Further reading -- "[Managing scheduled reminders for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-organization)" +- "[Managing scheduled reminders for your organization](/organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization)" - "[Managing your scheduled reminders](/github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders)" diff --git a/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md b/content/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md rename to content/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md index 7ffab5946c..702d09e94e 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md +++ b/content/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md @@ -5,6 +5,7 @@ redirect_from: - /articles/changing-a-team-s-parent/ - /articles/moving-a-team-in-your-organization-s-hierarchy - /articles/moving-a-team-in-your-organizations-hierarchy + - /github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md b/content/organizations/organizing-members-into-teams/removing-organization-members-from-a-team.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md rename to content/organizations/organizing-members-into-teams/removing-organization-members-from-a-team.md index 5407d12da3..d26a3f5f88 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md +++ b/content/organizations/organizing-members-into-teams/removing-organization-members-from-a-team.md @@ -4,6 +4,7 @@ intro: 'People with *owner* or *team maintainer* permissions can remove team mem redirect_from: - /articles/removing-organization-members-from-a-team-early-access-program/ - /articles/removing-organization-members-from-a-team + - /github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md b/content/organizations/organizing-members-into-teams/renaming-a-team.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md rename to content/organizations/organizing-members-into-teams/renaming-a-team.md index 333b94a9dc..3161fa210b 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md +++ b/content/organizations/organizing-members-into-teams/renaming-a-team.md @@ -3,6 +3,7 @@ title: Renaming a team intro: Team maintainers and organization owners can edit the name and description of a team. redirect_from: - /articles/renaming-a-team + - /github/setting-up-and-managing-organizations-and-teams/renaming-a-team versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md b/content/organizations/organizing-members-into-teams/requesting-to-add-a-child-team.md similarity index 96% rename from content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md rename to content/organizations/organizing-members-into-teams/requesting-to-add-a-child-team.md index 26a741bfc4..ced4cbafd1 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md +++ b/content/organizations/organizing-members-into-teams/requesting-to-add-a-child-team.md @@ -3,6 +3,7 @@ title: Requesting to add a child team intro: 'If you have maintainer permissions in a team, you can request to nest an existing team under your team in your organization’s hierarchy.' redirect_from: - /articles/requesting-to-add-a-child-team + - /github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md b/content/organizations/organizing-members-into-teams/requesting-to-add-or-change-a-parent-team.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md rename to content/organizations/organizing-members-into-teams/requesting-to-add-or-change-a-parent-team.md index df965d01f5..d22b063105 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md +++ b/content/organizations/organizing-members-into-teams/requesting-to-add-or-change-a-parent-team.md @@ -3,6 +3,7 @@ title: Requesting to add or change a parent team intro: 'If you have maintainer permissions in a team, you can request to nest your team under a parent team in your organization''s hierarchy.' redirect_from: - /articles/requesting-to-add-or-change-a-parent-team + - /github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md b/content/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md similarity index 91% rename from content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md rename to content/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md index e22599de91..1bade56858 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md +++ b/content/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md @@ -4,6 +4,7 @@ intro: 'Team maintainers and organization owners can set a profile picture for a redirect_from: - /articles/setting-your-team-s-profile-picture - /articles/setting-your-teams-profile-picture + - /github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md b/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md similarity index 89% rename from content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md rename to content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md index b37dc6cb95..d43224e935 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -1,6 +1,8 @@ --- title: Synchronizing a team with an identity provider group intro: 'You can synchronize a {% data variables.product.product_name %} team with an identity provider (IdP) group to automatically add and remove team members.' +redirect_from: + - /github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group product: '{% data reusables.gated-features.team-synchronization %}' permissions: 'Organization owners and team maintainers can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group.' versions: @@ -32,7 +34,7 @@ Connecting a team to an IdP group may remove some team members. For more informa When group membership changes on your IdP, your IdP sends a SCIM request with the changes to {% data variables.product.product_name %} according to the schedule determined by your IdP. Any requests that change {% data variables.product.prodname_dotcom %} team or organization membership will register in the audit log as changes made by the account used to configure user provisioning. For more information about this account, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." For more information about SCIM request schedules, see "[Check the status of user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" in the Microsoft Docs. {% endif %} -Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/github/setting-up-and-managing-organizations-and-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." +Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." To manage repository access for any {% data variables.product.prodname_dotcom %} team, including teams connected to an IdP group, you must make changes with {% data variables.product.product_name %}. For more information, see "[About teams](/articles/about-teams)" and "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)." @@ -46,7 +48,7 @@ After you connect a team to an IdP group, team synchronization will add each mem - The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. - The person's SSO identity is a member of the IdP group. -Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." +Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." A removed team member can be added back to a team automatically once they have authenticated to the organization or enterprise account using SSO and are moved to the connected IdP group. @@ -59,7 +61,7 @@ If your organization is owned by an enterprise account, enabling team synchroniz ### Prerequisites {% if currentVersion == "free-pro-team@latest" %} -Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." +Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions.md b/content/organizations/restricting-access-to-your-organizations-data/about-oauth-app-access-restrictions.md similarity index 98% rename from content/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions.md rename to content/organizations/restricting-access-to-your-organizations-data/about-oauth-app-access-restrictions.md index 4122072bda..1be3424488 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions.md +++ b/content/organizations/restricting-access-to-your-organizations-data/about-oauth-app-access-restrictions.md @@ -4,6 +4,7 @@ intro: 'Organizations can choose which {% data variables.product.prodname_oauth_ redirect_from: - /articles/about-third-party-application-restrictions/ - /articles/about-oauth-app-access-restrictions + - /github/setting-up-and-managing-organizations-and-teams/about-oauth-app-access-restrictions versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization.md b/content/organizations/restricting-access-to-your-organizations-data/approving-oauth-apps-for-your-organization.md similarity index 93% rename from content/github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization.md rename to content/organizations/restricting-access-to-your-organizations-data/approving-oauth-apps-for-your-organization.md index f228264ab7..dba9c81362 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization.md +++ b/content/organizations/restricting-access-to-your-organizations-data/approving-oauth-apps-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'When an organization member requests {% data variables.product.prodname_ redirect_from: - /articles/approving-third-party-applications-for-your-organization/ - /articles/approving-oauth-apps-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/approving-oauth-apps-for-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md b/content/organizations/restricting-access-to-your-organizations-data/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md similarity index 88% rename from content/github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md rename to content/organizations/restricting-access-to-your-organizations-data/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md index f83e8694c7..fb80c402af 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md +++ b/content/organizations/restricting-access-to-your-organizations-data/denying-access-to-a-previously-approved-oauth-app-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'If an organization no longer requires a previously authorized {% data va redirect_from: - /articles/denying-access-to-a-previously-approved-application-for-your-organization/ - /articles/denying-access-to-a-previously-approved-oauth-app-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/denying-access-to-a-previously-approved-oauth-app-for-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization.md b/content/organizations/restricting-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md similarity index 92% rename from content/github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization.md rename to content/organizations/restricting-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md index 0cd8846027..7423d3ee76 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/organizations/restricting-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'Organization owners can disable restrictions on the {% data variables.pr redirect_from: - /articles/disabling-third-party-application-restrictions-for-your-organization/ - /articles/disabling-oauth-app-access-restrictions-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/disabling-oauth-app-access-restrictions-for-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization.md b/content/organizations/restricting-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md similarity index 95% rename from content/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization.md rename to content/organizations/restricting-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md index adc8f17827..67c0d8748a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/organizations/restricting-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'Organization owners can enable {% data variables.product.prodname_oauth_ redirect_from: - /articles/enabling-third-party-application-restrictions-for-your-organization/ - /articles/enabling-oauth-app-access-restrictions-for-your-organization + - /github/setting-up-and-managing-organizations-and-teams/enabling-oauth-app-access-restrictions-for-your-organization versions: free-pro-team: '*' topics: diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data.md b/content/organizations/restricting-access-to-your-organizations-data/index.md similarity index 55% rename from content/github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data.md rename to content/organizations/restricting-access-to-your-organizations-data/index.md index e85083f736..9cf976f93a 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data.md +++ b/content/organizations/restricting-access-to-your-organizations-data/index.md @@ -4,7 +4,7 @@ intro: '{% data variables.product.prodname_oauth_app %} access restrictions allo redirect_from: - /articles/restricting-access-to-your-organization-s-data - /articles/restricting-access-to-your-organizations-data -mapTopic: true + - /github/setting-up-and-managing-organizations-and-teams/restricting-access-to-your-organizations-data versions: free-pro-team: '*' topics: @@ -12,3 +12,8 @@ topics: - teams --- +{% link_in_list /about-oauth-app-access-restrictions %} +{% link_in_list /enabling-oauth-app-access-restrictions-for-your-organization %} +{% link_in_list /disabling-oauth-app-access-restrictions-for-your-organization %} +{% link_in_list /approving-oauth-apps-for-your-organization %} +{% link_in_list /denying-access-to-a-previously-approved-oauth-app-for-your-organization %} \ No newline at end of file diff --git a/content/packages/index.md b/content/packages/index.md index 14afebfca8..56deb1e548 100644 --- a/content/packages/index.md +++ b/content/packages/index.md @@ -20,15 +20,8 @@ featuredLinks: - /packages/guides/enabling-improved-container-support - /packages/guides/configuring-rubygems-for-use-with-github-packages changelog: - - title: ghcr.io maintenance mode on 2021-01-09 - date: '2021-01-08' - href: https://github.blog/changelog/2021-01-08-packages-ghcr-io-maintenance-mode-on-2021-01-09/ - - title: ghcr.io container names redirect to the container page - date: '2020-12-14' - href: https://github.blog/changelog/2020-12-14-ghcr-io-container-names-redirect-to-the-container-page/ - - title: Filter for tagged and untagged containers - date: '2020-12-14' - href: https://github.blog/changelog/2020-12-14-packages-can-filter-for-tagged-and-untagged-containers/ + label: 'packages' + prefix: 'Packages: ' redirect_from: - /github/managing-packages-with-github-packages - /categories/managing-packages-with-github-package-registry diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md index 72af61cf64..d2fb0c014b 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md @@ -24,7 +24,9 @@ topics: | Custom subdomain | `blog.example.com` | | Apex domain | `example.com` | -You can set up either or both types of custom domains for your site. We recommend always using a `www` subdomain, even if you also use an apex domain. For more information, see "[Using an apex domain for your {% data variables.product.prodname_pages %} site](#using-an-apex-domain-for-your-github-pages-site)." +You can set up either or both of apex and `www` subdomain configurations for your site. For more information on apex domains, see "[Using an apex domain for your {% data variables.product.prodname_pages %} site](#using-an-apex-domain-for-your-github-pages-site)." + +We recommend always using a `www` subdomain, even if you also use an apex domain. When you create a new site with an apex domain, we automatically attempt to secure the `www` subdomain for use when serving your site's content. If you configure a `www` subdomain, we automatically attempt to secure the associated apex domain. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." After you configure a custom domain for a user or organization site, the custom domain will replace the `.github.io` or `.github.io` portion of the URL for any project sites owned by the account that do not have a custom domain configured. For example, if the custom domain for your user site is `www.octocat.com`, and you have a project site with no custom domain configured that is published from a repository called `octo-project`, the {% data variables.product.prodname_pages %} site for that repository will be available at `www.octocat.com/octo-project`. @@ -38,11 +40,11 @@ Subdomains are configured with a `CNAME` record through your DNS provider. For m A `www` subdomain is the most commonly used type of subdomain. For example, `www.example.com` includes a `www` subdomain. -`www` subdomains are the most stable type of custom domain because `www` subdomains are not affected by changes to the IP addresses of {% data variables.product.product_name %}'s servers. Your site will also load faster because Denial of Service (DoS) attack protection can be implemented more efficiently. +`www` subdomains are the most stable type of custom domain because `www` subdomains are not affected by changes to the IP addresses of {% data variables.product.product_name %}'s servers. #### Custom subdomains -A custom subdomain is a type of subdomain that doesn't use the standard `www` subdomain. Custom subdomains are mostly used when you want two distinct sections of your site. For example, you can create a site called `blog.example.com` and customize that section independently from `www.example.com`. +A custom subdomain is a type of subdomain that doesn't use the standard `www` variant. Custom subdomains are mostly used when you want two distinct sections of your site. For example, you can create a site called `blog.example.com` and customize that section independently from `www.example.com`. ### Using an apex domain for your {% data variables.product.prodname_pages %} site diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index ca377939ad..e2410b488a 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -42,6 +42,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. This will create a commit that adds a _CNAME_ file in the root of your publishing source. ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) 5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} @@ -67,6 +68,7 @@ To set up an apex domain, such as `example.com`, you must configure a _CNAME_ fi {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. This will create a commit that adds a _CNAME_ file in the root of your publishing source. ![Save custom domain button](/assets/images/help/pages/save-custom-apex-domain.png) 5. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. {% data reusables.pages.contact-dns-provider %} @@ -92,6 +94,31 @@ To set up an apex domain, such as `example.com`, you must configure a _CNAME_ fi {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} +### Configuring an apex domain and the `www` subdomain variant + +When using an apex domain, we recommend configuring your {% data variables.product.prodname_pages %} site to host content at both the apex domain and that domain's `www` subdomain variant. + +To set up a `www` subdomain alongside the apex domain, you must first configure an apex domain, which will create an `ALIAS`, `ANAME`, or `A` record with your DNS provider. For more information, see "[Configuring an apex domain](#configuring-an-apex-domain)." + +After you configure the apex domain, you must to configure a CNAME record with your DNS provider. + +1. Navigate to your DNS provider and create a `CNAME` record that points `www.example.com` to the default domain for your site: `.github.io` or `.github.io`. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +2. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. +```shell + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM. IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . + > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 +``` +### Removing a custom domain + +{% data reusables.pages.navigate-site-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} +4. Under "Custom domain," click **Remove**. + ![Save custom domain button](/assets/images/help/pages/remove-custom-domain.png) + ### Further reading - "[Troubleshooting custom domains and {% data variables.product.prodname_pages %}](/articles/troubleshooting-custom-domains-and-github-pages)" diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 397ea410bf..9541ad885f 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -34,7 +34,7 @@ You can host your site on {% data variables.product.prodname_dotcom %}'s `github To get started, see "[Creating a {% data variables.product.prodname_pages %} site](/articles/creating-a-github-pages-site)." {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} -Organization owners can disable the publication of {% data variables.product.prodname_pages %} sites from the organization's repositories. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization)." +Organization owners can disable the publication of {% data variables.product.prodname_pages %} sites from the organization's repositories. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." {% endif %} ### Types of {% data variables.product.prodname_pages %} sites @@ -68,14 +68,6 @@ Project site owned by organization account | `http(s)://pages./.github.com` naming scheme will still be published, but visitors will be redirected from `http(s)://.github.com` to `http(s)://.github.io`. If both a `.github.com` and `.github.io` repository exist, only the `.github.io` repository will be published. - -{% endnote %} -{% endif %} - ### Publishing sources for {% data variables.product.prodname_pages %} sites The publishing source for your {% data variables.product.prodname_pages %} site is the branch and folder where the source files for your site are stored. diff --git a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md index 6bead340fa..a80468d753 100644 --- a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ b/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md @@ -32,6 +32,7 @@ If you manually added a Jekyll theme to your repository in the past, those files {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} 3. Under "{% data variables.product.prodname_pages %}," click **Choose a theme** or **Change theme**. ![Choose a theme button](/assets/images/help/pages/choose-a-theme.png) 4. On the top of the page, click the theme you want, then click **Select theme**. diff --git a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md index 8c35632340..c7197c7934 100644 --- a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md @@ -11,7 +11,7 @@ redirect_from: ### About access control for {% data variables.product.prodname_pages %} sites -If your project site is published from a private or internal repository that's owned by an organization using {% data variables.product.prodname_ghe_cloud %}, you can manage access control for the site. With access control, you can choose to publish the site publicly to anyone on the internet or privately to people with read access to your repository. A privately published site can be used to share your internal documentation or knowledge base with members of your enterprise. You cannot manage access control for an organization site. For more information about the types of {% data variables.product.prodname_pages %} sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)." +If your project site is published from a private or internal repository that's owned by an organization using {% data variables.product.prodname_ghe_cloud %}, you can manage access control for the site. With access control, you can choose to publish the site publicly to anyone on the internet or privately to people with read access to your repository. A privately published site can be used to share your internal documentation or knowledge base with members of your enterprise. You cannot manage access control for an organization site. For more information about the types of {% data variables.product.prodname_pages %} sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)." Privately published sites are available at a different subdomain than publicly published sites. This ensures that your {% data variables.product.prodname_pages %} site is secure from the moment it's published: @@ -26,6 +26,7 @@ To use a shorter and more memorable domain for your private {% data variables.pr {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} 3. Under "{% data variables.product.prodname_pages %}", select the **{% data variables.product.prodname_pages %} visibility** drop-down menu, then click a visibility. ![Drop-down to choose a visibility for your site](/assets/images/help/pages/public-or-private-visibility.png) 4. To see your published site, under "{% data variables.product.prodname_pages %}", click your site's URL. diff --git a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index 025a47ca71..290fb96e49 100644 --- a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -1,6 +1,6 @@ --- title: Configuring a publishing source for your GitHub Pages site -intro: 'If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your{% if currentVersion ver_lt "enterprise-server@2.23" %} project{% endif %} site from a different branch or folder.' +intro: 'If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your{% if currentVersion ver_lt "enterprise-server@3.0" %} project{% endif %} site from a different branch or folder.' redirect_from: - /articles/configuring-a-publishing-source-for-github-pages/ - /articles/configuring-a-publishing-source-for-your-github-pages-site @@ -19,18 +19,18 @@ For more information about publishing sources, see "[About {% data variables.pro ### Choosing a publishing source -Before you configure a publishing source, make sure the branch{% if currentVersion ver_lt "enterprise-server@2.23" %} or folder{% endif %} you want to use as your publishing source already exists in your repository.{% if currentVersion ver_lt "enterprise-server@2.23" %} For example, before you can publish your project site from the `/docs` folder on the `master` branch of your repository, you or a collaborator must create a `/docs` folder on the default `master` branch of your repository.{% endif %} +Before you configure a publishing source, make sure the branch{% if currentVersion ver_lt "enterprise-server@3.0" %} or folder{% endif %} you want to use as your publishing source already exists in your repository.{% if currentVersion ver_lt "enterprise-server@3.0" %} For example, before you can publish your project site from the `/docs` folder on the `master` branch of your repository, you or a collaborator must create a `/docs` folder on the default `master` branch of your repository.{% endif %} {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} 3. Under "{% data variables.product.prodname_pages %}", use the **None** or **Branch** drop-down menu and select a publishing source. ![Drop-down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) 4. Optionally, use the drop-down menu to select a folder for your publishing source. ![Drop-down menu to select a folder for publishing source](/assets/images/help/pages/publishing-source-folder-drop-down.png) 5. Click **Save**. - ![Button to save changes to publishing source settings](/assets/images/help/pages/publishing-source-save.png) - {% else %} + ![Button to save changes to publishing source settings](/assets/images/help/pages/publishing-source-save.png){% else %} 3. Under "{% data variables.product.prodname_pages %}", use the **Source** drop-down menu and select a publishing source. ![Drop down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) {% endif %} diff --git a/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index b73695c897..210304bba0 100644 --- a/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -41,7 +41,8 @@ topics: 3. If your chosen publishing source already exists, navigate to the publishing source. If your chosen publishing source doesn't exist, create the publishing source. 4. In the root of the publishing source, create a new file called `index.md` that contains the content you want to display on the main page of your site. {% data reusables.pages.configure-publishing-source %} -{% data reusables.repositories.sidebar-settings %}{% if currentVersion == "free-pro-team@latest" %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %}{% if currentVersion == "free-pro-team@latest" %} {% data reusables.pages.choose-visibility %}{% endif %} {% data reusables.pages.visit-site %} diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index d2f76f0be5..fb2b49901e 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -17,8 +17,6 @@ People with admin permissions for a repository can enforce HTTPS for a {% data v All {% data variables.product.prodname_pages %} sites, including sites that are correctly configured with a custom domain, support HTTPS and HTTPS enforcement. For more information about custom domains, see "[About custom domains and {% data variables.product.prodname_pages %}](/articles/about-custom-domains-and-github-pages)" and "[Troubleshooting custom domains and {% data variables.product.prodname_pages %}](/articles/troubleshooting-custom-domains-and-github-pages#https-errors)." -HTTPS enforcement is required for {% data variables.product.prodname_pages %} sites using a `github.io` domain that were created after June 15, 2016. If you created your site before June 15, 2016, you can manually enable HTTPS enforcement. - {% data reusables.pages.no_sensitive_data_pages %} {% data reusables.pages.private_pages_are_public_warning %} @@ -27,6 +25,7 @@ HTTPS enforcement is required for {% data variables.product.prodname_pages %} si {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} 3. Under "{% data variables.product.prodname_pages %}," select **Enforce HTTPS**. ![Enforce HTTPS checkbox](/assets/images/help/pages/enforce-https-checkbox.png) diff --git a/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md b/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md index a0c25eb0fc..496dbe75f9 100644 --- a/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md @@ -24,6 +24,7 @@ topics: 2. If a `gh-pages` branch exists in the repository, delete the `gh-pages` branch. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)." 3. If the `gh-pages` branch was your publishing source, {% if currentVersion == "free-pro-team@latest" %}skip to step 6{% else %}your site is now unpublished and you can skip the remaining steps{% endif %}. {% data reusables.repositories.sidebar-settings %} +{% data reusables.pages.sidebar-pages %} 5. Under "{% data variables.product.prodname_pages %}", use the **Source** drop-down menu and select **None.** ![Drop down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) {% data reusables.pages.update_your_dns_settings %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index 7a6e565e4f..b42ed0a38c 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -101,7 +101,9 @@ $ git remote add origin https://HOSTNAME/USER/REPOSITORY/issues`: ```shell -$ curl -i -H "Authorization: token {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghp_16C7e42F292c6912E7710c838347Ae178B4a"{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ +$ curl -i -H "Authorization: token {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}" \ {% data variables.product.api_url_pre %}/orgs/rails/issues ``` @@ -336,7 +336,7 @@ body to the `/issues` path underneath the repository in which we want to create the issue: ```shell -$ curl -i -H 'Authorization: token {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghp_16C7e42F292c6912E7710c838347Ae178B4a"{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}' \ +$ curl -i -H 'Authorization: token {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}ghp_16C7e42F292c6912E7710c838347Ae178B4a{% else %}5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4{% endif %}' \ $ -d '{ \ $ "title": "New logo", \ $ "body": "We should have one", \ diff --git a/content/rest/reference/enterprise-admin.md b/content/rest/reference/enterprise-admin.md index eca5f8f968..cd3ab0d575 100644 --- a/content/rest/reference/enterprise-admin.md +++ b/content/rest/reference/enterprise-admin.md @@ -103,7 +103,7 @@ The IdP must use `{% data variables.product.api_url_code %}/scim/v2/enterprises/ {% note %} -**Note:** The enterprise SCIM API is only available to enterprises on [{% data variables.product.prodname_ghe_cloud %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. For more information about SCIM, see "[About SCIM](/github/setting-up-and-managing-organizations-and-teams/about-scim)." +**Note:** The enterprise SCIM API is only available to enterprises on [{% data variables.product.prodname_ghe_cloud %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. For more information about SCIM, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." {% endnote %} diff --git a/content/rest/reference/git.md b/content/rest/reference/git.md index 19e1c541ad..60034e2a9c 100644 --- a/content/rest/reference/git.md +++ b/content/rest/reference/git.md @@ -20,7 +20,7 @@ The Git Database API gives you access to read and write raw Git objects to your ## Blobs A Git blob (binary large object) is the object type used to store the contents of each file in a repository. The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) -to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types). You can read more about the use of media types in the API [here](/rest/overview/media-types). +to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). You can read more about the use of media types in the API [here](/rest/overview/media-types). ### Custom media types for blobs diff --git a/content/rest/reference/migrations.md b/content/rest/reference/migrations.md index c75353316f..f7730ab50d 100644 --- a/content/rest/reference/migrations.md +++ b/content/rest/reference/migrations.md @@ -16,7 +16,7 @@ topics: ## Organization -The Migrations API is only available to authenticated organization owners. For more information, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." +The Migrations API is only available to authenticated organization owners. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." {% data variables.migrations.organization_migrations_intro %} diff --git a/content/rest/reference/scim.md b/content/rest/reference/scim.md index df50c65a89..58b0e286bc 100644 --- a/content/rest/reference/scim.md +++ b/content/rest/reference/scim.md @@ -14,7 +14,7 @@ The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provi {% note %} -**Note:** The SCIM API is available only to organizations on [{% data variables.product.prodname_ghe_cloud %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. For more information about SCIM, see "[About SCIM](/github/setting-up-and-managing-organizations-and-teams/about-scim)." +**Note:** The SCIM API is available only to organizations on [{% data variables.product.prodname_ghe_cloud %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. For more information about SCIM, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." {% endnote %} diff --git a/content/rest/reference/teams.md b/content/rest/reference/teams.md index 7f6b2a3bf4..d98f01e647 100644 --- a/content/rest/reference/teams.md +++ b/content/rest/reference/teams.md @@ -18,7 +18,7 @@ This API is only available to authenticated members of the team's [organization] ## Discussions -The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. +The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussions' %}{% include rest_operation %}{% endif %} @@ -26,7 +26,7 @@ The team discussions API allows you to get, create, edit, and delete discussion ## Discussion comments -The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions/)." This API is only available to authenticated members of the team's organization. +The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. {% for operation in currentRestOperations %} {% if operation.subcategory == 'discussion-comments' %}{% include rest_operation %}{% endif %} @@ -39,7 +39,7 @@ This API is only available to authenticated members of the team's organization. {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} {% note %} -**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." {% endnote %} @@ -54,7 +54,7 @@ This API is only available to authenticated members of the team's organization. The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups. To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." -You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." {% for operation in currentRestOperations %} {% if operation.subcategory == 'team-sync' %}{% include rest_operation %}{% endif %} diff --git a/data/products.yml b/data/products.yml deleted file mode 100644 index 913aae067b..0000000000 --- a/data/products.yml +++ /dev/null @@ -1,18 +0,0 @@ -# this sequence sets the product order in the sidebar -# the product IDs match keys in lib/all-products.js -# note this file should not be translated -productsInOrder: - - github - - admin - - discussions - - code-security - - actions - - packages - - developers - - rest - - graphql - - insights - - communities - - pages - - education - - desktop diff --git a/data/release-notes/2-21/19.yml b/data/release-notes/2-21/19.yml new file mode 100644 index 0000000000..58121049c3 --- /dev/null +++ b/data/release-notes/2-21/19.yml @@ -0,0 +1,17 @@ +date: '2021-04-14' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - 'A warning message `jq: error (at :0): Cannot index number with string "settings"` could occur during replica promotion.' + - Visiting the `/settings/emails` page would store state that could cause improper redirects when logging out and logging back in. + - Dependency graph alerts weren't shown for some components whose advisories have upper case package names in `vulnerable_version_ranges`. + - User saw 500 error when executing git operations on an instance configured with LDAP authentication. + - When ghe-migrator encountered import errors, it would sometimes abort the entire process, and the logs did not include enough context. + known_issues: + - On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. + - Custom firewall rules are not maintained during an upgrade. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - Security alerts are not reported when pushing to a repository on the command line. diff --git a/data/release-notes/2-22/11.yml b/data/release-notes/2-22/11.yml new file mode 100644 index 0000000000..91e3878923 --- /dev/null +++ b/data/release-notes/2-22/11.yml @@ -0,0 +1,18 @@ +date: '2021-04-14' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - 'A warning message `jq: error (at :0): Cannot index number with string "settings"` could occur during replica promotion.' + - Continuously restoring backups to a cluster could fail due to MySQL replicas failing to connect to the primary. + - Syntax highlighting could fail due to the Treelights container running out of memory. + - Visiting the `/settings/emails` page would store state that could cause improper redirects when logging out and logging back in. + - Dependency graph alerts weren't shown for some components whose advisories have upper case package names in `vulnerable_version_ranges`. + - GitHub integration apps were not able to notify teams when mentioned directly via an at-mention in an issue comment. + - When ghe-migrator encountered import errors, it would sometimes abort the entire process, and the logs did not include enough context. + known_issues: + - On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. + - Custom firewall rules are not maintained during an upgrade. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. diff --git a/data/release-notes/3-0/0.yml b/data/release-notes/3-0/0.yml index dbab40a44b..76c607039f 100644 --- a/data/release-notes/3-0/0.yml +++ b/data/release-notes/3-0/0.yml @@ -132,6 +132,7 @@ sections: - A race condition can cause dependency graph database migrations to appear to fail. - Instances with a custom timezone that were upgraded from an earlier release of GitHub Enterprise Server may have incorrect timestamps in the web UI. - Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`). + - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. deprecations: - heading: Deprecation of GitHub Enterprise Server 2.19 diff --git a/data/release-notes/3-0/1.yml b/data/release-notes/3-0/1.yml index c78862e536..a6cdaaada6 100644 --- a/data/release-notes/3-0/1.yml +++ b/data/release-notes/3-0/1.yml @@ -44,6 +44,7 @@ sections: - 'Dependency graph fails to parse `yarn.lock` Javascript manifest files, resulting in HTTP 500 errors in logs.' - 'Instances with a custom timezone that were upgraded from an earlier release of GitHub Enterprise Server may have incorrect timestamps in the web UI.' - 'Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`).' + - 'When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds.' - | Users may experience assets such as avatars not loading, or a failure to push/pull code. This may be caused by a PID mismatch in the `haproxy-cluster-proxy` service. To determine if you have an affected instance: diff --git a/data/release-notes/3-0/2.yml b/data/release-notes/3-0/2.yml index 266143486d..e6bda3f22f 100644 --- a/data/release-notes/3-0/2.yml +++ b/data/release-notes/3-0/2.yml @@ -30,6 +30,7 @@ sections: - Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters. - reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text. - Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`). + - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. - | Users may experience assets such as avatars not loading, or a failure to push/pull code. This may be caused by a PID mismatch in the `haproxy-cluster-proxy` service. To determine if you have an affected instance: diff --git a/data/release-notes/3-0/3.yml b/data/release-notes/3-0/3.yml index 09b90b287c..952e61c7b0 100644 --- a/data/release-notes/3-0/3.yml +++ b/data/release-notes/3-0/3.yml @@ -29,6 +29,7 @@ sections: - Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters. - reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text. - Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`). + - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. - | Log rotation may fail to signal services to transition to new log files, leading to older log files continuing to be used, and eventual root disk space exhaustion. To remedy and/or prevent this issue, run the following commands in the [administrative shell](https://docs.github.com/en/enterprise-server/admin/configuration/accessing-the-administrative-shell-ssh) (SSH), or contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/) for assistance: diff --git a/data/release-notes/3-0/4.yml b/data/release-notes/3-0/4.yml index dbd4727201..1f0a4162f2 100644 --- a/data/release-notes/3-0/4.yml +++ b/data/release-notes/3-0/4.yml @@ -22,3 +22,4 @@ sections: - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. - Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters. - reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text. + - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. diff --git a/data/release-notes/3-0/5.yml b/data/release-notes/3-0/5.yml new file mode 100644 index 0000000000..a51075e523 --- /dev/null +++ b/data/release-notes/3-0/5.yml @@ -0,0 +1,26 @@ +date: '2021-04-14' +intro: The minimum infrastructure requirements have increased for {% data variables.product.prodname_ghe_server %} 3.0+. For more information, see "[About minimum requirements for GitHub Enterprise Server 3.0 and later](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)." +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - Some logs were not included in the log forwarding configuration. + - 'A warning message `jq: error (at :0): Cannot index number with string "settings"` could occur during replica promotion.' + - Continuously restoring backups to a cluster could fail due to MySQL replicas failing to connect to the primary. + - Pages were not getting published when using custom CA certificate. + - Packages related subdomains were not showing up in the "Test domain settings" prompt for subdomain isolation. + - The `X-GitHub-Enterprise-Host` header sent with webhooks included a random string, rather than the hostname of the GitHub Enterprise Server instance that sent the HTTP POST payload. + - Upgrading from 2.22.x to 3.0.x would fail if GitHub Actions had previously been enabled, but disabled before the upgrade. + - Visiting the `/settings/emails` page would store state that could cause improper redirects when logging out and logging back in. + - GitHub integration apps were not able to notify teams when mentioned directly via an at-mention in an issue comment. + - reStructuredText (RST) rendering in the web UI would fail and instead displayed raw RST markup text. + - Email notifications for Secret Scanning alerts were not sent to authorized users when the Dependency Graph was not fully enabled. + - When ghe-migrator encountered import errors, it would sometimes abort the entire process, and the logs did not include enough context. + - Jupyter notebooks with non-ASCII characters could fail to render. + known_issues: + - On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. + - Custom firewall rules are not maintained during an upgrade. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. diff --git a/data/reusables/actions/actions-audit-events-workflow.md b/data/reusables/actions/actions-audit-events-workflow.md index 612ea4fca1..3140c370cc 100644 --- a/data/reusables/actions/actions-audit-events-workflow.md +++ b/data/reusables/actions/actions-audit-events-workflow.md @@ -4,5 +4,7 @@ | `completed_workflow_run` | Triggered when a workflow status changes to `completed`. Can only be viewed using the REST API; not visible in the UI or the JSON/CSV export. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." | `created_workflow_run` | Triggered when a workflow run is created. Can only be viewed using the REST API; not visible in the UI or the JSON/CSV export. For more information, see "[Create an example workflow](/actions/learn-github-actions/introduction-to-github-actions#create-an-example-workflow)." | `delete_workflow_run` | Triggered when a workflow run is deleted. For more information, see "[Deleting a workflow run](/actions/managing-workflow-runs/deleting-a-workflow-run)." +| `disable_workflow` | Triggered when a workflow is disabled. +| `enable_workflow` | Triggered when a workflow is enabled, after previously being disabled by `disable_workflow`. | `rerun_workflow_run` | Triggered when a workflow run is re-run. For more information, see "[Re-running a workflow](/actions/managing-workflow-runs/re-running-a-workflow)." | `prepared_workflow_job` | Triggered when a workflow job is started. Includes the list of secrets that were provided to the job. Can only be viewed using the REST API; not visible in the UI or the JSON/CSV export. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." diff --git a/data/reusables/actions/actions-cli.md b/data/reusables/actions/actions-cli.md new file mode 100644 index 0000000000..9de328800e --- /dev/null +++ b/data/reusables/actions/actions-cli.md @@ -0,0 +1 @@ +For information on setting up {% data variables.product.prodname_cli %}, see "[Managing GitHub Actions with GitHub CLI](/actions/guides/managing-github-actions-with-github-cli#setting-up-github-cli)." diff --git a/data/reusables/actions/enterprise-github-connect-warning.md b/data/reusables/actions/enterprise-github-connect-warning.md new file mode 100644 index 0000000000..ce755253ef --- /dev/null +++ b/data/reusables/actions/enterprise-github-connect-warning.md @@ -0,0 +1,7 @@ +{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} +{% note %} + +**Note:** With {% data variables.product.prodname_github_connect %} enabled, {% data variables.product.prodname_actions %} will try to find the repository on your {% data variables.product.prodname_ghe_server %} instance first before falling back to {% data variables.product.prodname_dotcom %}. If a user creates an organization and repository in your enterprise that matches an organization and repository name on {% data variables.product.prodname_dotcom %}, the repository on your enterprise will be used in place of the {% data variables.product.prodname_dotcom %} repository. A malicious user could take advantage of this behavior to run code as part of a workflow. + +{% endnote %} +{% endif %} diff --git a/data/reusables/actions/enterprise-no-internet-actions.md b/data/reusables/actions/enterprise-no-internet-actions.md index 9f2287cfee..e568edbd05 100644 --- a/data/reusables/actions/enterprise-no-internet-actions.md +++ b/data/reusables/actions/enterprise-no-internet-actions.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} is designed to work in environments without internet access. By default, workflows cannot use actions from {% data variables.product.prodname_dotcom_the_website %} and [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). +{% data variables.product.prodname_actions %} on {% data variables.product.product_name %} is designed to work in environments without full internet access. By default, workflows cannot use actions from {% data variables.product.prodname_dotcom_the_website %} and [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). diff --git a/data/reusables/advanced-security/about-ghas-organization-policy.md b/data/reusables/advanced-security/about-ghas-organization-policy.md index baa32fddac..b6abfe68c7 100644 --- a/data/reusables/advanced-security/about-ghas-organization-policy.md +++ b/data/reusables/advanced-security/about-ghas-organization-policy.md @@ -2,4 +2,4 @@ You can enforce a policy that controls whether repository administrators are allowed to enable features for {% data variables.product.prodname_advanced_security %} in an organization's repositories. You can configure a policy for all organizations owned by your enterprise account, or for individual organizations that you choose. -Disallowing {% data variables.product.prodname_advanced_security %} for an organization prevents repository administrators from enabling {% data variables.product.prodname_advanced_security %} features for additional repositories, but does not disable the features for repositories where the features are already enabled. For more information about configuration of {% data variables.product.prodname_advanced_security %} features, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +Disallowing {% data variables.product.prodname_advanced_security %} for an organization prevents repository administrators from enabling {% data variables.product.prodname_advanced_security %} features for additional repositories, but does not disable the features for repositories where the features are already enabled. For more information about configuration of {% data variables.product.prodname_advanced_security %} features, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." diff --git a/data/reusables/branches/set-default-branch.md b/data/reusables/branches/set-default-branch.md index 20d94881f6..61c5fb0903 100644 --- a/data/reusables/branches/set-default-branch.md +++ b/data/reusables/branches/set-default-branch.md @@ -1 +1 @@ -You can set the name of the default branch for new repositories. For more information, see "[Managing the default branch for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)," "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)," and {% if currentVersion == "free-pro-team@latest" %}"[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-the-default-branch-name)."{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)."{% endif %} +You can set the name of the default branch for new repositories. For more information, see "[Managing the default branch for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)," "[Managing the default branch name for repositories in your organization](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)," and {% if currentVersion == "free-pro-team@latest" %}"[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-the-default-branch-name)."{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)."{% endif %} diff --git a/data/reusables/classroom/assignments-guide-choose-visibility.md b/data/reusables/classroom/assignments-guide-choose-visibility.md index 3f4f17e1b2..303bb3669b 100644 --- a/data/reusables/classroom/assignments-guide-choose-visibility.md +++ b/data/reusables/classroom/assignments-guide-choose-visibility.md @@ -1,6 +1,6 @@ The repositories for an assignment can be public or private. If you use private repositories, only the student or team can see the feedback you provide. -You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" and "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)." +You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" and "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." Under "Repository visibility", select a visibility. Optionally, select **Grant students admin access to their repository**. diff --git a/data/reusables/classroom/guide-create-new-classroom.md b/data/reusables/classroom/guide-create-new-classroom.md index 1ce37f9c07..9963eb960b 100644 --- a/data/reusables/classroom/guide-create-new-classroom.md +++ b/data/reusables/classroom/guide-create-new-classroom.md @@ -1,4 +1,4 @@ -1. In the list of organizations, click the organization you'd like to use for your classroom. Optionally, you can create a new organization. For more information, see "[Creating a new organization from scratch](/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch)." +1. In the list of organizations, click the organization you'd like to use for your classroom. Optionally, you can create a new organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." ![Organization in list of organizations for creating new classroom](/assets/images/help/classroom/click-organization.png) 1. Type the name for your classroom. ![Text field for typing name of classroom](/assets/images/help/classroom/type-classroom-name.png) diff --git a/data/reusables/cli/actions-cli-version.md b/data/reusables/cli/actions-cli-version.md new file mode 100644 index 0000000000..83cd5971dd --- /dev/null +++ b/data/reusables/cli/actions-cli-version.md @@ -0,0 +1 @@ +To access all of the {% data variables.product.prodname_actions %}-related commands, you must use version 1.9.0 or greater. diff --git a/data/reusables/cli/cli-auth.md b/data/reusables/cli/cli-auth.md new file mode 100644 index 0000000000..be9a823c3c --- /dev/null +++ b/data/reusables/cli/cli-auth.md @@ -0,0 +1 @@ +{% data variables.product.prodname_cli %} can authenticate using your {% data variables.product.prodname_dotcom %} account. Before running {% data variables.product.prodname_cli %} commands, you will need to authenticate by running `gh auth login`. For more information on command line authentication, see "[`gh auth login`](https://cli.github.com/manual/gh_auth_login)." diff --git a/data/reusables/cli/cli-manual.md b/data/reusables/cli/cli-manual.md new file mode 100644 index 0000000000..dd2012d873 --- /dev/null +++ b/data/reusables/cli/cli-manual.md @@ -0,0 +1 @@ +For more information about {% data variables.product.prodname_cli %}, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/). \ No newline at end of file diff --git a/data/reusables/cli/cli-repo.md b/data/reusables/cli/cli-repo.md new file mode 100644 index 0000000000..535b1d8e8c --- /dev/null +++ b/data/reusables/cli/cli-repo.md @@ -0,0 +1 @@ +{% data variables.product.prodname_cli %} commands must be run within the repository that you want to interact with, so you must first navigate to the directory containing the local copy of your repository. Alternatively, you can specify a repository by passing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}`-R HOSTNAME/OWNER/REPOSITORY` or `--repo HOSTNAME/OWNER/REPOSITORY`{% else %}`-R OWNER/REPOSITORY` or `--repo OWNER/REPOSITORY`{% endif %}. {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}Replace `HOSTNAME` with the name of {% data variables.product.product_location %}. {% endif %}Replace `OWNER` with owner of the repository. Replace `REPOSITORY` with the name of the repository. diff --git a/data/reusables/cli/download-update-cli.md b/data/reusables/cli/download-update-cli.md new file mode 100644 index 0000000000..b26363cf45 --- /dev/null +++ b/data/reusables/cli/download-update-cli.md @@ -0,0 +1 @@ +To download or upgrade {% data variables.product.prodname_cli %}, follow the instructions in the [{% data variables.product.prodname_cli %} README](https://github.com/cli/cli#installation). \ No newline at end of file diff --git a/data/reusables/code-scanning/upload-sarif-alert-limit.md b/data/reusables/code-scanning/upload-sarif-alert-limit.md index c5142332f6..6881be29fa 100644 --- a/data/reusables/code-scanning/upload-sarif-alert-limit.md +++ b/data/reusables/code-scanning/upload-sarif-alert-limit.md @@ -1,5 +1,5 @@ {% note %} -**Note:** SARIF upload supports a maximum of 1000 results per upload. Any results over this limit are ignored. If a tool generates too many results, you should update the configuration to focus on results for the most important rules or queries. +**Note:** SARIF upload supports a maximum of {% if currentVersion == "github-ae@next" or currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}5000{% else %}1000{% endif %} results per upload. Any results over this limit are ignored. If a tool generates too many results, you should update the configuration to focus on results for the most important rules or queries. {% endnote %} diff --git a/data/reusables/codespaces/about-port-forwarding.md b/data/reusables/codespaces/about-port-forwarding.md new file mode 100644 index 0000000000..39b29dc4a0 --- /dev/null +++ b/data/reusables/codespaces/about-port-forwarding.md @@ -0,0 +1 @@ +You can forward ports in your codespace to test and debug your application. \ No newline at end of file diff --git a/data/reusables/codespaces/apply-devcontainer-changes.md b/data/reusables/codespaces/apply-devcontainer-changes.md new file mode 100644 index 0000000000..8031bfb4af --- /dev/null +++ b/data/reusables/codespaces/apply-devcontainer-changes.md @@ -0,0 +1 @@ +After the {% data variables.product.prodname_codespaces %} configuration for a repository changes, you can apply the changes to an existing codespace by rebuilding the container for the codespace. \ No newline at end of file diff --git a/data/reusables/codespaces/navigate-to-ports-tab.md b/data/reusables/codespaces/navigate-to-ports-tab.md new file mode 100644 index 0000000000..823e982520 --- /dev/null +++ b/data/reusables/codespaces/navigate-to-ports-tab.md @@ -0,0 +1,2 @@ +1. In your codespace, under the text editor, click "Ports". + ![Ports tab](/assets/images/help/codespaces/ports-tab.png) diff --git a/data/reusables/codespaces/rebuild-command.md b/data/reusables/codespaces/rebuild-command.md new file mode 100644 index 0000000000..ea9e45b032 --- /dev/null +++ b/data/reusables/codespaces/rebuild-command.md @@ -0,0 +1 @@ +Access the command palette (`shift command P` / `shift control P`), then start typing "Codespaces: Rebuild Container". Click **Codespaces: Rebuild Container**. \ No newline at end of file diff --git a/data/reusables/codespaces/recovery-mode.md b/data/reusables/codespaces/recovery-mode.md new file mode 100644 index 0000000000..fa4e73d013 --- /dev/null +++ b/data/reusables/codespaces/recovery-mode.md @@ -0,0 +1 @@ +If changes to your codespace's configuration cause a container error, your codespace will run in recovery mode, and you will see an error message. \ No newline at end of file diff --git a/data/reusables/codespaces/type-port-label.md b/data/reusables/codespaces/type-port-label.md new file mode 100644 index 0000000000..9d22b45e92 --- /dev/null +++ b/data/reusables/codespaces/type-port-label.md @@ -0,0 +1,2 @@ +1. Type a label for your port, then press enter. + ![Text box to type label for port](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/data/reusables/dependabot/private-dependencies-note.md b/data/reusables/dependabot/private-dependencies-note.md index 7dd8f996d0..c3b22f4515 100644 --- a/data/reusables/dependabot/private-dependencies-note.md +++ b/data/reusables/dependabot/private-dependencies-note.md @@ -1 +1 @@ -When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, {% data variables.product.prodname_dependabot %} must be able to access the location at which those dependencies are hosted. Organization owners can grant {% data variables.product.prodname_dependabot %} access to private repositories containing dependencies for a project within the same organization. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)." You can configure access to private registries in a repository's _dependabot.yml_ configuration file. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." +When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, {% data variables.product.prodname_dependabot %} must be able to access the location at which those dependencies are hosted. Organization owners can grant {% data variables.product.prodname_dependabot %} access to private repositories containing dependencies for a project within the same organization. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)." You can configure access to private registries in a repository's _dependabot.yml_ configuration file. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." diff --git a/data/reusables/gated-features/actions-shared.md b/data/reusables/gated-features/actions-shared.md index d5bceb9ab1..1b9eb6926d 100644 --- a/data/reusables/gated-features/actions-shared.md +++ b/data/reusables/gated-features/actions-shared.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %}, {% data variables.product.prodname_ghe_one %}, and {% data variables.product.prodname_ghe_managed %}. {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. +{% data variables.product.prodname_actions %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %}, and {% data variables.product.prodname_ghe_managed %}. {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. diff --git a/data/reusables/gated-features/ghas.md b/data/reusables/gated-features/ghas.md index fcf1b455c7..166bbffcbe 100644 --- a/data/reusables/gated-features/ghas.md +++ b/data/reusables/gated-features/ghas.md @@ -1 +1 @@ -{% data variables.product.prodname_GH_advanced_security %} licenses are available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}{% if currentVersion == "github-ae@latest" %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_GH_advanced_security %} is also included in {% data variables.product.prodname_ghe_one %}{% if currentVersion == "free-pro-team@latest" %} and in all public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see "[About GitHub's products](/github/getting-started-with-github/githubs-products)." \ No newline at end of file +{% data variables.product.prodname_GH_advanced_security %} licenses are available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}{% if currentVersion == "github-ae@latest" %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_GH_advanced_security %} is also included in all public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see "[About GitHub's products](/github/getting-started-with-github/githubs-products)." \ No newline at end of file diff --git a/data/reusables/gated-features/github-insights.md b/data/reusables/gated-features/github-insights.md index f99859ae15..fb6b9703b2 100644 --- a/data/reusables/gated-features/github-insights.md +++ b/data/reusables/gated-features/github-insights.md @@ -1 +1 @@ -{% data variables.product.prodname_insights %} is available with {% data variables.product.prodname_ghe_one %}. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/githubs-products)." +{% data variables.product.prodname_insights %} is available with {% data variables.product.prodname_ghe_one %}. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/githubs-products)." \ No newline at end of file diff --git a/data/reusables/gated-features/packages.md b/data/reusables/gated-features/packages.md index e0cfb66045..7007042e33 100644 --- a/data/reusables/gated-features/packages.md +++ b/data/reusables/gated-features/packages.md @@ -1,4 +1,4 @@ -{% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 2.22, {% data variables.product.prodname_ghe_one %}, and {% data variables.product.prodname_ghe_managed %}. +{% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 2.22, and {% data variables.product.prodname_ghe_managed %}. {% if currentVersion == "free-pro-team@latest" %}
    {% data variables.product.prodname_registry %} is not available for private repositories owned by accounts using legacy per-repository plans. Also, accounts using legacy per-repository plans cannot access {% data variables.product.prodname_github_container_registry %} since these accounts are billed by repository. {% data reusables.gated-features.more-info %} {% endif %} diff --git a/data/reusables/identity-and-permissions/revoking-identity-team-sync.md b/data/reusables/identity-and-permissions/revoking-identity-team-sync.md index b2c935e893..046848b19c 100644 --- a/data/reusables/identity-and-permissions/revoking-identity-team-sync.md +++ b/data/reusables/identity-and-permissions/revoking-identity-team-sync.md @@ -1,5 +1,5 @@ {% warning %} -**Warning:** If your organization uses team synchronization, revoking a person's SSO identity will remove that person from any teams mapped to IdP groups. For more information, see "[Synchronizing a team with an identity provider](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." +**Warning:** If your organization uses team synchronization, revoking a person's SSO identity will remove that person from any teams mapped to IdP groups. For more information, see "[Synchronizing a team with an identity provider](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." {% endwarning %} diff --git a/data/reusables/identity-and-permissions/sync-team-with-idp-group.md b/data/reusables/identity-and-permissions/sync-team-with-idp-group.md index 125c285ead..0b4022951d 100644 --- a/data/reusables/identity-and-permissions/sync-team-with-idp-group.md +++ b/data/reusables/identity-and-permissions/sync-team-with-idp-group.md @@ -1 +1 @@ -After you enable team synchronization, team maintainers and organization owners can connect a team to an IdP group on {% data variables.product.prodname_dotcom %} or through the API. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)" and "[Team synchronization](/rest/reference/teams#team-sync)." +After you enable team synchronization, team maintainers and organization owners can connect a team to an IdP group on {% data variables.product.prodname_dotcom %} or through the API. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)" and "[Team synchronization](/rest/reference/teams#team-sync)." diff --git a/data/reusables/identity-and-permissions/team-sync-confirm-saml.md b/data/reusables/identity-and-permissions/team-sync-confirm-saml.md index a0e1a12947..3ebd07b725 100644 --- a/data/reusables/identity-and-permissions/team-sync-confirm-saml.md +++ b/data/reusables/identity-and-permissions/team-sync-confirm-saml.md @@ -1 +1 @@ -3. Confirm that SAML SSO is enabled. For more information, see "[Managing SAML single sign-on for your organization](/articles/managing-saml-single-sign-on-for-your-organization)." +3. Confirm that SAML SSO is enabled. For more information, see "[Managing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/)." diff --git a/data/reusables/identity-and-permissions/team-sync-okta-requirements.md b/data/reusables/identity-and-permissions/team-sync-okta-requirements.md index f8ebbf4246..08aa1fad59 100644 --- a/data/reusables/identity-and-permissions/team-sync-okta-requirements.md +++ b/data/reusables/identity-and-permissions/team-sync-okta-requirements.md @@ -1,5 +1,5 @@ To enable team synchronization for Okta, you or your IdP administrator must: -- Enable SAML SSO and SCIM for your organization using Okta. For more information, see "[Configuring SAML single sign-on and SCIM using Okta](/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta)." +- Enable SAML SSO and SCIM for your organization using Okta. For more information, see "[Configuring SAML single sign-on and SCIM using Okta](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)." - Provide the tenant URL for your Okta instance. - Generate a valid SSWS token with read-only admin permissions for your Okta installation as a service user. For more information, see [Create the token](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/) and [Service users](https://help.okta.com/en/prod/Content/Topics/Adv_Server_Access/docs/service-users.htm) in Okta's documentation. diff --git a/data/reusables/organizations/team-discussions-are-for-orgs.md b/data/reusables/organizations/team-discussions-are-for-orgs.md index cb0f53f8ed..656bb6a3b7 100644 --- a/data/reusables/organizations/team-discussions-are-for-orgs.md +++ b/data/reusables/organizations/team-discussions-are-for-orgs.md @@ -1 +1 @@ -Team discussions are only available on team pages in organizations. For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." +Team discussions are only available on team pages in organizations. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." diff --git a/data/reusables/organizations/team-synchronization.md b/data/reusables/organizations/team-synchronization.md index a609ef11b9..94743620fb 100644 --- a/data/reusables/organizations/team-synchronization.md +++ b/data/reusables/organizations/team-synchronization.md @@ -1,3 +1,3 @@ {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} -You can use team synchronization to automatically add and remove organization members to teams through an identity provider. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." +You can use team synchronization to automatically add and remove organization members to teams through an identity provider. For more information, see "[Synchronizing a team with an identity provider group](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." {% endif %} diff --git a/data/reusables/organizations/team_maintainers_can.md b/data/reusables/organizations/team_maintainers_can.md index 586a4657f5..8c68c29077 100644 --- a/data/reusables/organizations/team_maintainers_can.md +++ b/data/reusables/organizations/team_maintainers_can.md @@ -11,5 +11,5 @@ Members with team maintainer permissions can: - [Remove organization members from the team](/articles/removing-organization-members-from-a-team) - [Promote an existing team member to team maintainer](/articles/giving-team-maintainer-permissions-to-an-organization-member) - Remove the team's access to repositories{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} -- [Manage code review assignment for the team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team){% endif %}{% if currentVersion == "free-pro-team@latest" %} +- [Manage code review assignment for the team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team){% endif %}{% if currentVersion == "free-pro-team@latest" %} - [Manage scheduled reminders for pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests){% endif %} diff --git a/data/reusables/pages/org-owners-can-restrict-pages-creation.md b/data/reusables/pages/org-owners-can-restrict-pages-creation.md index fc98787aaa..26d5ca7f58 100644 --- a/data/reusables/pages/org-owners-can-restrict-pages-creation.md +++ b/data/reusables/pages/org-owners-can-restrict-pages-creation.md @@ -1,7 +1,7 @@ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} {% note %} -**Note:** Organization owners can restrict the publication of {% data variables.product.prodname_pages %} sites from repositories owned by the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization)." +**Note:** Organization owners can restrict the publication of {% data variables.product.prodname_pages %} sites from repositories owned by the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." {% endnote %} {% endif %} \ No newline at end of file diff --git a/data/reusables/pages/sidebar-pages.md b/data/reusables/pages/sidebar-pages.md new file mode 100644 index 0000000000..ee091cff7a --- /dev/null +++ b/data/reusables/pages/sidebar-pages.md @@ -0,0 +1,4 @@ +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %} +1. In the left sidebar, click **Pages**. + ![Page tab in the left-hand sidebar](/assets/images/help/pages/pages-tab.png) +{% endif %} diff --git a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 979cf68329..3dc1d84355 100644 --- a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -6,6 +6,6 @@ - When [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} - You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -- People with admin permissions to a private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %} repository in an organization. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)" and "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." +- People with admin permissions to a private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %} repository in an organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)." {% endwarning %} diff --git a/data/reusables/repositories/sidebar-dependabot-alerts.md b/data/reusables/repositories/sidebar-dependabot-alerts.md index 30ce19c2e0..f33de0eb09 100644 --- a/data/reusables/repositories/sidebar-dependabot-alerts.md +++ b/data/reusables/repositories/sidebar-dependabot-alerts.md @@ -1,2 +1,2 @@ -1. In the security sidebar, click **{% data variables.product.prodname_dependabot_alerts %}**. -![{% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/help/repository/dependabot-alerts-tab.png) +1. In the security sidebar, click **{% data variables.product.prodname_dependabot_alerts %}**.{% if currentVersion == "free-pro-team@latest" %} +![{% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/help/repository/dependabot-alerts-tab.png){% elsif %}![{% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/repository/dependabot-alerts-tab.png){% endif %} diff --git a/data/reusables/saml/about-linked-identities.md b/data/reusables/saml/about-linked-identities.md index 4f489081c2..f879d16402 100644 --- a/data/reusables/saml/about-linked-identities.md +++ b/data/reusables/saml/about-linked-identities.md @@ -1,3 +1,3 @@ -You can view the single sign-on identity that a member has linked to their {% data variables.product.product_name %} account. When available, the entry will include SCIM data. For more information, see "[About SCIM](/github/setting-up-and-managing-organizations-and-teams/about-scim)." +You can view the single sign-on identity that a member has linked to their {% data variables.product.product_name %} account. When available, the entry will include SCIM data. For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." If a member links the wrong identity to their {% data variables.product.product_name %} account, you can revoke the linked identity to allow the member to try again. diff --git a/data/reusables/saml/outside-collaborators-exemption.md b/data/reusables/saml/outside-collaborators-exemption.md index f2936af1c5..598f6e88d5 100644 --- a/data/reusables/saml/outside-collaborators-exemption.md +++ b/data/reusables/saml/outside-collaborators-exemption.md @@ -1,5 +1,5 @@ {% note %} -**Note:** Outside collaborators aren't required to authenticate with an IdP to access the resources in an organization with SAML SSO. For more information on outside collaborators, see "[Permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization#outside-collaborators)." +**Note:** Outside collaborators aren't required to authenticate with an IdP to access the resources in an organization with SAML SSO. For more information on outside collaborators, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization#outside-collaborators)." {% endnote %} diff --git a/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/data/reusables/secret-scanning/partner-secret-list-public-repo.md index 0577b865d9..ee88485460 100644 --- a/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -50,8 +50,10 @@ Proctorio | Proctorio Registration Key Proctorio | Proctorio Secret Key Pulumi | Pulumi Access Token PyPI | PyPI API Token +RubyGems | RubyGems API Key Samsara | Samsara API Token Samsara | Samsara OAuth Access Token +SendGrid | SendGrid API Key Shopify | Shopify App Shared Secret Shopify | Shopify Access Token Shopify | Shopify Custom App Access Token diff --git a/data/reusables/security-advisory/link-browsing-advisory-db.md b/data/reusables/security-advisory/link-browsing-advisory-db.md new file mode 100644 index 0000000000..ecb8f968d6 --- /dev/null +++ b/data/reusables/security-advisory/link-browsing-advisory-db.md @@ -0,0 +1,5 @@ +{% if currentVersion == "free-pro-team@latest" %} +For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)." +{% else %} +For more information about advisory data, see "Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}." +{% endif %} diff --git a/data/reusables/sponsors/choose-updates.md b/data/reusables/sponsors/choose-updates.md index 0fbb1010cf..1ae0dfee60 100644 --- a/data/reusables/sponsors/choose-updates.md +++ b/data/reusables/sponsors/choose-updates.md @@ -1,2 +1,2 @@ -4. Decide whether you want to receive email updates from the sponsored account, then select or unselect "Receive updates from _ACCOUNT_." +4. Decide whether you want to receive email updates from the sponsored account, then select or unselect "Receive email updates from _ACCOUNT_." ![Checkbox to receive updates from sponsored account](/assets/images/help/sponsors/updates-checkbox-manage.png) diff --git a/data/reusables/sponsors/click-add-tier.md b/data/reusables/sponsors/click-add-tier.md index 8bc0f4cff0..3704234aef 100644 --- a/data/reusables/sponsors/click-add-tier.md +++ b/data/reusables/sponsors/click-add-tier.md @@ -1,2 +1,2 @@ -1. On the bottom of the page, click **Add a tier**. +1. To create a monthly tier, click **Add a monthly tier** at the right of the page. Alternatively, to create a tier for one-time payments, click **One-time tiers** and then click **Add a one-time tier**. ![Add a tier button](/assets/images/help/sponsors/add-a-tier-button.png) diff --git a/data/reusables/sponsors/enable-custom-amounts.md b/data/reusables/sponsors/enable-custom-amounts.md new file mode 100644 index 0000000000..fd2a459a7c --- /dev/null +++ b/data/reusables/sponsors/enable-custom-amounts.md @@ -0,0 +1,4 @@ +1. When you have at least one tier, you'll see an option to enable custom amounts above the monthly and one-time tiers. If you want to allow sponsors to set their payment amount, then select **Enable custom amounts**. + ![Enable custom amounts](/assets/images/help/sponsors/enable-custom-amounts.png) +1. Optionally, if you enable custom amounts you can set a default amount to display for the custom tiers. Specify a whole dollar amount and click **Set default amount**. + ![Set a default amount](/assets/images/help/sponsors/set-default-amount.png) diff --git a/data/reusables/sponsors/feedback.md b/data/reusables/sponsors/feedback.md new file mode 100644 index 0000000000..44c1bb7d3f --- /dev/null +++ b/data/reusables/sponsors/feedback.md @@ -0,0 +1 @@ +You can share your feedback about {% data variables.product.prodname_sponsors %} with {% data variables.product.company_short %}. To join the conversation, see "[Sponsors Feedback](https://github.com/github/feedback/discussions/categories/sponsors-feedback)." diff --git a/data/reusables/sponsors/manage-updates-for-orgs.md b/data/reusables/sponsors/manage-updates-for-orgs.md index 0cd08d5382..b47ac0599d 100644 --- a/data/reusables/sponsors/manage-updates-for-orgs.md +++ b/data/reusables/sponsors/manage-updates-for-orgs.md @@ -1 +1 @@ -You can designate which email address receives updates from the accounts your organization sponsors. For more information, see "[Managing updates from accounts your organization sponsors](/github/setting-up-and-managing-organizations-and-teams/managing-updates-from-accounts-your-organization-sponsors)." +You can designate which email address receives updates from the accounts your organization sponsors. For more information, see "[Managing updates from accounts your organization sponsors](/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors)." diff --git a/data/reusables/sponsors/pay-prorated-amount.md b/data/reusables/sponsors/pay-prorated-amount.md index 969f672e64..b098d34abd 100644 --- a/data/reusables/sponsors/pay-prorated-amount.md +++ b/data/reusables/sponsors/pay-prorated-amount.md @@ -1,2 +1,2 @@ -1. Optionally, if you're sponsoring as an organization, to pay a prorated amount instead of making the full monthly payment, under "Due today", click **Pay prorated $X.XX today**. +1. Optionally, if you're sponsoring as an organization, to pay a prorated amount instead of making the full monthly payment, under "Total due now", click **Pay prorated $X.XX instead**. ![Link to pay prorated amount](/assets/images/help/sponsors/pay-prorated-amount-link.png) \ No newline at end of file diff --git a/data/reusables/sponsors/prorated-sponsorship.md b/data/reusables/sponsors/prorated-sponsorship.md index 56a047d867..9e560bf708 100644 --- a/data/reusables/sponsors/prorated-sponsorship.md +++ b/data/reusables/sponsors/prorated-sponsorship.md @@ -1 +1 @@ -If you're sponsoring on behalf of your user account, you will immediately be charged a prorated amount for the time until your next regular billing date. If you're sponsoring on behalf of an organization, you can choose to pay the prorated amount or make the full monthly payment. +If you're starting a monthly sponsorship on behalf of your user account, you'll immediately be charged a prorated amount for the time until your next regular billing date. If you're sponsoring on behalf of an organization, you can choose to pay the prorated amount or make the full monthly payment. diff --git a/data/reusables/sponsors/review-and-publish-tier.md b/data/reusables/sponsors/review-and-publish-tier.md index 7330af0fa3..e577304f71 100644 --- a/data/reusables/sponsors/review-and-publish-tier.md +++ b/data/reusables/sponsors/review-and-publish-tier.md @@ -1,2 +1,2 @@ -1. Proofread your tier, then click **Publish tier**. - ![Publish tier button](/assets/images/help/sponsors/publish-tier-button.png) +1. Proofread your tier, then click **Publish _TYPE_ tier**. + ![Publish monthly tier button](/assets/images/help/sponsors/publish-tier-button.png) diff --git a/data/reusables/sponsors/review-tiers-to-select.md b/data/reusables/sponsors/review-tiers-to-select.md new file mode 100644 index 0000000000..8dd4d85fa7 --- /dev/null +++ b/data/reusables/sponsors/review-tiers-to-select.md @@ -0,0 +1,2 @@ +1. On the right side of the page, under "Select a tier", review the sponsorship tiers available. If more than one type of tier is available "Monthly" tiers are shown, click **One-time** to show the tiers for one-time payments. + ![Show "One-time" tiers](/assets/images/help/sponsors/show-one-time-tiers.png) diff --git a/data/reusables/sponsors/select-a-tier.md b/data/reusables/sponsors/select-a-tier.md index 244113726f..8e87d104ba 100644 --- a/data/reusables/sponsors/select-a-tier.md +++ b/data/reusables/sponsors/select-a-tier.md @@ -1,2 +1,2 @@ -1. On the right side of the page, under "Select a tier", review the sponsorship tiers available. Then, to the right of the tier you want, click **Select**. +1. To the right of the tier you want, click **Select**. If want to select a custom amount, enter the sponsorship amount before clicking "Select." ![Select a tier box](/assets/images/help/sponsors/select-a-tier-box.png) diff --git a/data/reusables/sponsors/sponsorship-details.md b/data/reusables/sponsors/sponsorship-details.md index 6542580736..5f36b22238 100644 --- a/data/reusables/sponsors/sponsorship-details.md +++ b/data/reusables/sponsors/sponsorship-details.md @@ -1 +1 @@ -You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your user account or an organization. You can choose from multiple sponsorship tiers, with monthly payment amounts and benefits that are set by the sponsored account. Your sponsorship will share your account's existing billing date, payment method, and receipt. +You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your user account or an organization. You can choose from multiple sponsorship tiers, with one-time or monthly payment amounts and benefits that are set by the sponsored account. Your sponsorship will share your account's existing billing date, payment method, and receipt. diff --git a/data/reusables/sponsors/tier-details.md b/data/reusables/sponsors/tier-details.md index 9b80bb5aea..78c40c1054 100644 --- a/data/reusables/sponsors/tier-details.md +++ b/data/reusables/sponsors/tier-details.md @@ -1,3 +1,3 @@ -You can create up to ten sponsorship tiers for sponsors to choose from. Each tier has its own monthly payment amount in US dollars and benefits, such as receiving early access to new versions or being featured in the project's README. +You can create up to ten sponsorship tiers for sponsors to choose from. Each tier has its own monthly or one-time payment amount in US dollars and benefits, such as receiving early access to new versions or being featured in the project's README. In addition, you can choose to enable tiers for custom amounts (monthly and one-time). -Once you have published a tier, you can't edit the price of that tier. Instead, you must retire the tier and create a new tier. Existing sponsors will remain on the retired tier until they change their sponsorship tier or cancel their sponsorship. +Once you have published a tier, you can't edit the price of that tier. Instead, you must retire the tier and create a new tier. Existing sponsors will remain on the retired tier until they change their sponsorship tier, cancel their sponsorship, or their one-time sponsorship period expires. diff --git a/data/reusables/user_settings/billing_plans.md b/data/reusables/user_settings/billing_plans.md new file mode 100644 index 0000000000..505b2eb273 --- /dev/null +++ b/data/reusables/user_settings/billing_plans.md @@ -0,0 +1,2 @@ +1. In your user settings sidebar, click **Billing & plans**. +![Billing & plans settings](/assets/images/help/settings/settings-sidebar-billing-plans.png) diff --git a/data/ui.yml b/data/ui.yml index 6b2e9b30c2..17425b6564 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -140,16 +140,25 @@ product_landing: quick_start: Quickstart reference_guides: Reference guides overview: Overview + code_examples: Code examples + search_code_examples: Search code examples + show_more: Show more + sorry: Sorry, there is no result for + no_example: It looks like we don't have an example that fits your filter. + try_another: Try another filter or add your code example. + no_result: Sorry, there is no guide that match your filter. + learn: Learn how to add a code example + communities_using_discussions: Communities using discussions + add_your_community: Add your community product_sublanding: start: Start start_path: Start path - learning_paths: '{{ allProducts[currentProduct].name }} learning paths' + learning_paths: '{{ productMap[currentProduct].name }} learning paths' learning_paths_desc: Learning paths are a collection of guides that help you master a particular subject. - guides: '{{ allProducts[currentProduct].name }} guides' + guides: '{{ productMap[currentProduct].name }} guides' more_guides: more guides load_more: Load more guides - all_guides: 'All {{ allProducts[currentProduct].name }} guides' - no_result: Sorry, there is no guide that match your filter. + all_guides: 'All {{ productMap[currentProduct].name }} guides' filters: type: Type topic: Topic diff --git a/data/variables/action_code_examples.yml b/data/variables/actions_code_examples.yml similarity index 100% rename from data/variables/action_code_examples.yml rename to data/variables/actions_code_examples.yml diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000000..d95ee9b205 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,7 @@ +version: '3.6' +services: + webapp: + build: + context: . + dockerfile: Dockerfile.openapi_decorator + image: 'openapi_decorator:${BUILD_SHA}' diff --git a/includes/all-articles-category.html b/includes/all-articles-category.html index 0e1fdbd61b..d2e3cfa875 100644 --- a/includes/all-articles-category.html +++ b/includes/all-articles-category.html @@ -22,7 +22,7 @@ {% endfor %} {% assign numArticles = maptopic.childArticles | obj_size %} {% if numArticles > maxArticles %} - + {% endif %}
diff --git a/includes/all-articles-product.html b/includes/all-articles-product.html index 49074536ed..2de3262853 100644 --- a/includes/all-articles-product.html +++ b/includes/all-articles-product.html @@ -21,7 +21,7 @@ {% if numArticles > maxArticles %} - + {% endif %} {% endunless %} {% endfor %} @@ -34,7 +34,7 @@ {% endfor %} {% if numArticles > maxArticles %} - + {% endif %} {% endif %} diff --git a/includes/article-cards.html b/includes/article-cards.html index bb64bb9152..de7c3eb5ef 100644 --- a/includes/article-cards.html +++ b/includes/article-cards.html @@ -5,7 +5,7 @@
- +
- + +
+ +
+ {% render code-example-card for productCodeExamples as example %} +
+ + + +
+
{% octicon "search" width="24" %}
+

{% data ui.product_landing.sorry %}

+

{% data ui.product_landing.no_result %}
{% data ui.product_landing.try_another %}

+ {% data ui.product_landing.learn %} {% octicon "arrow-right" %} +
+ diff --git a/includes/community-examples.html b/includes/community-examples.html new file mode 100644 index 0000000000..42a95855cb --- /dev/null +++ b/includes/community-examples.html @@ -0,0 +1,16 @@ +
+

{% data ui.product_landing.communities_using_discussions %}

+ +
+ {% render discussions-community-card for productCommunityExamples as example %} +
+ {% if productCommunityExamples.length > 6 %} + + {% endif %} +
+
{% octicon "search" width="24" %}
+

{% data ui.product_landing.sorry %}

+

{% data ui.product_landing.no_example %}
{% data ui.product_landing.try_another %}

+ {% data ui.product_landing.add_your_community %} {% octicon "arrow-right" %} +
+
\ No newline at end of file diff --git a/includes/contribution.html b/includes/contribution.html index 1968105c7c..29652dd0ff 100644 --- a/includes/contribution.html +++ b/includes/contribution.html @@ -1,7 +1,7 @@ {% unless enterpriseServerReleases.isOldestReleaseDeprecated and currentVersion contains enterpriseServerReleases.oldestSupported %}

{% data ui.contribution_cta.title %}

-

{% data ui.contribution_cta.body %}

+

{% data ui.contribution_cta.body %}

{% if page.relativePath %} {% assign contribution_href = "https://github.com/github/docs/edit/main/content/" | append: page.relativePath %} {% else %} @@ -11,6 +11,6 @@ {% octicon "git-pull-request" height="16" %} {% data ui.contribution_cta.button %} -

{% data ui.contribution_cta.or %} {% data ui.contribution_cta.to_guidelines %}

+

{% data ui.contribution_cta.or %} {% data ui.contribution_cta.to_guidelines %}

{% endunless %} diff --git a/includes/deprecation-banner.html b/includes/deprecation-banner.html index df2a841f54..e8ffe0bdc4 100644 --- a/includes/deprecation-banner.html +++ b/includes/deprecation-banner.html @@ -1,5 +1,5 @@ {% if currentVersion contains enterpriseServerReleases.oldestSupported %} -
+

diff --git a/includes/discussions-community-card.html b/includes/discussions-community-card.html index d61f699aea..6b1f24f310 100644 --- a/includes/discussions-community-card.html +++ b/includes/discussions-community-card.html @@ -1,6 +1,6 @@

@@ -8,7 +8,7 @@

{{ example.repo }}

-

{{ example.description }}

+

{{ example.description }}
diff --git a/includes/error-404-deprecation-message.html b/includes/error-404-deprecation-message.html index 977fad83df..e73938725d 100644 --- a/includes/error-404-deprecation-message.html +++ b/includes/error-404-deprecation-message.html @@ -1,6 +1,6 @@ {% if enterpriseServerReleases.deprecated contains currentVersion %} {% assign deprecatedDate = enterpriseServerReleases.dates[currentVersion].deprecationDate %} -
+

{% data reusables.enterprise_deprecation.version_was_deprecated %} diff --git a/includes/explorer.html b/includes/explorer.html index f471ef3054..b431445670 100644 --- a/includes/explorer.html +++ b/includes/explorer.html @@ -1,7 +1,7 @@ {% include breadcrumbs %}

- {% if process.env.AIRGAP %} + {% if AIRGAP %}

GraphQL explorer is not available on this environment.

{% else %}