Skip to content

Commit e8b46c6

Browse files
authored
Merge branch 'main' into hotfix/about-app-links
2 parents 4a5fd97 + 0694021 commit e8b46c6

File tree

1,285 files changed

+39017
-29566
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,285 files changed

+39017
-29566
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Order is important. The LAST matching pattern has the MOST precedence.
22
# gitignore style patterns are used, not globs.
3-
# https://help.github.com/articles/about-codeowners
3+
# https://docs.github.com/articles/about-codeowners
44
# https://git-scm.com/docs/gitignore
55

66
# Engineering
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Target Date Update
3+
about: Target date update
4+
body:
5+
- type: input
6+
attributes:
7+
name: Target completion date
8+
placeholder: With context if the target completion date has changed
9+
inputType: text
10+
- type: input
11+
attributes:
12+
name: 'Attribution'
13+
value: '_created with :heart: by typing_ `/status`'
14+
inputType: text

.github/allowed-actions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ module.exports = [
3939
"repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d",
4040
"someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd",
4141
"tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61",
42-
"EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575",
42+
"EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519",
4343
"dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58",
4444
];

.github/workflows/build-docker-image.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ env:
1414
jobs:
1515
build:
1616
# Do not run this job for translations PRs
17-
if: ${{ github.ref != 'refs/heads/translations' }}
17+
if: ${{ github.head_ref != 'translations' && github.ref != 'refs/heads/translations' }}
1818

1919
runs-on: ubuntu-latest
2020
steps:

.github/workflows/close-external-repo-sync-prs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
jobs:
1212
invalid-repo-sync-check:
1313
name: Close external Repo Sync PRs
14-
if: ${{ github.repository == 'github/docs' && github.ref == 'refs/heads/repo-sync' }}
14+
if: ${{ github.repository == 'github/docs' && github.head_ref == 'repo-sync' }}
1515
runs-on: ubuntu-latest
1616
steps:
1717
- uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9

.github/workflows/link-check-dotcom.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
# run: npm run heroku-postbuild
4848
# env:
4949
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
50-
# GIT_BRANCH: ${{ github.ref }}
50+
# GIT_BRANCH: ${{ github.head_ref || github.ref }}
5151

5252
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
5353
name: Build

.github/workflows/link-check-ghae.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
# run: npm run heroku-postbuild
4848
# env:
4949
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
50-
# GIT_BRANCH: ${{ github.ref }}
50+
# GIT_BRANCH: ${{ github.head_ref || github.ref }}
5151

5252
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
5353
name: Build

.github/workflows/link-check-ghes.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
# run: npm run heroku-postbuild
4848
# env:
4949
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
50-
# GIT_BRANCH: ${{ github.ref }}
50+
# GIT_BRANCH: ${{ github.head_ref || github.ref }}
5151

5252
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
5353
name: Build

.github/workflows/openapi-decorate.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,10 @@ jobs:
2525
run: script/rest/update-files.js --decorate-only
2626

2727
- name: Check in the decorated files
28-
uses: EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575
28+
uses: EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519
2929
with:
3030
# The arguments for the `git add` command
3131
add: 'lib/rest/static/decorated'
3232

3333
# The message for the commit
3434
message: 'Add decorated OpenAPI schema files'
35-
36-
env:
37-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Ready for docs-content review
2+
3+
# **What it does**: Adds pull requests in the docs-internal repository to the docs-content first responder project board
4+
# **Why we have it**: So that other GitHub teams can easily request reviews from the docs-content team, and so that writers can see when a PR is ready for review
5+
# **Who does it impact**: Writers working in the docs-internal repository
6+
7+
on:
8+
pull_request:
9+
types: [labeled]
10+
11+
jobs:
12+
request_doc_review:
13+
name: Request a review from the docs-content team
14+
if: github.event.label.name == 'ready-for-doc-review' && github.repository == 'github/docs-internal'
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Add pull request to FR project board
18+
uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9
19+
with:
20+
action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
21+
project-url: 'https://github.com/orgs/github/projects/1367'
22+
column-name: 'Docs-internal external contributor PRs'

.github/workflows/send-eng-issues-to-backlog.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Send Issue to How We Work Boards
2+
3+
on:
4+
issues:
5+
types:
6+
- labeled
7+
- reopened
8+
9+
jobs:
10+
triage:
11+
runs-on: ubuntu-latest
12+
continue-on-error: true
13+
steps:
14+
- if: contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic')
15+
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
16+
with:
17+
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
18+
script: |
19+
var column_id = 9659080;
20+
try {
21+
github.projects.createCard({
22+
column_id: column_id,
23+
content_id: context.payload.issue.id,
24+
content_type: "Issue"
25+
});
26+
} catch (error) {
27+
console.log(error);
28+
}
29+
- if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature')
30+
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
31+
with:
32+
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
33+
script: |
34+
var column_id = 13445681;
35+
try {
36+
github.projects.createCard({
37+
column_id: column_id,
38+
content_id: context.payload.issue.id,
39+
content_type: "Issue"
40+
});
41+
} catch (error) {
42+
console.log(error);
43+
}
44+
- if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic')
45+
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
46+
with:
47+
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
48+
script: |
49+
var column_id = 13445932;
50+
try {
51+
github.projects.createCard({
52+
column_id: column_id,
53+
content_id: context.payload.issue.id,
54+
content_type: "Issue"
55+
});
56+
} catch (error) {
57+
console.log(error);
58+
}

