Skip to content

Commit bd399cf

Browse files
authored
Merge pull request #32216 from github/repo-sync
Repo sync
2 parents 14f9bfe + 3835fde commit bd399cf

15 files changed

+71
-83
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Install CocoFix
2+
3+
description: Installs the private package `@github/cocofix` from the GitHub Package Registry.
4+
5+
inputs:
6+
token:
7+
description: PAT
8+
required: true
9+
10+
runs:
11+
using: 'composite'
12+
steps:
13+
- name: Install CoCoFix
14+
shell: bash
15+
env:
16+
TOKEN: ${{ inputs.token }}
17+
run: |
18+
npm install --no-save \
19+
'--@github:registry=https://npm.pkg.github.com' \
20+
'--//npm.pkg.github.com/:_authToken=${TOKEN}' \
21+
@github/cocofix

.github/workflows/generate-code-scanning-query-lists.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ jobs:
6060
sleep 3
6161
codeql --version
6262
63+
- uses: ./.github/actions/install-cocofix
64+
with:
65+
token: ${{ secrets.DOCS_BOT_PAT_WORKFLOW }}
66+
6367
- name: Build code scanning query list
6468
run: |
6569
for lang in "cpp" "csharp" "go" "java" "javascript" "python" "ruby" "swift"; do

.github/workflows/lint-code.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,9 @@ jobs:
4545
- name: Run Prettier
4646
run: npm run prettier-check
4747

48+
- uses: ./.github/actions/install-cocofix
49+
with:
50+
token: ${{ secrets.DOCS_BOT_PAT_WORKFLOW }}
51+
4852
- name: Run TypeScript
4953
run: npm run tsc
-35.9 KB
Binary file not shown.
-52.3 KB
Binary file not shown.
Binary file not shown.

content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ shortTitle: Troubleshoot a custom domain
1818

1919
## CNAME errors
2020

21-
{% ifversion pages-custom-workflow %}If you are publishing from a custom {% data variables.product.prodname_actions %} workflow, any CNAME file is ignored and is not required.{% endif %}
21+
If you are publishing from a custom {% data variables.product.prodname_actions %} workflow, any CNAME file is ignored and is not required.
2222

2323
If you are publishing from a branch, custom domains are stored in a CNAME file in the root of your publishing source. You can add or update this file through your repository settings or manually. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)."
2424

content/pages/getting-started-with-github-pages/about-github-pages.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -91,20 +91,10 @@ For more information about {% data variables.product.prodname_emus %}, see "[AUT
9191

9292
{% data variables.product.prodname_pages %} publishes any static files that you push to your repository. You can create your own static files or use a static site generator to build your site for you. You can also customize your own build process locally or on another server.
9393

94-
{% ifversion pages-custom-workflow %}
95-
9694
If you use a custom build process or a static site generator other than Jekyll, you can write a {% data variables.product.prodname_actions %} to build and publish your site. {% data variables.product.product_name %} provides starter workflows for several static site generators. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."
9795

9896
If you publish your site from a source branch, {% data variables.product.prodname_pages %} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, we recommend that you write a {% data variables.product.prodname_actions %} to build and publish your site instead. Otherwise, disable the Jekyll build process by creating an empty file called `.nojekyll` in the root of your publishing source, then follow your static site generator's instructions to build your site locally.
9997

100-
{% else %}
101-
102-
We recommend Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll)."
103-
104-
{% data variables.product.prodname_pages %} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, disable the Jekyll build process by creating an empty file called `.nojekyll` in the root of your publishing source, then follow your static site generator's instructions to build your site locally.
105-
106-
{% endif %}
107-
10898
{% data variables.product.prodname_pages %} does not support server-side languages such as PHP, Ruby, or Python.
10999

