Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 5 additions & 28 deletions .github/workflows/notify-about-deployment.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: Notify about production deployment

# **What it does**: Posts a comment on the PR whose merge got into production.
# **What it does**: Posts a comment on every PR in the deploy that got into
# production. The merge queue can batch several PRs into one
# deploy, so it walks back from the deployed commit to find
# all of them.
# **Why we have it**: So that the PR author can be informed when their merged PR is in production.
# **Who does it impact**: Writers

Expand Down Expand Up @@ -38,38 +41,12 @@ jobs:
- name: Sleep a little to give Fastly Purge a chance
run: sleep 30

- name: Find last PR
id: get-number
- name: Find PRs and post production comments
timeout-minutes: 5
env:
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
run: npm run find-past-built-pr

- name: Find content directory changes comment
if: ${{ steps.get-number.outputs.number != '' }}
uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad
id: findComment
with:
issue-number: ${{ steps.get-number.outputs.number }}
comment-author: 'github-actions[bot]'
body-includes: '<!-- GONE_TO_PRODUCTION -->'

- name: Update comment
if: ${{ steps.get-number.outputs.number != '' }}
uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9
with:
comment-id: ${{ steps.findComment.outputs.comment-id }}
issue-number: ${{ steps.get-number.outputs.number }}
body: |
<!-- GONE_TO_PRODUCTION -->
🚀 **This pull request has gone into production!**

The SHA of https://docs.github.com/_build matches the merge commit in this PR.

If you don't see updates when expected, try adding a random query string to the URL like `?bla=1234` and see if that helps.
If that shows the expected content, it would indicate that the CDN is "overly caching" the page still. It will eventually update, but it can take a while.
edit-mode: replace

- uses: ./.github/actions/slack-alert
if: ${{ failure() }}
with:
Expand Down
17 changes: 17 additions & 0 deletions config/moda/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ environments:

# 15 staging environments, evergreens only
# they should all contain the same configs
# intentionally pinned to a single cluster via the `name` selector

- name: staging-balsam
require_pipeline: false
notify_still_locked: true # Notify last person to lock this after an hour
Expand All @@ -22,6 +24,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':balsam: Review at https://docs-internal-staging-balsam.githubapp.com/'

- name: staging-boxwood
Expand All @@ -34,6 +37,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':boxwood: Review at https://docs-internal-staging-boxwood.githubapp.com/'

- name: staging-cedar
Expand All @@ -46,6 +50,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':cedar: Review at https://docs-internal-staging-cedar.githubapp.com/'

- name: staging-cypress
Expand All @@ -58,6 +63,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':cypress: Review at https://docs-internal-staging-cypress.githubapp.com/'

- name: staging-fir
Expand All @@ -70,6 +76,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':fir: Review at https://docs-internal-staging-fir.githubapp.com/'

- name: staging-hemlock
Expand All @@ -82,6 +89,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':hemlock: Review at https://docs-internal-staging-hemlock.githubapp.com/'

- name: staging-hinoki
Expand All @@ -94,6 +102,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':hinoki: Review at https://docs-internal-staging-hinoki.githubapp.com/'

- name: staging-holly
Expand All @@ -106,6 +115,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':holly_: Review at https://docs-internal-staging-holly.githubapp.com/'

- name: staging-juniper
Expand All @@ -118,6 +128,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':juniper: Review at https://docs-internal-staging-juniper.githubapp.com/'

- name: staging-laurel
Expand All @@ -130,6 +141,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':laurel: Review at https://docs-internal-staging-laurel.githubapp.com/'

- name: staging-pine
Expand All @@ -142,6 +154,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':pine: Review at https://docs-internal-staging-pine.githubapp.com/'

- name: staging-redwood
Expand All @@ -154,6 +167,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':redwood: Review at https://docs-internal-staging-redwood.githubapp.com/'

- name: staging-sequoia
Expand All @@ -166,6 +180,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':sequoia: Review at https://docs-internal-staging-sequoia.githubapp.com/'

- name: staging-spruce
Expand All @@ -178,6 +193,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':spruce: Review at https://docs-internal-staging-spruce.githubapp.com/'

- name: staging-yew
Expand All @@ -190,6 +206,7 @@ environments:
cluster_selector:
profile: general
region: iad
name: general-2-ash1-iad
extra_completed_message: ':yew: Review at https://docs-internal-staging-yew.githubapp.com/'

required_builds:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
contentType: concepts
category:
- Find and fix code vulnerabilities
redirect_from:
- /code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues
---

