Skip to content

Commit

Permalink
Fix multiple blank lines in content and data (#37909)
Browse files Browse the repository at this point in the history
  • Loading branch information
gracepark authored Jun 22, 2023
1 parent 88ec8b0 commit 6ff9dc2
Show file tree
Hide file tree
Showing 326 changed files with 4 additions and 406 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ If you choose to hide your private contributions, visitors will only see your pu
{% data reusables.profile.access_profile %}
1. Under "Contributions & Activity", select or deselect **Include private contributions on my profile**.


## Changing the visibility of achievements

{% data reusables.user-settings.access_settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ In the "All activity" section of your news feed, you can view updates from repos
You'll see updates in your news feed when a user you follow:
{% endif %}


- Stars a repository.
- Follows another user.{% ifversion fpt or ghes or ghec %}
- Creates a public repository.{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,3 @@ This pattern is employed in several actions. For more examples, see:
- [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby)
- [`google-github-actions/setup-gcloud`](https://github.com/google-github-actions/setup-gcloud)
- [`hashicorp/setup-terraform`](https://github.com/hashicorp/setup-terraform)

Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,3 @@ To remove a published action from {% data variables.product.prodname_marketplace
Actions with the {% octicon "verified" aria-label="The verified badge" %}, or verified creator badge, indicate that {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization. Partners can email <a href="mailto:partnerships@github.com">partnerships@github.com</a> to request the verified creator badge.

![Screenshot of {% data variables.product.prodname_actions %} with the verified creator badge.](/assets/images/marketplace/verified-creator-badge-for-actions.png)

Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,3 @@ You can configure your CD workflow to run when a {% data variables.product.produ
- [AUTOTITLE](/actions/deployment/about-deployments/deploying-with-github-actions)
- [AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment){% ifversion fpt or ghec %}
- "[AUTOTITLE](/billing/managing-billing-for-github-actions)"{% endif %}

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ topics:

{% data reusables.actions.enterprise-github-hosted-runners %}


## Introduction

This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a project to [Azure Kubernetes Service](https://azure.microsoft.com/services/kubernetes-service/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ topics:

{% data reusables.actions.enterprise-github-hosted-runners %}


## Introduction

This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a web app to [Azure Static Web Apps](https://azure.microsoft.com/services/app-service/static/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,6 @@ You could also use a `curl` command to request the JWT, using the following envi
| `ACTIONS_ID_TOKEN_REQUEST_URL` | The URL for {% data variables.product.prodname_dotcom %}'s OIDC provider. |
| `ACTIONS_ID_TOKEN_REQUEST_TOKEN` | Bearer token for the request to the OIDC provider. |


For example:

```shell copy
Expand Down Expand Up @@ -464,7 +463,6 @@ To configure the repository to use the organization's template, a repository adm

You can now update your YAML workflows to use OIDC access tokens instead of secrets. Popular cloud providers have published their official login actions that make it easy for you to get started with OIDC. For more information about updating your workflows, see the cloud-specific guides listed below in "[Enabling OpenID Connect for your cloud provider](#enabling-openid-connect-for-your-cloud-provider)."


## Enabling OpenID Connect for your cloud provider

To enable and configure OIDC for your specific cloud provider, see the following guides:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ In the following example, `StringLike` is used with a wildcard operator (`*`) to
}
```


## Updating your {% data variables.product.prodname_actions %} workflow

To update your workflows for OIDC, you will need to make two changes to your YAML:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,6 @@ Variables stored in an environment are only available to workflow jobs that refe
1. Click **Add variable**.
{%- endif %}


You can also create and configure environments through the REST API. For more information, see "[AUTOTITLE](/rest/deployments/environments)," "[AUTOTITLE](/rest/actions/secrets),"{% ifversion actions-configuration-variables %} "[AUTOTITLE](/rest/actions/variables),"{% endif %} and "[AUTOTITLE](/rest/deployments/branch-policies)."

Running a workflow that references an environment that does not exist will create an environment with the referenced name. The newly created environment will not have any protection rules or secrets configured. Anyone that can edit workflows in the repository can create environments via a workflow file, but only repository admins can configure the environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,6 @@ Modifies the default permissions granted to `GITHUB_TOKEN`. This will vary depen
<tr>
<td>


```yaml copy
concurrency:
group: {% raw %}'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'{% endraw %}
Expand Down Expand Up @@ -527,7 +526,6 @@ This step runs a command to check out LFS objects from the repository.
<tr>
<td>


```yaml copy
- name: Gather files changed
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ The following diagram illustrates the architecture of ARC's autoscaling runner s
10. Throughout the job run execution, the runner continuously communicates the logs and job run status back to the {% data variables.product.prodname_actions %} Service.
11. When the runner completes its job successfully, the EphemeralRunner Controller checks with the {% data variables.product.prodname_actions %} Service to see if runner can be deleted. If it can, the Ephemeral RunnerSet deletes the runner.


## {% data variables.product.prodname_actions_runner_controller %} components

This comment was marked as spam.

Copy link
@S-Nion

S-Nion May 18, 2024

Its Really good


ARC consists of a set of custom resources. An ARC deployment applies these custom resources onto a Kubernetes cluster. Once applied, it creates a set of Pods that contain your self-hosted runners' containers. With ARC, {% data variables.product.company_short %} can treat these runner containers as self-hosted runners and allocate jobs to them as needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ defaultPlatform: linux

You can authenticate {% data variables.product.prodname_actions_runner_controller %} (ARC) to the {% data variables.product.prodname_dotcom %} API by using a {% data variables.product.prodname_github_app %} or by using a {% data variables.product.pat_v1 %}.


{% note %}

**Note:** You cannot authenticate using a {% data variables.product.prodname_github_app %} for runners at the enterprise level. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#about-runner-groups)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managin

You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner. For information about how to add a self-hosted runner with the REST API, see "[AUTOTITLE](/rest/actions#self-hosted-runners)."


{% data reusables.organizations.navigate-to-org %}
{% data reusables.organizations.org_settings %}
{% data reusables.organizations.settings-sidebar-actions-runners %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ ACTIONS_RUNNER_HOOK_JOB_STARTED=/cleanup_script.sh

## Troubleshooting


### No timeout setting

There is currently no timeout setting available for scripts executed by `ACTIONS_RUNNER_HOOK_JOB_STARTED` or `ACTIONS_RUNNER_HOOK_JOB_COMPLETED`. As a result, you could consider adding timeout handling to your script.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ jobs:

For some examples of Docker actions, see the [Docker-image.yml workflow](https://github.com/actions/starter-workflows/blob/main/ci/docker-image.yml) and "[AUTOTITLE](/actions/creating-actions/creating-a-docker-container-action)."


## Using release management for your custom actions

The creators of a community action have the option to use tags, branches, or SHA values to manage releases of the action. Similar to any dependency, you should indicate the version of the action you'd like to use based on your comfort with automatically accepting updates to the action.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ By default, {% data variables.product.product_name %} stores build logs and arti

![Screenshot of the "Artifacts" section of a workflow run. The name of an artifact generated by the run, "artifact," is highlighted with a dark orange outline.](/assets/images/help/repository/artifact-drop-down-updated.png)


{% endwebui %}

{% cli %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ shortTitle: Remove workflow artifacts

![Screenshot showing artifacts created during a workflow run. A trash can icon, used to remove an artifact, is outlined in dark orange.](/assets/images/help/repository/actions-delete-artifact-updated.png)


## Setting the retention period for an artifact

Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see {% ifversion fpt or ghec or ghes %}"[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy)."{% elsif ghae %}"[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)," "[AUTOTITLE](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)," or "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)."{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -468,7 +468,6 @@ You can transform Azure DevOps templates with {% data variables.product.prodname
| Iterative insertion | Not applicable | Partially supported |
| Templates with parameters | Varies | Partially supported |


#### Template file path names

{% data variables.product.prodname_actions_importer %} can extract templates with relative or dynamic file paths with variable, parameter, and iterative expressions in the file name. However, there must be a default value set.
Expand Down Expand Up @@ -535,7 +534,6 @@ steps:
| stage | `job` | Partially supported |
| stageList | `job` | Partially supported |


{% note %}

**Note:** A template used under the `step` key with this parameter type is only serialized as a composite action if the steps are used at the beginning or end of the template steps. A template used under the `stage`, `deployment`, and `job` keys with this parameter type are not transformed into a reusable workflow, and instead are serialized as a standalone workflow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,6 @@ For example:
gh actions-importer forecast bamboo --project PAN --output-dir tmp/forecast_reports
```


### Inspecting the forecast report

The `forecast_report.md` file in the specified output directory contains the results of the forecast.
Expand Down Expand Up @@ -373,7 +372,6 @@ For more information about supported Bamboo concept and plugin mappings, see the
| `bamboo.shortPlanKey` | {% raw %}`${{ github.workflow }}`{% endraw %}
| `bamboo.shortPlanName` | {% raw %}`${{ github.workflow }}`{% endraw %}


{% note %}

**Note:** Unknown variables are transformed to {% raw %}`${{ env.<variableName> }}`{% endraw %} and must be replaced or added under `env` for proper operation. For example, `${bamboo.jira.baseUrl}` will become {% raw %}`${{ env.jira_baseUrl }}`{% endraw %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,6 @@ For information about supported GitLab constructs, see the [`github/gh-actions-i
| `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME` | {% raw %}`${{ github.event.pull_request.base.ref }}`{% endraw %} |
| `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA` | {% raw %}`${{ github.event.pull_request.base.sha }}`{% endraw %} |


## Legal notice

{% data reusables.actions.actions-importer-legal-notice %}
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ Both Azure Pipelines and {% data variables.product.prodname_actions %} allow you

Below is an example of the syntax for each system. The workflows start a first job named `initial`, and when that job completes, two jobs named `fanout1` and `fanout2` will run. Finally, when those jobs complete, the job `fanin` will run.


### Azure Pipelines syntax for dependencies between jobs

{% raw %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ CircleCI can reuse pieces of workflows with YAML anchors and aliases. {% data va

## Using Docker images


Both CircleCI and {% data variables.product.prodname_actions %} support running steps inside of a Docker image.

CircleCI provides a set of pre-built images with common dependencies. These images have the `USER` set to `circleci`, which causes permissions to conflict with {% data variables.product.prodname_actions %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,5 +402,4 @@ jobs:
```
{% endraw %}
For more information, see "[AUTOTITLE](/actions/using-containerized-services/about-service-containers)."
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ on:
```
{% endraw %}
### Checking out submodules
Travis CI and {% data variables.product.prodname_actions %} both allow you to control whether submodules are included in the repository clone.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ versions:

{% data reusables.repositories.actions-workflow-status-badge-intro %}


To add a workflow status badge to your `README.md` file, first find the URL for the status badge you would like to display. Then you can use Markdown to display the badge as an image in your `README.md` file. For more information about image markup in Markdown, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)."

## Using the workflow file name
Expand Down
1 change: 0 additions & 1 deletion content/actions/using-jobs/running-jobs-in-a-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ versions:
## Setting container resource options

{% data reusables.actions.jobs.section-running-jobs-in-a-container-options %}

Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ If there is an exact match to the provided `key`, this is considered a cache hit

You cannot change the contents of an existing cache. Instead, you can create a new cache with a new key.


### Input parameters for the `cache` action

- `key`: **Required** The key created when saving a cache and the key used to search for a cache. It can be any combination of variables, context values, static strings, and functions. Keys have a maximum length of 512 characters, and keys longer than the maximum length will cause the action to fail.
Expand Down
2 changes: 0 additions & 2 deletions content/actions/using-workflows/required-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ After a required workflow has run at least once in a repository, you can view it

![Screenshot of the sidebar on the "Actions" page. A subsection, labeled "Required workflows", contains an entry called "Test required workflow" and is outlined in dark orange.](/assets/images/help/settings/view-required-workflows.png)



## Adding a required workflow to an organization

Organization owners can configure required workflows in their organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#adding-a-required-workflow-to-an-organization)."
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,6 @@ Alternatively, use a {% data variables.product.prodname_github_app %} instead of

## `jobs.<job_id>.steps[*].run`


Runs command-line programs using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command.

Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see [`jobs.<job_id>.steps[*].shell`](#jobsjob_idstepsshell).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ topics:
<!--The CodeQL CLI man pages include a link to a section in this article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/configuring-ghes.-->


{% data reusables.code-scanning.beta %}

## About {% data variables.product.prodname_code_scanning %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,3 @@ The dependency review action is included in your installation of {% data variabl
{% data reusables.dependency-review.dependency-review-action-overview %}

Users run the dependency review action using a {% data variables.product.prodname_actions %} workflow. If you have not already set up runners for {% data variables.product.prodname_actions %}, you must do this to enable users to run workflows. You can provision self-hosted runners at the repository, organization, or enterprise account level. For information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."

Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,3 @@ When you enable one or more security and analysis features for existing reposito
{% endnote %}

![Screenshot of the "Push protection" section of the settings for security and analysis features. The checkbox and the text field used for enabling a custom link are outlined in dark orange.](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %}

Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ The root site administrator can unlock access to the {% data variables.enterpris
{% data reusables.enterprise_site_admin_settings.click-user-management %}
1. Locked user accounts will appear as "State: blocked". To unblock the user and allow authentication, to the right of the user's details, click {% octicon "law" aria-label="Unblock user" %}.


{%- endif %}

## Troubleshooting failed connections to the {% data variables.enterprise.management_console %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,6 @@ This command disables replication on an existing replica node and converts the r
ghe-repl-promote
```
### ghe-repl-setup
Run this utility on an existing node to begin enabling a high availability configuration. The utility puts the node in standby mode before you begin replication with [`ghe-repl-start`](#ghe-repl-start). For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica)."
Expand Down Expand Up @@ -1016,8 +1015,6 @@ This utility rewrites the imported repository. This gives you a chance to rename
git-import-rewrite
```
## Security
### ghe-find-insecure-git-operations
Expand All @@ -1028,8 +1025,6 @@ This utility searches your instance's logs and identifies Git operations over SS
ghe-find-insecure-git-operations
```
## Support
### ghe-diagnostics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ During initialization, the enterprise owner will name your enterprise, configure

To begin initialization, you will receive an invitation email from {% data variables.product.company_short %}. Before you configure {% data variables.product.prodname_ghe_managed %}, review the following prerequisites.


To initialize {% data variables.location.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)."

{% note %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,3 @@ If you review the troubleshooting advice for replication and continue to experie

- On each affected node, run `ghe-repl-status -vv`, then copy the output to your ticket. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-repl-status)."
- On each affected node, create a support bundle to attach to your ticket. For more information, see "[AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)."




Loading

2 comments on commit 6ff9dc2

@Hobika123

This comment was marked as spam.

@Hobika123

This comment was marked as spam.

Please sign in to comment.