110100
## Limits on use of {% data variables.product.prodname_pages %}
@@ -132,7 +122,7 @@ Using {% data variables.product.prodname_pages %} to create a copy of an existin
132122
- {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes.
133123
{% ifversion fpt or ghec %}
134124
- {% data variables.product.prodname_pages %} sites have a _soft_ bandwidth limit of 100 GB per month.
135-
- {% data variables.product.prodname_pages %} sites have a _soft_ limit of 10 builds per hour.{% ifversion pages-custom-workflow %} This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow {% endif %}
125+
- {% data variables.product.prodname_pages %} sites have a _soft_ limit of 10 builds per hour. This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow.
136126
- In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body.
137127

138128
If your site exceeds these usage quotas, we may not be able to serve your site, or you may receive a polite email from {% data variables.contact.github_support %} suggesting strategies for reducing your site's impact on our servers, including putting a third-party content distribution network (CDN) in front of your site, making use of other {% data variables.product.prodname_dotcom %} features such as releases, or moving to a different hosting service that might better fit your needs.

content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configuring a publishing source for your GitHub Pages site
3-
intro: '{% ifversion pages-custom-workflow %}You can configure your {% data variables.product.prodname_pages %} site to publish when changes are pushed to a specific branch, or you can write a {% data variables.product.prodname_actions %} workflow to publish your site.{% else%}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 site from a different branch or folder.{% endif %}'
3+
intro: 'You can configure your {% data variables.product.prodname_pages %} site to publish when changes are pushed to a specific branch, or you can write a {% data variables.product.prodname_actions %} workflow to publish your site.'
44
redirect_from:
55
- /articles/configuring-a-publishing-source-for-github-pages
66
- /articles/configuring-a-publishing-source-for-your-github-pages-site
@@ -28,26 +28,17 @@ shortTitle: Configure publishing source
2828
{% data reusables.pages.navigate-site-repo %}
2929
{% data reusables.repositories.sidebar-settings %}
3030
{% data reusables.pages.sidebar-pages %}
31-
{% ifversion pages-custom-workflow %}
3231
1. Under "Build and deployment", under "Source", select **Deploy from a branch**.
3332
1. Under "Build and deployment", use the branch dropdown menu and select a publishing source.
3433
![Screenshot of Pages settings in a {% data variables.product.prodname_dotcom %} repository. A menu to select a branch for a publishing source, labeled "None," is outlined in dark orange.](/assets/images/help/pages/publishing-source-drop-down.png)
35-
{% else %}
36-
1. Under "{% data variables.product.prodname_pages %}", use the branch dropdown menu and select a publishing source.
37-
![Screenshot of Pages settings in a {% data variables.product.prodname_dotcom %} repository. A menu to select a branch for a publishing source, labeled "None," is outlined in dark orange.](/assets/images/help/pages/publishing-source-drop-down.png)
38-
{% endif %}
3934
1. Optionally, use the folder dropdown menu to select a folder for your publishing source.
4035
![Screenshot of Pages settings in a {% data variables.product.prodname_dotcom %} repository. A menu to select a folder for a publishing source, labeled "/(root)," is outlined in dark orange.](/assets/images/help/pages/publishing-source-folder-drop-down.png)
4136
1. Click **Save**.
4237

4338
### Troubleshooting publishing from a branch
4439

45-
{% ifversion pages-disable-symlinks-on-legacy-pages %}
46-
4740
{% data reusables.pages.symlink-removal %}
4841

49-
{% endif %}
50-
5142
{% data reusables.pages.admin-must-push %}
5243

5344
If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)."
@@ -60,8 +51,6 @@ To find potential errors with either the build or deployment, you can check the
6051

6152
{% endif %}
6253

63-
{% ifversion pages-custom-workflow %}
64-
6554
## Publishing with a custom {% data variables.product.prodname_actions %} workflow
6655

6756
To configure your site to publish with {% data variables.product.prodname_actions %}:
@@ -99,5 +88,3 @@ The starter workflows use a deployment environment called `github-pages`. If you
9988
### Troubleshooting publishing with a custom {% data variables.product.prodname_actions %} workflow
10089

10190
For information about how to troubleshoot your {% data variables.product.prodname_actions %} workflow, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)."
102-
103-
{% endif %}

content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,9 @@ shortTitle: Create a GitHub Pages site
4242
{% data reusables.pages.decide-publishing-source %}
4343
1. Create the entry file for your site. {% data variables.product.prodname_pages %} will look for an `index.html`, `index.md`, or `README.md` file as the entry file for your site.
4444

45-
{% ifversion pages-custom-workflow %}If your publishing source is a branch and folder, the entry file must be at the top level of the source folder on the source branch. For example, if your publishing source is the `/docs` folder on the `main` branch, your entry file must be located in the `/docs` folder on a branch called `main`.
45+
If your publishing source is a branch and folder, the entry file must be at the top level of the source folder on the source branch. For example, if your publishing source is the `/docs` folder on the `main` branch, your entry file must be located in the `/docs` folder on a branch called `main`.
4646

47-
If your publishing source is a {% data variables.product.prodname_actions %} workflow, the artifact that you deploy must include the entry file at the top level of the artifact. Instead of adding the entry file to your repository, you may choose to have your {% data variables.product.prodname_actions %} workflow generate your entry file when the workflow runs.{% else %}
48-
The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` folder on the `main` branch, your entry file must be located in the `/docs` folder on a branch called `main`.{% endif %}
47+
If your publishing source is a {% data variables.product.prodname_actions %} workflow, the artifact that you deploy must include the entry file at the top level of the artifact. Instead of adding the entry file to your repository, you may choose to have your {% data variables.product.prodname_actions %} workflow generate your entry file when the workflow runs.
4948
{% data reusables.pages.configure-publishing-source %}
5049
{% data reusables.repositories.sidebar-settings %}
5150
{% data reusables.pages.sidebar-pages %}

0 commit comments

Comments
 (0)