Skip to content

Commit

Permalink
repo sync
Browse files Browse the repository at this point in the history
  • Loading branch information
Octomerger authored Mar 18, 2021
2 parents 5f89d32 + 2ce40a1 commit 3766039
Show file tree
Hide file tree
Showing 26 changed files with 203 additions and 46 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ env:
jobs:
build:
# Do not run this job for translations PRs
if: ${{ github.ref != 'refs/heads/translations' }}
if: ${{ github.head_ref != 'translations' && github.ref != 'refs/heads/translations' }}

runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/link-check-dotcom.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
# run: npm run heroku-postbuild
# env:
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
# GIT_BRANCH: ${{ github.ref }}
# GIT_BRANCH: ${{ github.head_ref || github.ref }}

- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/link-check-ghae.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
# run: npm run heroku-postbuild
# env:
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
# GIT_BRANCH: ${{ github.ref }}
# GIT_BRANCH: ${{ github.head_ref || github.ref }}

- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/link-check-ghes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
# run: npm run heroku-postbuild
# env:
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
# GIT_BRANCH: ${{ github.ref }}
# GIT_BRANCH: ${{ github.head_ref || github.ref }}

- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Build
Expand Down
19 changes: 17 additions & 2 deletions .github/workflows/test-windows.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# NOTE: Changes to this file should also be applied to './test.yml' and './test-translations.yml'
# NOTE: Changes to this file should also be applied to './test.yml'

name: Node.js Tests - Windows

Expand All @@ -8,17 +8,24 @@ on:
schedule:
- cron: '50 19 * * *' # once a day at 19:50 UTC / 11:50 PST

env:
CI: true

jobs:
test:
runs-on: windows-latest
if: (github.event_name != 'pull_request') || (github.event_name == 'pull_request' && (contains(github.event.pull_request.labels.*.name, 'Windows') || contains(github.event.pull_request.labels.*.name, 'windows')))
timeout-minutes: 60
strategy:
fail-fast: false
matrix:
test-group: [content, graphql, meta, rendering, routing, unit]
steps:
- name: Check out repo
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
with:
# Enables cloning the Early Access repo later with the relevant PAT
persist-credentials: 'false'

- name: Setup node
uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
Expand All @@ -41,7 +48,15 @@ jobs:
- name: Install dependencies
run: npm ci

- name: Run build script
- 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: ${{ github.repository != 'github/docs-internal' }}
name: Run build script
run: npm run build

- name: Run tests
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ jobs:
run: npm run heroku-postbuild
env:
DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
GIT_BRANCH: ${{ github.ref }}
GIT_BRANCH: ${{ github.head_ref || github.ref }}

- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository != 'github/docs-internal' }}
name: Run build script
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ topics:
{% data reusables.code-scanning.beta %}
{% data reusables.code-scanning.not-available %}

### Producing detailed logs for debugging

To produce more detailed logging output, you can enable step debug logging. For more information, see "[Enabling debug logging](/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)."

### Automatic build for a compiled language fails

