Merge pull request #23170 from github/repo-sync

repo sync

Author: Octomerger

assets/images/help/repository/PR-required-check-passed-using-generic.png

@@ -70,6 +70,7 @@ This example has a job called `Get_OIDC_ID_token` that uses actions to request a
 
 This action exchanges a {% data variables.product.prodname_dotcom %} OIDC token for a Google Cloud access token, using [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation).
 
+{% raw %}
 ```yaml{:copy}
 name: List services in GCP
 on:
@@ -97,3 +98,4 @@ jobs:
         gcloud auth login --brief --cred-file="${{ steps.auth.outputs.credentials_file_path }}"
         gcloud config list
 ```
+{% endraw %}

assets/images/help/repository/PR-required-check-skipped.png

@@ -129,7 +129,7 @@ git push --set-upstream origin main
 
 ### Example: contribute to an existing branch on {% data variables.product.product_name %}
 
-This example assumes that you already have a project called `repo` already on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally.
+This example assumes that you already have a project called `repo` on the machine and that a new branch has been pushed to {% data variables.product.product_name %} since the last time changes were made locally.
 
 ```bash
 # change into the `repo` directory

content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md

@@ -35,7 +35,7 @@ In open source projects, forks are often used to iterate on ideas or changes bef
 
 {% data reusables.repositories.private_forks_inherit_permissions %}
 
-If you want to create a new repository from the contents of an existing repository but don't want to merge your changes upstream in the future, you can duplicate the repository or, if the repository is a template, use the repository as a template. For more information, see "[Duplicating a repository](/articles/duplicating-a-repository)" and "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)".
+If you want to create a new repository from the contents of an existing repository but don't want to merge your changes to the upstream in the future, you can duplicate the repository or, if the repository is a template, you can use the repository as a template. For more information, see "[Duplicating a repository](/articles/duplicating-a-repository)" and "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)".
 
 ## Further reading
 

content/get-started/using-git/about-git.md

@@ -25,7 +25,7 @@ To create commits on behalf of an organization:
   - `org` is the organization's login
   - `name@organization.com` is in the organization's domain
 
-Organization's can use the `name@organization.com` email as a public point of contact for open source efforts.
+Organizations can use the `name@organization.com` email as a public point of contact for open source efforts.
 
 ## Creating commits with an `on-behalf-of` badge on the command line
 

content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md

@@ -38,11 +38,79 @@ remote: error: Required status check "ci-build" is failing
 
 {% ifversion fpt or ghae or ghes or ghec %}
 
+## Conflicts between head commit and test merge commit 
+
 Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, the test merge commit must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pulls](/rest/reference/pulls#get-a-pull-request)."
 
 ![Branch with conflicting merge commits](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png)
 {% endif %}
 
+## Handling skipped but required checks
+
+Sometimes a required status check is skipped on pull requests due to path filtering. For example, a Node.JS test will be skipped on a pull request that just fixes a typo in your README file and makes no changes to the JavaScript and TypeScript files in the `scripts` directory.
+
+If this check is required and it gets skipped, then the check's status is shown as pending, because it's required. In this situation you won't be able to merge the pull request.
+
+### Example
+
+In this example you have a workflow that's required to pass. 
+
+```yaml
+name: ci
+on:
+  pull_request:
+    paths:
+      - 'scripts/**'
+      - 'middleware/**'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test
+```
+
+If someone submits a pull request that changes a markdown file in the root of the repository, then the workflow above won't run at all because of the path filtering. As a result you won't be able to merge the pull request. You would see the following status on the pull request:
+
+![Required check skipped but shown as pending](/assets/images/help/repository/PR-required-check-skipped.png)
+
+You can fix this by creating a generic workflow, with the same name, that will return true in any case similar to the workflow below :
+
+```yaml
+name: ci
+on:
+  pull_request:
+    paths-ignore:
+      - 'scripts/**'
+      - 'middleware/**'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo "No build required" '
+```
+Now the checks will always pass whenever someone sends a pull request that doesn't change the files listed under `paths` in the first workflow.
+
+![Check skipped but passes due to generic workflow](/assets/images/help/repository/PR-required-check-passed-using-generic.png)
+
+{% note %}
+
+**Notes:** 
+* Make sure that the `name` key and required job name in both the workflow files are the same. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions)".
+* The example above uses {% data variables.product.prodname_actions %} but this workaround is also applicable to other CI/CD providers that integrate with {% data variables.product.company_short %}.
+
+{% endnote %}
+
 It's also possible for a protected branch to require a status check from a specific {% data variables.product.prodname_github_app %}. If you see a message similar to the following, then you should verify that the check listed in the merge box was set by the expected app.
 
 ```