.github/workflows/test-windows.yml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# NOTE: Changes to this file should also be applied to './test.yml' and './test-translations.yml'
1+
# NOTE: Changes to this file should also be applied to './test.yml'
22

33
name: Node.js Tests - Windows
44

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

11+
env:
12+
CI: true
13+
1114
jobs:
1215
test:
1316
runs-on: windows-latest
1417
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')))
18+
timeout-minutes: 60
1519
strategy:
1620
fail-fast: false
1721
matrix:
1822
test-group: [content, graphql, meta, rendering, routing, unit]
1923
steps:
2024
- name: Check out repo
2125
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
26+
with:
27+
# Enables cloning the Early Access repo later with the relevant PAT
28+
persist-credentials: 'false'
2229

2330
- name: Setup node
2431
uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
@@ -41,7 +48,15 @@ jobs:
4148
- name: Install dependencies
4249
run: npm ci
4350

44-
- name: Run build script
51+
- if: ${{ github.repository == 'github/docs-internal' }}
52+
name: Clone early access
53+
run: npm run heroku-postbuild
54+
env:
55+
DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
56+
GIT_BRANCH: ${{ github.head_ref || github.ref }}
57+
58+
- if: ${{ github.repository != 'github/docs-internal' }}
59+
name: Run build script
4560
run: npm run build
4661

4762
- name: Run tests

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
run: npm run heroku-postbuild
7878
env:
7979
DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
80-
GIT_BRANCH: ${{ github.ref }}
80+
GIT_BRANCH: ${{ github.head_ref || github.ref }}
8181

8282
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository != 'github/docs-internal' }}
8383
name: Run build script
-30.4 KB
Binary file not shown.
Loading
Loading
Loading
Loading
Loading
Loading
Binary file not shown.
Loading

content/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,9 +228,9 @@ includeGuides:
228228
- Optional.
229229

230230
### `topics`
231-
- Purpose: Indicate the topics covered by the article.
232-
- Type: `String`
233-
- Optional.
231+
- Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of [this page](https://docs.github.com/en/actions/guides) can be filtered by topics and the topics are listed under the guide intro. Topics are also added to all search records that get created for each page. The search records contain a `topics` property that is used to filter search results by topics. For more information, see the [Search](/contributing/search.md) contributing guide. Refer to the content models for more details around adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/tests/unit/search/topics.js) will fail.
232+
- Type: Array of `String`s
233+
- Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics or a adding a topic to a new article may not add value.
234234

235235
### `contributor`
236236
- Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Adding labels to issues
3+
intro: You can use {% data variables.product.prodname_actions %} to automatically label issues.
4+
product: '{% data reusables.gated-features.actions %}'
5+
versions:
6+
free-pro-team: '*'
7+
enterprise-server: '>=2.22'
8+
github-ae: '*'
9+
type: 'tutorial'
10+
topics:
11+
- 'Workflows'
12+
- 'Project management'
13+
---
14+
15+
{% data reusables.actions.enterprise-beta %}
16+
{% data reusables.actions.enterprise-github-hosted-runners %}
17+
{% data reusables.actions.ae-beta %}
18+
{% data reusables.actions.ae-self-hosted-runners-notice %}
19+
20+
### Introduction
21+
22+
This tutorial demonstrates how to use the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler) in a workflow to label newly opened or reopened issues. For example, you can add the `triage` label every time an issue is opened or reopened. Then, you can see all issues that need to be triaged by filtering for issues with the `triage` label.
23+
24+
In the tutorial, you will first make a workflow file that uses the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler). Then, you will customize the workflow to suit your needs.
25+
26+
### Creating the workflow
27+
28+
1. {% data reusables.actions.choose-repo %}
29+
2. {% data reusables.actions.make-workflow-file %}
30+
3. Copy the following YAML contents into your workflow file.
31+
32+
{% raw %}
33+
```yaml{:copy}
34+
name: Label issues
35+
on:
36+
issues:
37+
types:
38+
- reopened
39+
- opened
40+
jobs:
41+
label_issues:
42+
runs-on: ubuntu-latest
43+
steps:
44+
- name: Label issues
45+
uses: andymckay/[email protected]
46+
with:
47+
add-labels: "triage"
48+
```
49+
{% endraw %}
50+
4. Customize the parameters in your workflow file:
51+
- Change the value for `add-labels` to the list of labels that you want to add to the issue. Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information about labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)."
52+
5. {% data reusables.actions.commit-workflow %}
53+
54+
### Testing the workflow
55+
56+
Every time an issue in your repository is opened or reopened, this workflow will add the labels that you specified to the issue.
57+
58+
Test out your workflow by creating an issue in your repository.
59+
60+
1. Create an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)."
61+
2. To see the workflow run that was triggered by creating the issue, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)."
62+
3. When the workflow completes, the issue that you created should have the specified labels added.
63+
64+
### Next steps
65+
66+
- To learn more about additional things you can do with the `andymckay/labeler` action, like removing labels or skipping this action if the issue is assigned or has a specific label, see the [`andymckay/labeler` action documentation](https://github.com/marketplace/actions/simple-issue-labeler).
67+
- To learn more about different events that can trigger your workflow, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#issues)." The `andymckay/labeler` action only works on `issues`, `pull_request`, or `project_card` events.
68+
- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action.

0 commit comments

Comments
 (0)