If an automatic build of code for a compiled language within your project fails, try the following troubleshooting steps.
Expand Down
22 changes: 18 additions & 4 deletions contributing/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,26 @@ To see all existing search-related issues and pull requests, visit [github.com/g

## How to search

The site search is part of every version of docs.github.com. On any page, you can use the search box to search the documents we've indexed.
You can also query our search endpoint directly at: https://docs.github.com/search?version=dotcom&language=en&filters=topics:%27oauth%20apps%27+AND+topics:%27github%20apps%27&query=install
The site search is part of every version of docs.github.com. This endpoint responds in JSON format, and fronts Algolia and Lunr. We recommend using this endpoint over directly integrating with Algolia or Lunr, as the endpoint will be more stable. On any page, you can use the search box to search the documents we've indexed.
You can also query our search endpoint directly at:
`https://docs.github.com/search?version=<VERSION>&language=<LANGUAGE CODE>&filters=topics:<TOPIC>&query=<QUERY>`

- The VERSION can be any numbered GitHub Enterprise Server version (e.g., `2.22`, `3.0`), GitHub AE (`ghae`), or the Free pro team plan (`dotcom`).
- The LANGUAGE CODE can be: `cn`, `de`, `en`, `es`, `ja`, or `pt`.
- TOPIC can be any topics in [the allowed list of topics](/data/allowed-topics.js). The values in the `topics` attribute are **not** case sensitive, so filtering on `GitHub actions` or `github actions` will return the same result. **Note:** Currently, the topics filter only works for the dotcom version in the English language. We plan to expand this search query to other languages and versions in the future.
- Any search QUERY you'd like.

Using the attribute `topics` in your query will only return results that have the matching topic value. You can find a full list of topics in [the allowed topics file](/data/allowed-topics.js). The `topics` attribute is configured as a [`filter only` facet in Algolia](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). When the topic contains spaces, you must use quotes. For Algolia, [here](https://www.algolia.com/doc/api-reference/api-parameters/filters/#handle-attributes-with-spaces) is an example for filters containing spaces. Algolia also requires [boolean operators](https://www.algolia.com/doc/api-reference/api-parameters/filters) to combine more than one filter.
For example, to filter on the topic `ssh` and the query `passphrases`, you'd use this search query:

This endpoint responds in JSON format, and fronts Algolia and Lunr. We recommend using this endpoint over directly integrating with Algolia or Lunr, as the endpoint will be more stable.
https://docs.github.com/search?version=dotcom&language=en&filters=topics:ssh&query=passphrases

To filter for the topics `oauth apps` and `github apps` and the query `install`, you'd use this search query:

https://docs.github.com/search?version=dotcom&language=en&filters=topics:'oauth apps'+AND+topics:'github apps'&query=install

### Using the topics search filter

Using the attribute `topics` in your query will only return results that have the matching topic value. The `topics` attribute is configured as a [`filter only` facet in Algolia](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). When the topic contains spaces, you must use quotes. For Algolia, [here](https://www.algolia.com/doc/api-reference/api-parameters/filters/#handle-attributes-with-spaces) is an example for filters containing spaces. Algolia also requires [boolean operators](https://www.algolia.com/doc/api-reference/api-parameters/filters) to combine more than one filter.

## Production deploys

Expand Down
20 changes: 20 additions & 0 deletions data/graphql/ghae/schema.docs-ghae.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -2132,6 +2132,16 @@ type CheckRun implements Node & UniformResourceLocatable {
externalId: String
id: ID!

"""
Whether this check run is required to pass before merging.
"""
isRequired(
"""
The pull request this check is required for
"""
pullRequestId: ID!
): Boolean!

"""
The name of the check for this check run.
"""
Expand Down Expand Up @@ -31869,6 +31879,16 @@ type StatusContext implements Node {
description: String
id: ID!

"""
Whether this status is required to pass before merging.
"""
isRequired(
"""
The pull request this status is required for
"""
pullRequestId: ID!
): Boolean!

"""
The state of this status context.
"""
Expand Down
20 changes: 20 additions & 0 deletions data/graphql/schema.docs.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -2222,6 +2222,16 @@ type CheckRun implements Node & UniformResourceLocatable {
externalId: String
id: ID!

"""
Whether this check run is required to pass before merging.
"""
isRequired(
"""
The pull request this check is required for
"""
pullRequestId: ID!
): Boolean!

"""
The name of the check for this check run.
"""
Expand Down Expand Up @@ -34802,6 +34812,16 @@ type StatusContext implements Node {
description: String
id: ID!

"""
Whether this status is required to pass before merging.
"""
isRequired(
"""
The pull request this status is required for
"""
pullRequestId: ID!
): Boolean!

"""
The state of this status context.
"""
Expand Down
1 change: 1 addition & 0 deletions data/release-notes/3-0/0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ sections:
- The format of several log files have changed, including the addition of a PID for different log types. This does not affect how GitHub Enterprise Support uses support bundles to troubleshoot issues.
- A PATCH request to the webhook configuration API no longer erases the webhook secret.
- Certain types of pre-receive hooks were failing.
- 'The Packages NuGet service now normalizes semantic versions on publish. An invalid semantic version (for example: v1.0.0.0.0.0) is not downloadable by NuGet clients and therefore a NuGet service is expected to normalize those versions (for example: v1.0.0.0.0.0 --> v1.0.0). Any original, non-normalized, version will be available in the `verbatimVersion` field. No changes to client configurations are required.'

known_issues:
- On a freshly set up {% data variables.product.prodname_ghe_server %} without any users, an attacker could create the first admin user.
Expand Down
2 changes: 1 addition & 1 deletion data/ui.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ header:
For the most current information, please visit the
<a id="to-english-doc" href="/en">English documentation</a>.
If there's a problem with translations on this page, please
<a href="/contact?form[subject]=translation%20issue%20on%20help.github.com&form[comments]=">let us know</a>.
<a href="/contact?form[subject]=translation%20issue%20on%20docs.github.com&form[comments]=">let us know</a>.
localization_in_progress:
Hello, explorer! This page is under active development or
still in translation. For the most up-to-date and accurate information,
Expand Down
14 changes: 14 additions & 0 deletions lib/graphql/static/changelog.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
[
{
"schemaChanges": [
{
"title": "The GraphQL schema includes these changes:",
"changes": [
"Field `isRequired` was added to object type `CheckRun`",
"Field `isRequired` was added to object type `StatusContext`"
]
}
],
"previewChanges": [],
"upcomingChanges": [],
"date": "2021-03-18"
},
{
"schemaChanges": [
{
Expand Down
4 changes: 2 additions & 2 deletions lib/graphql/static/prerendered-objects.json

Large diffs are not rendered by default.

40 changes: 40 additions & 0 deletions lib/graphql/static/schema-dotcom.json
Original file line number Diff line number Diff line change
Expand Up @@ -8340,6 +8340,26 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "isRequired",
"description": "<p>Whether this check run is required to pass before merging.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean",
"arguments": [
{
"name": "pullRequestId",
"description": "<p>The pull request this check is required for.</p>",
"type": {
"name": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
}
}
]
},
{
"name": "name",
"description": "<p>The name of the check for this check run.</p>",
Expand Down Expand Up @@ -48997,6 +49017,26 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "isRequired",
"description": "<p>Whether this status is required to pass before merging.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean",
"arguments": [
{
"name": "pullRequestId",
"description": "<p>The pull request this status is required for.</p>",
"type": {
"name": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
}
}
]
},
{
"name": "state",
"description": "<p>The state of this status context.</p>",
Expand Down
40 changes: 40 additions & 0 deletions lib/graphql/static/schema-ghae.json
Original file line number Diff line number Diff line change
Expand Up @@ -7527,6 +7527,26 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "isRequired",
"description": "<p>Whether this check run is required to pass before merging.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean",
"arguments": [
{
"name": "pullRequestId",
"description": "<p>The pull request this check is required for.</p>",
"type": {
"name": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
}
}
]
},
{
"name": "name",
"description": "<p>The name of the check for this check run.</p>",
Expand Down Expand Up @@ -45359,6 +45379,26 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "isRequired",
"description": "<p>Whether this status is required to pass before merging.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean",
"arguments": [
{
"name": "pullRequestId",
"description": "<p>The pull request this status is required for.</p>",
"type": {
"name": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
}
}
]
},
{
"name": "state",
"description": "<p>The state of this status context.</p>",
Expand Down
2 changes: 1 addition & 1 deletion script/early-access/clone-for-build.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ require('dotenv').config()
const {
DOCUBOT_REPO_PAT,
HEROKU_PRODUCTION_APP,
GIT_BRANCH // Set by the deployer with the name of the docs-internal branch
GIT_BRANCH // Set by Actions and/or the deployer with the name of the docs-internal branch
} = process.env

// Exit if PAT is not found
Expand Down
2 changes: 1 addition & 1 deletion translations/de-DE/data/ui.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ header:
notices:
ghae_silent_launch: GitHub AE is currently under limited release. Please <a href="https://enterprise.github.com/contact">contact our Sales Team</a> to find out more.
release_candidate: '# The version name is rendered before the below text via includes/header-notification.html '' is currently available as a release candidate. For more information, see "<a href="/admin/overview/about-upgrades-to-new-releases">About upgrades to new releases</a>."'''
localization_complete: Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite kann noch im Gange sein. Die neuesten Informationen findest Du in der <a id="to-english-doc" href="/en">englischsprachigen Dokumentation</a>. <a href="https://github.com/contact?form[subject]=translation%20issue%20on%20help.github.com&form[comments]=">Informieren Sie uns bitte</a>, falls auf dieser Seite ein Problem mit den Übersetzungen vorliegt.
localization_complete: Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite kann noch im Gange sein. Die neuesten Informationen findest Du in der <a id="to-english-doc" href="/en">englischsprachigen Dokumentation</a>. <a href="https://github.com/contact?form[subject]=translation%20issue%20on%20docs.github.com&form[comments]=">Informieren Sie uns bitte</a>, falls auf dieser Seite ein Problem mit den Übersetzungen vorliegt.
localization_in_progress: Hallo, Entdecker! An dieser Seite wird aktiv gearbeitet, oder sie wird noch übersetzt. Die neuesten und genauesten Informationen findest Du in unserer <a id="to-english-doc" href="/en">englischsprachigen Dokumentation</a>.
early_access: '📣 Please <b>do not share</b> this URL publicly. This page contains content about an early access feature.'
search:
Expand Down
2 changes: 1 addition & 1 deletion translations/es-ES/data/ui.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ header:
notices:
ghae_silent_launch: GitHub AE está actualmente en un lanzamiento limitado. Por favor, <a href="https://enterprise.github.com/contact">contacta a nuestro equipo de ventas</a> para conocer más sobre esto.
release_candidate: '# El nombre de la versión se interpreta antes del texto siguiente a través de '' includes/header-notification.html '' se encuentra disponible actualmente como un candidato de lanzamiento. Para obtener más información, consulta la sección "<a href="/admin/overview/about-upgrades-to-new-releases">Acerca de las mejoras para los lanzamientos nuevos</a>".'
localization_complete: Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la <a id="to-english-doc" href="/en">documentación en inglés</a>. Si existe un problema con las traducciones en esta página, por favor <a href="https://github.com/contact?form[subject]=translation%20issue%20on%20help.github.com&form[comments]=">infórmanos</a>.
localization_complete: Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la <a id="to-english-doc" href="/en">documentación en inglés</a>. Si existe un problema con las traducciones en esta página, por favor <a href="https://github.com/contact?form[subject]=translation%20issue%20on%20docs.github.com&form[comments]=">infórmanos</a>.
localization_in_progress: '¡Hola, explorador! Esta página está bajo desarrollo activo o todavía está en la etapa de traducción. Para obtener información más actualizada y precisa, visita nuestra <a id="to-english-doc" href="/en">documentación en inglés</a>.'
early_access: '📣 Por favor, <b>no compartas</b> esta URL públicamente. Esta página tiene contenido sobre una característica de acceso temprano.'
search:
Expand Down
Loading

0 comments on commit 3766039

Please sign in to comment.