# The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. -name: Post welcome comment - -# Add the \`pull_request\` event, so that the workflow runs automatically -# every time a pull request is created. -on: - pull_request: - types: [opened] -
name: Post welcome commentThe name of the workflow as it will appear in the "Actions" tab of the GitHub repository.
on:
- pull_request:
- types: [opened]Add the pull_request event, so that the workflow runs automatically
-every time a pull request is created.
# The name of the workflow as it will appear in the "Actions" tab of the GitHub repository.
-name: Post welcome comment
-
-# Add the \`pull_request\` event, so that the workflow runs automatically
-# every time a pull request is created.
-on:
- pull_request:
- types: [opened]
-# The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. +"YAML # The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. name: Post welcome comment # Add the \`pull_request\` event, so that the workflow runs automatically diff --git a/src/content-render/unified/annotate.js b/src/content-render/unified/annotate.js index 65fcc057b49c..5fd5fd9cc1f2 100644 --- a/src/content-render/unified/annotate.js +++ b/src/content-render/unified/annotate.js @@ -160,7 +160,7 @@ function getSubnav() { name: 'annotate-display', value: 'beside', type: 'button', - className: 'BtnGroup-item btn btn-sm', + className: 'annotate-option', }, ['Beside'], ) @@ -170,12 +170,12 @@ function getSubnav() { name: 'annotate-display', value: 'inline', type: 'button', - className: 'BtnGroup-item btn btn-sm', + className: 'annotate-option', }, ['Inline'], ) - return h('div', { className: 'BtnGroup' }, [besideBtn, inlineBtn]) + return h('div', { className: 'annotate-toggle' }, [besideBtn, inlineBtn]) } function template({ lang, code, rows }) { diff --git a/src/frame/components/lib/toggle-annotations.ts b/src/frame/components/lib/toggle-annotations.ts index 46acbaf574af..72e44b07df8d 100644 --- a/src/frame/components/lib/toggle-annotations.ts +++ b/src/frame/components/lib/toggle-annotations.ts @@ -19,7 +19,7 @@ function validateMode(mode?: string) { } export default function toggleAnnotation() { - const annotationButtons = Array.from(document.querySelectorAll('div.BtnGroup button')) + const annotationButtons = Array.from(document.querySelectorAll('.annotate-toggle button')) if (!annotationButtons.length) return const cookie = validateMode(Cookies.get('annotate-mode')) // will default to beside @@ -53,11 +53,11 @@ function setActive(annotationButtons: Array, targetMode?: string) { annotationButtons.forEach((el) => { if (el.getAttribute('value') === targetMode) { el.ariaCurrent = 'true' - el.classList.add('selected', 'color-fg-on-emphasis', 'color-bg-emphasis') + el.classList.add('selected') activeElements.push(el) } else { el.removeAttribute('aria-current') - el.classList.remove('selected', 'color-fg-on-emphasis', 'color-bg-emphasis') + el.classList.remove('selected') } }) diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index 967b9ad7b98d..1c7791565cea 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,22 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [] + } + ], + "previewChanges": [], + "upcomingChanges": [ + { + "title": "The following changes will be made to the schema:", + "changes": [ + " On member
" + ] + } + ], + "date": "2024-08-29" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/graphql_upcoming_changes.public.yml b/src/graphql/data/fpt/graphql_upcoming_changes.public.yml index 895e53b59153..2195c2f62610 100644 --- a/src/graphql/data/fpt/graphql_upcoming_changes.public.yml +++ b/src/graphql/data/fpt/graphql_upcoming_changes.public.yml @@ -658,3 +658,11 @@ upcoming_changes: date: '2024-10-01T00:00:00+00:00' criticality: breaking owner: stevepopovich + - location: AddMobileDevicePublicKeyPayload.expiresAt + description: + '`expiresAt` will be removed. Do not rely on this field, it is currently + set to a date far in the future if a device key is expirationless' + reason: We are deprecating expirations for mobile device keys used in mobile 2FA + date: '2025-01-01T00:00:00+00:00' + criticality: breaking + owner: chriskirkland diff --git a/src/graphql/data/fpt/upcoming-changes.json b/src/graphql/data/fpt/upcoming-changes.json index cb57402c30b1..4ca5619de54a 100644 --- a/src/graphql/data/fpt/upcoming-changes.json +++ b/src/graphql/data/fpt/upcoming-changes.json @@ -1,4 +1,14 @@ { + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "AddMobileDevicePublicKeyPayload.expiresAt:expiresAtwill be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless Effective 2025-01-01.", + "reason": "
expiresAtwill be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationlessWe are deprecating expirations for mobile device keys used in mobile 2FA
", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], "2024-10-01": [ { "location": "Workflow.hasWorkflowDispatchTrigger", diff --git a/src/graphql/data/ghec/graphql_upcoming_changes.public.yml b/src/graphql/data/ghec/graphql_upcoming_changes.public.yml index 895e53b59153..2195c2f62610 100644 --- a/src/graphql/data/ghec/graphql_upcoming_changes.public.yml +++ b/src/graphql/data/ghec/graphql_upcoming_changes.public.yml @@ -658,3 +658,11 @@ upcoming_changes: date: '2024-10-01T00:00:00+00:00' criticality: breaking owner: stevepopovich + - location: AddMobileDevicePublicKeyPayload.expiresAt + description: + '`expiresAt` will be removed. Do not rely on this field, it is currently + set to a date far in the future if a device key is expirationless' + reason: We are deprecating expirations for mobile device keys used in mobile 2FA + date: '2025-01-01T00:00:00+00:00' + criticality: breaking + owner: chriskirkland diff --git a/src/graphql/data/ghec/upcoming-changes.json b/src/graphql/data/ghec/upcoming-changes.json index cb57402c30b1..4ca5619de54a 100644 --- a/src/graphql/data/ghec/upcoming-changes.json +++ b/src/graphql/data/ghec/upcoming-changes.json @@ -1,4 +1,14 @@ { + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "", + "reason": "
expiresAtwill be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationlessWe are deprecating expirations for mobile device keys used in mobile 2FA
", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], "2024-10-01": [ { "location": "Workflow.hasWorkflowDispatchTrigger", diff --git a/src/secret-scanning/README.md b/src/secret-scanning/README.md index c35a910cc505..431986c4bcaf 100644 --- a/src/secret-scanning/README.md +++ b/src/secret-scanning/README.md @@ -1,3 +1,18 @@ # Secret scanning -The files in the secret scanning folder support our secret scanning informational pages. +This secret scanning pipeline automates a table displayed on the [Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets) page. + +Each day a workflow checks if the [data](src/secret-scanning/data/public-docs.yml) is up-to-date. When there are changes, the workflow automatically creates a pull request to update the `src/secret-scanning/data/public-docs.yml` file. The workflow runs `npm run sync-secret-scanning` to check for updates. + +This pipeline uses middleware to check if the path of the URL matches the page that contains the table. The middleware decorates the context with the data, which is displayed on the page using a Markdown table and Liquid. For example: + +```markdown + +{% ifversion fpt %} + +| Provider | Token | Partner | User | Push protection +|----|:----|:----:|:----:|:----:| +{%- for entry in secretScanningData %} +| {{ entry.provider }} | {{ entry.secretType }} | {% if entry.isPublic %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Unsupported" %}{% endif %} | {% if entry.isPrivateWithGhas %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Unsupported" %}{% endif %} | {% if entry.hasPushProtection %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Unsupported" %}{% endif %} | +{%- endfor %} +``` diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index 95cbdb6c9783..9283b6a72e6e 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,4 +1,5 @@ { "sha": "bb86a15b48fe62030cf0ad8c38520508063ec20b", - "blob-sha": "96de8d829b93d371162f193a68ea19ae86ac0d09" + "blob-sha": "96de8d829b93d371162f193a68ea19ae86ac0d09", + "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file diff --git a/src/secret-scanning/middleware/secret-scanning.ts b/src/secret-scanning/middleware/secret-scanning.ts index 95eef0f48581..20b139194d21 100644 --- a/src/secret-scanning/middleware/secret-scanning.ts +++ b/src/secret-scanning/middleware/secret-scanning.ts @@ -9,17 +9,19 @@ import { ExtendedRequest, SecretScanningData } from '@/types' const secretScanningPath = 'src/secret-scanning/data/public-docs.yml' +// This is the path to the file that contains the secret scanning data. +// Currently it's: +// code-security/secret-scanning/introduction/supported-secret-scanning-pattern +const { targetFilename } = JSON.parse( + fs.readFileSync('src/secret-scanning/lib/config.json', 'utf-8'), +) + export default async function secretScanning( req: ExtendedRequest, res: Response, next: NextFunction, ) { - if ( - !req.pagePath!.endsWith( - 'code-security/secret-scanning/introduction/supported-secret-scanning-patterns', - ) - ) - return next() + if (!req.pagePath!.endsWith(targetFilename)) return next() const secretScanningData = yaml.load( fs.readFileSync(secretScanningPath, 'utf-8'), diff --git a/src/secret-scanning/tests/rendering.js b/src/secret-scanning/tests/rendering.js new file mode 100644 index 000000000000..1725a2fa5802 --- /dev/null +++ b/src/secret-scanning/tests/rendering.js @@ -0,0 +1,14 @@ +import { describe, expect, test } from 'vitest' +import { readFileSync } from 'fs' + +import { get } from '#src/tests/helpers/e2etest.js' + +describe('secret-scanning pipeline', () => { + const { targetFilename } = JSON.parse(readFileSync('src/secret-scanning/lib/config.json')) + // This test ensures that the configured page exists. If the page moves + // this test will fail. + test(`check if ${targetFilename} was moved`, async () => { + const page = await get(`/${targetFilename}`, { followRedirects: true }) + expect(page.statusCode).toBe(200) + }) +}) diff --git a/src/workflows/ready-for-docs-review.js b/src/workflows/ready-for-docs-review.js index 866955ff348c..8ac4942e9ee2 100644 --- a/src/workflows/ready-for-docs-review.js +++ b/src/workflows/ready-for-docs-review.js @@ -144,9 +144,7 @@ async function run() { // Generate a mutation to populate fields for the new project item const updateProjectV2ItemMutation = generateUpdateProjectV2ItemFieldMutation({ item: newItemID, - author: firstTimeContributor - ? `${process.env.AUTHOR_LOGIN} (first time contributor)` - : process.env.AUTHOR_LOGIN, + author: firstTimeContributor ? ':star: first time contributor' : process.env.AUTHOR_LOGIN, turnaround, feature, })