Skip to content

Commit 468dc59

Browse files
lecoursenPeter Bengtsson
andauthored
Add row headers to tables (#35685)
Co-authored-by: Peter Bengtsson <peterbe@github.com>
1 parent 0ee5a5e commit 468dc59

12 files changed

Lines changed: 75 additions & 14 deletions

File tree

content/actions/automating-builds-and-tests/building-and-testing-powershell.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ shortTitle: Build & test PowerShell
2424

2525
This guide shows you how to use PowerShell for CI. It describes how to use Pester, install dependencies, test your module, and publish to the PowerShell Gallery.
2626

27-
{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester.
27+
{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester.
2828

2929
{% ifversion ghae %}
3030
{% data reusables.actions.self-hosted-runners-software %}
@@ -71,9 +71,9 @@ jobs:
7171
* `run: Test-Path resultsfile.log` - Check whether a file called `resultsfile.log` is present in the repository's root directory.
7272
* `Should -Be $true` - Uses Pester to define an expected result. If the result is unexpected, then {% data variables.product.prodname_actions %} flags this as a failed test. For example:
7373

74-
74+
7575
![Screenshot of a workflow run failure for a Pester test. Test reports "Expected $true, but got $false" and "Error: Process completed with exit code 1."](/assets/images/help/repository/actions-failed-pester-test-updated.png)
76-
76+
7777

7878
* `Invoke-Pester Unit.Tests.ps1 -Passthru` - Uses Pester to execute tests defined in a file called `Unit.Tests.ps1`. For example, to perform the same test described above, the `Unit.Tests.ps1` will contain the following:
7979
```
@@ -88,12 +88,16 @@ jobs:
8888
8989
The table below describes the locations for various PowerShell modules in each {% data variables.product.prodname_dotcom %}-hosted runner.
9090
91+
{% rowheaders %}
92+
9193
|| Ubuntu | macOS | Windows |
9294
|------|-------|------|----------|
9395
|**PowerShell system modules** |`/opt/microsoft/powershell/7/Modules/*`|`/usr/local/microsoft/powershell/7/Modules/*`|`C:\program files\powershell\7\Modules\*`|
9496
|**PowerShell add-on modules**|`/usr/local/share/powershell/Modules/*`|`/usr/local/share/powershell/Modules/*`|`C:\Modules\*`|
9597
|**User-installed modules**|`/home/runner/.local/share/powershell/Modules/*`|`/Users/runner/.local/share/powershell/Modules/*`|`C:\Users\runneradmin\Documents\PowerShell\Modules\*`|
9698
99+
{% endrowheaders %}
100+
97101
## Installing dependencies
98102
99103
{% data variables.product.prodname_dotcom %}-hosted runners have PowerShell 7 and Pester installed. You can use `Install-Module` to install additional dependencies from the PowerShell Gallery before building and testing your code.

content/actions/automating-builds-and-tests/building-and-testing-python.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,16 @@ Using the `setup-python` action is the recommended way of using Python with {% d
8989

9090
The table below describes the locations for the tools cache in each {% data variables.product.prodname_dotcom %}-hosted runner.
9191

92+
{% rowheaders %}
93+
9294
|| Ubuntu | Mac | Windows |
9395
|------|-------|------|----------|
9496
|**Tool Cache Directory** |`/opt/hostedtoolcache/*`|`/Users/runner/hostedtoolcache/*`|`C:\hostedtoolcache\windows\*`|
9597
|**Python Tool Cache**|`/opt/hostedtoolcache/Python/*`|`/Users/runner/hostedtoolcache/Python/*`|`C:\hostedtoolcache\windows\Python\*`|
9698
|**PyPy Tool Cache**|`/opt/hostedtoolcache/PyPy/*`|`/Users/runner/hostedtoolcache/PyPy/*`|`C:\hostedtoolcache\windows\PyPy\*`|
9799

100+
{% endrowheaders %}
101+
98102
If you are using a self-hosted runner, you can configure the runner to use the `setup-python` action to manage your dependencies. For more information, see [using setup-python with a self-hosted runner](https://github.com/actions/setup-python#using-setup-python-with-a-self-hosted-runner) in the `setup-python` README.
99103

100104
{% data variables.product.prodname_dotcom %} supports semantic versioning syntax. For more information, see "[Using semantic versioning](https://docs.npmjs.com/about-semantic-versioning#using-semantic-versioning-to-specify-update-types-your-package-can-accept)" and the "[Semantic versioning specification](https://semver.org/)."
@@ -372,7 +376,7 @@ jobs:
372376

373377
## Publishing to package registries
374378

375-
You can configure your workflow to publish your Python package to a package registry once your CI tests pass. This section demonstrates how you can use {% data variables.product.prodname_actions %} to upload your package to PyPI each time you [publish a release](/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
379+
You can configure your workflow to publish your Python package to a package registry once your CI tests pass. This section demonstrates how you can use {% data variables.product.prodname_actions %} to upload your package to PyPI each time you [publish a release](/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
376380

377381
For this example, you will need to create two [PyPI API tokens](https://pypi.org/help/#apitoken). You can use secrets to store the access tokens or credentials needed to publish your package. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)."
378382

content/actions/creating-actions/about-custom-actions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,16 @@ Actions can run directly on a machine or in a Docker container. You can define a
3535

3636
You can build Docker container, JavaScript, and composite actions. Actions require a metadata file to define the inputs, outputs and main entrypoint for your action. The metadata filename must be either `action.yml` or `action.yaml`. For more information, see "[AUTOTITLE](/actions/creating-actions/metadata-syntax-for-github-actions)."
3737

38+
{% rowheaders %}
39+
3840
| Type | Linux | macOS | Windows |
3941
| ---- | ----- | ----- | -------- |
4042
| Docker container | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} |
4143
| JavaScript | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
4244
| Composite Actions | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
4345

46+
{% endrowheaders %}
47+
4448
### Docker container actions
4549

4650
Docker containers package the environment with the {% data variables.product.prodname_actions %} code. This creates a more consistent and reliable unit of work because the consumer of the action does not need to worry about the tools or dependencies.

content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,17 @@ The following repositories have detailed instructions for setting up these autos
2828

2929
Each solution has certain specifics that may be important to consider.
3030

31-
| **Features** | **actions-runner-controller** | **terraform-aws-github-runner** |
31+
{% rowheaders %}
32+
33+
| | actions-runner-controller | terraform-aws-github-runner |
3234
| :--- | :--- | :--- |
3335
| Runtime | Kubernetes | Linux and Windows VMs |
3436
| Supported Clouds | Azure, Amazon Web Services, Google Cloud Platform, on-premises | Amazon Web Services |
3537
| Where runners can be scaled | Enterprise, organization, and repository levels. By runner label and runner group. | Organization and repository levels. By runner label and runner group. |
3638
| How runners can be scaled | Webhook events, Scheduled, Pull-based | Webhook events, Scheduled (org-level runners only) |
3739

40+
{% endrowheaders %}
41+
3842
## Using ephemeral runners for autoscaling
3943

4044
{% data variables.product.prodname_dotcom %} recommends implementing autoscaling with ephemeral self-hosted runners; autoscaling with persistent self-hosted runners is not recommended. In certain cases, {% data variables.product.prodname_dotcom %} cannot guarantee that jobs are not assigned to persistent runners while they are shut down. With ephemeral runners, this can be guaranteed because {% data variables.product.prodname_dotcom %} only assigns one job to a runner.

content/actions/security-guides/automatic-token-authentication.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ For information about the API endpoints {% data variables.product.prodname_githu
7777

7878
The following table shows the permissions granted to the `GITHUB_TOKEN` by default. People with admin permissions to an {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository{% endif %} can set the default permissions to be either permissive or restricted. For information on how to set the default permissions for the `GITHUB_TOKEN` for your enterprise, organization, or repository, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)," "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)," or "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
7979

80+
{% rowheaders %}
81+
8082
| Scope | Default access<br>(permissive) | Default access<br>(restricted) | Maximum access for<br>pull requests from<br>public forked repositories [1] |
8183
|---------------|-----------------------------|-----------------------------|--------------------------------|
8284
| actions | read/write | none | read |
@@ -93,6 +95,8 @@ The following table shows the permissions granted to the `GITHUB_TOKEN` by defau
9395
| security-events | read/write | none | read |
9496
| statuses | read/write | none | read |
9597

98+
{% endrowheaders %}
99+
96100
[1] Private repositories can control if pull requests from forks can run workflows, and configure the permissions assigned to `GITHUB_TOKEN`. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories)."
97101

98102
{% data reusables.actions.workflow-runs-dependabot-note %}

content/apps/creating-github-apps/creating-github-apps/differences-between-github-apps-and-oauth-apps.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ An _authorized_ OAuth App has access to all of the user's or organization owner'
7373

7474
Unlike OAuth apps, GitHub Apps have targeted permissions that allow them to request access only to what they need. For example, a Continuous Integration (CI) GitHub App can request read access to repository content and write access to the status API. Another GitHub App can have no read or write access to code but still have the ability to manage issues, labels, and milestones. OAuth Apps can't use granular permissions.
7575

76+
{% rowheaders %}
77+
7678
| Access | GitHub Apps (`read` or `write` permissions) | OAuth Apps |
7779
| ------ | ----- | ----------- |
7880
| **For access to public repositories** | Public repository needs to be chosen during installation. | `public_repo` scope. |
@@ -83,6 +85,8 @@ Unlike OAuth apps, GitHub Apps have targeted permissions that allow them to requ
8385
| **For access to deployments and deployment statuses** | Deployments | `repo_deployment` scope. |
8486
| **To receive events via a webhook** | A GitHub App includes a webhook by default. | `write:repo_hook` or `write:org_hook` scope. |
8587

88+
{% endrowheaders %}
89+
8690
## Repository discovery
8791

8892
| GitHub Apps | OAuth Apps |

content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ If you purchased {% data variables.product.prodname_enterprise %} through a Micr
3232

3333
Data transfer resets every month, while storage usage does not.
3434

35+
{% rowheaders %}
36+
3537
Product | Storage | Data transfer (per month)
3638
------- | ------- | ---------
3739
{% data variables.product.prodname_free_user %} | 500MB | 1GB
@@ -40,13 +42,19 @@ Product | Storage | Data transfer (per month)
4042
{% data variables.product.prodname_team %} | 2GB | 10GB
4143
{% data variables.product.prodname_ghe_cloud %} | 50GB | 100GB
4244

45+
{% endrowheaders %}
46+
4347
All data transferred out, when triggered by {% data variables.product.prodname_actions %}, and data transferred in from any source is free. We determine you are downloading packages using {% data variables.product.prodname_actions %} when you log in to {% data variables.product.prodname_registry %} using a `GITHUB_TOKEN`.
4448

49+
{% rowheaders %}
50+
4551
||Hosted|Self-Hosted|
4652
|-|-|-|
4753
|Access using a `GITHUB_TOKEN`|Free|Free|
4854
|Access using a {% data variables.product.pat_generic %}|Free|Paid|
4955

56+
{% endrowheaders %}
57+
5058
Storage usage is shared with build artifacts produced by {% data variables.product.prodname_actions %} for repositories owned by your account. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)."
5159

5260
{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.008 USD per GB of storage per day and $0.50 USD per GB of data transfer.

content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ For each `gzip`-compressed SARIF file, SARIF upload supports a maximum size of 1
106106

107107
{% ifversion fpt or ghec or ghes > 3.8 %}
108108

109+
{% rowheaders %}
110+
109111
| **SARIF data** | **Maximum values** | **Additional limits** |
110112
|----------------|:------------------:|-----------------------|
111113
| Runs per file | 20 | None |
@@ -116,8 +118,12 @@ For each `gzip`-compressed SARIF file, SARIF upload supports a maximum size of 1
116118
| Location per result | 1,000 | Only 100 locations will be included. |
117119
| Tags per rule | 20 | Only 10 tags will be included. |
118120

121+
{% endrowheaders %}
122+
119123
{% elsif ghes < 3.9 %}
120124

125+
{% rowheaders %}
126+
121127
| **SARIF data** | **Maximum values** | **Additional limits** |
122128
|----------------|:------------------:|-----------------------|
123129
| Runs per file | 15 | None |
@@ -128,8 +134,12 @@ For each `gzip`-compressed SARIF file, SARIF upload supports a maximum size of 1
128134
| Location per result | 1,000 | Only 100 locations will be included. |
129135
| Tags per rule | 20 | Only 10 tags will be included. |
130136

137+
{% endrowheaders %}
138+
131139
{% else %}
132140

141+
{% rowheaders %}
142+
133143
| **SARIF data** | **Maximum values** | **Additional limits** |
134144
|----------------|:------------------:|-----------------------|
135145
| Runs per file | 15 | None |
@@ -138,6 +148,8 @@ For each `gzip`-compressed SARIF file, SARIF upload supports a maximum size of 1
138148
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
139149
| Location per result | 1,000 | Only 100 locations will be included. | None |
140150

151+
{% endrowheaders %}
152+
141153
{% endif %}
142154

143155
## Supported SARIF output file properties

content/codespaces/the-githubdev-web-based-editor.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ You can open any {% data variables.product.prodname_dotcom %} repository in {% d
4848

4949
Both {% data variables.codespaces.serverless %} and {% data variables.product.prodname_github_codespaces %} allow you to edit your code straight from your repository. However, both have slightly different benefits, depending on your use case.
5050

51+
{% rowheaders %}
52+
5153
|| {% data variables.codespaces.serverless %} | {% data variables.product.prodname_github_codespaces %}|
5254
|-|----------------|---------|
5355
| **Cost** | Free. | Free monthly quota of usage for personal accounts. For information on pricing, see "[AUTOTITLE](/free-pro-team@latest/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-github-codespaces-pricing)."|
@@ -57,6 +59,8 @@ Both {% data variables.codespaces.serverless %} and {% data variables.product.pr
5759
| **Terminal access** | None. | {% data variables.product.prodname_github_codespaces %} provides a common set of tools by default, meaning that you can use the Terminal exactly as you would in your local environment.|
5860
| **Extensions** | Only a subset of extensions that can run in the web will appear in the Extensions View and can be installed. For more information, see "[Using extensions](#using-extensions)."| With {% data variables.product.prodname_github_codespaces %}, you can use most extensions from the {% data variables.product.prodname_vscode_marketplace %}.|
5961

62+
{% endrowheaders %}
63+
6064
### Continue working on {% data variables.product.prodname_codespaces %}
6165

6266
You can start your workflow in {% data variables.codespaces.serverless %} and continue working on a codespace. If you try to access the Run and Debug View or the Terminal, you'll be notified that they are not available in {% data variables.codespaces.serverless %}.
@@ -88,7 +92,7 @@ Because {% data variables.codespaces.serverless %} uses the GitHub Repositories
8892

8993
1. In the text box, type a commit message describing the change you've made.
9094

91-
![Screenshot of the "Source control" side bar with a commit message entered into the text box above the "Commit" button.](/assets/images/help/codespaces/githubdotdev-codespaces-commit-message.png)
95+
![Screenshot of the "Source control" side bar with a commit message entered into the text box above the "Commit" button.](/assets/images/help/codespaces/githubdotdev-codespaces-commit-message.png)
9296

9397
1. Click **Commit & Push**.
9498

content/get-started/learning-about-github/about-github-advanced-security.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,16 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th
3838
{% ifversion fpt or ghec %}
3939
The table below summarizes the availability of {% data variables.product.prodname_GH_advanced_security %} features for public and private repositories.
4040

41+
{% rowheaders %}
42+
4143
| | Public repository | Private repository <br>without {% data variables.product.prodname_advanced_security %} | Private repository <br>with {% data variables.product.prodname_advanced_security %} |
4244
| --- | --- | --- | --- |
4345
| Code scanning | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
4446
| Secret scanning | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
4547
| Dependency review | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
48+
49+
{% endrowheaders %}
50+
4651
{% endif %}
4752

4853
For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[AUTOTITLE](/code-security/getting-started/github-security-features)."

0 commit comments

Comments
 (0)