{% data reusables.code-scanning.alert-tracking-with-issues-preview-note %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: About code scanning alerts
title: Code scanning alerts
shortTitle: Code scanning alerts
intro: Learn about the different types of code scanning alerts and the information that helps you understand the problem each alert highlights.
permissions: '{% data reusables.permissions.code-scanning-all-alerts %}'
Expand All @@ -11,6 +11,7 @@ versions:
redirect_from:
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts
- /code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts
- /code-security/concepts/code-scanning/about-code-scanning-alerts
contentType: concepts
category:
- Find and fix code vulnerabilities
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: About code scanning
shortTitle: Introduction
title: Code scanning
shortTitle: Code scanning
intro: You can use {% data variables.product.prodname_code_scanning %} to find security vulnerabilities and errors in the code for your project on {% data variables.product.prodname_dotcom %}.
product: '{% data reusables.gated-features.code-scanning %}'
redirect_from:
Expand All @@ -11,6 +11,7 @@ redirect_from:
- /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
- /code-security/code-scanning/introduction-to-code-scanning/about-code-scanning
- /code-security/concepts/code-scanning/about-code-scanning
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: About the CodeQL CLI
title: CodeQL CLI
shortTitle: CodeQL CLI
intro: You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.github %}.
product: '{% data reusables.gated-features.codeql %}'
Expand All @@ -22,6 +22,7 @@ redirect_from:
- /code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli
- /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli
- /code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli
- /code-security/concepts/code-scanning/codeql/about-the-codeql-cli
contentType: concepts
category:
- Customize vulnerability detection with CodeQL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: About code scanning with CodeQL
title: Code scanning with CodeQL
shortTitle: CodeQL code scanning
intro: You can use {% data variables.product.prodname_codeql %} to identify vulnerabilities and errors in your code. The results are shown as {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.prodname_dotcom %}.
product: '{% data reusables.gated-features.code-scanning %}'
redirect_from:
- /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql
- /code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql
- /code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'About CodeQL code scanning for compiled languages'
title: CodeQL code scanning for compiled languages
shortTitle: CodeQL for compiled languages
intro: Understand how {% data variables.product.prodname_codeql %} analyzes compiled languages, the build options available, and learn how you can customize the database generation process if you need to.
permissions: '{% data reusables.permissions.code-scanning-all-alerts %} if [advanced setup](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning) is already enabled'
Expand All @@ -11,6 +11,8 @@ versions:
contentType: concepts
category:
- Find and fix code vulnerabilities
redirect_from:
- /code-security/concepts/code-scanning/codeql/about-codeql-code-scanning-for-compiled-languages
---

## About the {% data variables.code-scanning.codeql_workflow %} and compiled languages
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: About CodeQL for VS Code
title: CodeQL for VS Code
shortTitle: CodeQL for VS Code
versions:
fpt: '*'
Expand All @@ -10,6 +10,7 @@ intro: You can write, run, and test {% data variables.product.prodname_codeql %}
redirect_from:
- /code-security/codeql-for-vs-code/about-codeql-for-visual-studio-code
- /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/about-codeql-for-vs-code
- /code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code
contentType: concepts
category:
- Customize vulnerability detection with CodeQL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: About CodeQL workspaces
title: CodeQL workspaces
shortTitle: CodeQL workspaces
intro: '{% data variables.product.prodname_codeql %} workspaces let you develop and maintain multiple related {% data variables.product.prodname_codeql %} packs together, resolving dependencies between them directly from source.'
product: '{% data reusables.gated-features.codeql %}'
Expand All @@ -11,6 +11,7 @@ redirect_from:
- /code-security/codeql-cli/about-codeql-workspaces
- /code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces
- /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/about-codeql-workspaces
- /code-security/concepts/code-scanning/codeql/about-codeql-workspaces
contentType: concepts
category:
- Customize vulnerability detection with CodeQL
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ versions:
contentType: concepts
category:
- Customize vulnerability detection with CodeQL
redirect_from:
- /code-security/concepts/code-scanning/codeql/custom-codeql-queries
---

## What are custom {% data variables.product.prodname_codeql %} queries?
Expand Down
15 changes: 8 additions & 7 deletions content/code-security/concepts/code-scanning/codeql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ versions:
ghec: '*'
contentType: concepts
children:
- /about-code-scanning-with-codeql
- /about-codeql-code-scanning-for-compiled-languages
- /codeql-code-scanning
- /codeql-for-compiled-languages
- /codeql-query-suites
- /custom-codeql-queries
- /about-the-codeql-cli
- /about-codeql-for-vs-code
- /about-codeql-workspaces
- /custom-queries
- /codeql-cli
- /codeql-for-vs-code
- /codeql-workspaces
- /query-reference-files
- /codeql-query-packs
- /query-packs
---

Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: CodeQL query packs
shortTitle: Query packs
intro: You can choose from different built-in {% data variables.product.prodname_codeql %} query suites to use in your {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} setup.
product: '{% data reusables.gated-features.codeql %}'
versions:
Expand All @@ -9,6 +10,8 @@ versions:
contentType: concepts
category:
- Customize vulnerability detection with CodeQL
redirect_from:
- /code-security/concepts/code-scanning/codeql/codeql-query-packs
---

{% data reusables.code-scanning.codeql-cli-version-ghes %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Query reference files
shortTitle: Query reference files
intro: You can use query reference files to define the location of a query you want to run in tests.
product: '{% data reusables.gated-features.codeql %}'
versions:
Expand Down
11 changes: 6 additions & 5 deletions content/code-security/concepts/code-scanning/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,19 @@ redirect_from:
- /code-security/code-scanning/introduction-to-code-scanning
contentType: concepts
children:
- /about-code-scanning
- /about-code-scanning-alerts
- /code-security-risk-assessment
- /code-scanning
- /code-scanning-alerts
- /risk-assessment
- /copilot-autofix-for-code-scanning
- /setup-types
- /about-integration-with-code-scanning
- /integration-with-code-scanning
- /sarif-files
- /code-scanning-alert-tracking-using-issues
- /alert-tracking-with-issues
- /merge-protection
- /multi-repository-variant-analysis
- /codeql
- /tool-status-page
- /pull-request-alert-metrics
- /repository-properties
---

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: About integration with code scanning
title: Integration with code scanning
shortTitle: Integration with code scanning
intro: You can perform {% data variables.product.prodname_code_scanning %} externally and then display the results in {% data variables.product.prodname_dotcom %}, or configure webhooks that listen to {% data variables.product.prodname_code_scanning %} activity in your repository.
product: '{% data reusables.gated-features.code-scanning %}'
Expand All @@ -9,6 +9,7 @@ redirect_from:
- /code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning
- /github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning/about-integration-with-code-scanning
- /code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning
- /code-security/concepts/code-scanning/about-integration-with-code-scanning
versions:
fpt: '*'
ghes: '*'
Expand Down
Loading
Loading