Octomerger Bot
@@ -21,7 +21,7 @@ You can add personal information about yourself in your bio, like previous place
|
||||
|
||||
{% data reusables.profile.profile-readme %}
|
||||
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ Before you can connect your {% ifversion fpt or ghec %}{% data variables.product
|
||||
|
||||
1. Sign in to {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.
|
||||
1. On {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click your profile photo, then click **Settings**.
|
||||
|
||||
|
||||
{% data reusables.github-connect.github-connect-tab-user-settings %}
|
||||
{% data reusables.github-connect.connect-dotcom-and-enterprise %}
|
||||
1. Review the resources that {% data variables.product.prodname_ghe_server %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**.
|
||||
@@ -55,7 +55,7 @@ Before you can connect your {% ifversion fpt or ghec %}{% data variables.product
|
||||
|
||||
1. Sign in to {% data variables.product.prodname_ghe_managed %} and {% data variables.product.prodname_dotcom_the_website %}.
|
||||
1. On {% data variables.product.prodname_ghe_managed %}, in the upper-right corner of any page, click your profile photo, then click **Settings**.
|
||||
|
||||
|
||||
{% data reusables.github-connect.github-connect-tab-user-settings %}
|
||||
{% data reusables.github-connect.connect-dotcom-and-enterprise %}
|
||||
{% data reusables.github-connect.authorize-connection %}
|
||||
|
||||
@@ -42,7 +42,7 @@ If you have configured environment protection rules that control whether softwar
|
||||
|
||||
1. Navigate to the workflow run. For more information about navigating to a workflow run, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."
|
||||
1. To the right of **Deployment protection rules**, click **Start all waiting jobs**.
|
||||
|
||||
|
||||
1. In the pop-up window, select the environments for which you want to bypass environment protection rules.
|
||||
1. Under **Leave a comment**, enter a description for bypassing the environment protection rules.
|
||||
1. Click **I understand the consequences, start deploying**.
|
||||
|
||||
@@ -50,7 +50,7 @@ To configure provisioning for your {% data variables.enterprise.prodname_emu_ent
|
||||
1. Under **Note**, give your token a descriptive name.
|
||||
2. Select the **Expiration** dropdown menu, then click **No expiration**.
|
||||
3. Select the **admin:enterprise** scope.
|
||||
|
||||
|
||||
4. Click **Generate token**.
|
||||
5. To copy the token to your clipboard, click {% octicon "copy" aria-label="Copy token" %}.
|
||||
|
||||
|
||||
@@ -75,9 +75,9 @@ Organization owners and team maintainers can manage the existing connection betw
|
||||
{% data reusables.organizations.specific_team %}
|
||||
{% data reusables.organizations.team_settings %}
|
||||
1. Optionally, under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}.
|
||||
|
||||
|
||||
1. To connect an IdP group, under "Identity Provider Group", select the drop-down menu, and click an identity provider group from the list.
|
||||
|
||||
|
||||
1. Click **Save changes**.
|
||||
|
||||
## Viewing IdP groups, group membership, and connected teams
|
||||
|
||||
@@ -58,7 +58,7 @@ You can map a team in your enterprise to an Okta group you previously pushed to
|
||||
{% data reusables.organizations.specific_team %}
|
||||
{% data reusables.organizations.team_settings %}
|
||||
6. Under "Identity Provider Group", select the drop-down menu and click an identity provider group.
|
||||
|
||||
|
||||
7. Click **Save changes**.
|
||||
|
||||
## Checking the status of your mapped teams
|
||||
|
||||
@@ -160,7 +160,7 @@ You can view a list of all dormant users {% ifversion ghes or ghae %} who have n
|
||||
|
||||
|
||||
4. Above the list of members, click **Type**, then select the type of members you want to view.
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -9,6 +9,13 @@ versions:
|
||||
ghec: '*'
|
||||
topics:
|
||||
- GitHub Apps
|
||||
redirect_from:
|
||||
- /apps/building-your-first-github-app
|
||||
- /apps/quickstart-guides/using-the-github-api-in-your-app
|
||||
- /developers/apps/using-the-github-api-in-your-app
|
||||
- /developers/apps/guides/using-the-github-api-in-your-app
|
||||
- /apps/creating-github-apps/guides/using-the-github-api-in-your-app
|
||||
- /apps/creating-github-apps/writing-code-for-a-github-app/using-the-github-api-in-your-app
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -19,7 +19,6 @@ children:
|
||||
- /building-a-login-with-github-button-with-a-github-app
|
||||
- /building-a-cli-with-a-github-app
|
||||
- /setting-up-your-development-environment-to-create-a-github-app
|
||||
- /using-the-github-api-in-your-app
|
||||
- /creating-ci-tests-with-the-checks-api
|
||||
---
|
||||
|
||||
|
||||
@@ -1,234 +0,0 @@
|
||||
---
|
||||
title: Using the GitHub API in your app
|
||||
intro: Learn how to set up your app to listen for events and use the Octokit library to perform REST API operations.
|
||||
redirect_from:
|
||||
- /apps/building-your-first-github-app
|
||||
- /apps/quickstart-guides/using-the-github-api-in-your-app
|
||||
- /developers/apps/using-the-github-api-in-your-app
|
||||
- /developers/apps/guides/using-the-github-api-in-your-app
|
||||
- /apps/creating-github-apps/guides/using-the-github-api-in-your-app
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- GitHub Apps
|
||||
shortTitle: Build an app with the REST API
|
||||
---
|
||||
## Introduction
|
||||
|
||||
This guide will help you build a GitHub App and run it on a server. The app you build will add a label to all new issues opened in the repository where the app is installed.
|
||||
|
||||
This project will walk you through the following:
|
||||
|
||||
* Programming your app to listen for events
|
||||
* Using the Octokit.rb library to do REST API operations
|
||||
|
||||
{% data reusables.apps.app-ruby-guides %}
|
||||
|
||||
Once you've worked through the steps, you'll be ready to develop other kinds of integrations using the full suite of GitHub APIs. {% ifversion fpt or ghec %}You can check out successful examples of apps on [GitHub Marketplace](https://github.com/marketplace) and [Works with GitHub](https://github.com/works-with).{% endif %}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You may find it helpful to have a basic understanding of the following:
|
||||
|
||||
* [GitHub Apps](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)
|
||||
* [Webhooks](/webhooks-and-events/webhooks/about-webhooks)
|
||||
* [The Ruby programming language](https://www.ruby-lang.org/en/)
|
||||
* [REST APIs](/rest)
|
||||
* [Sinatra](https://sinatrarb.com/)
|
||||
|
||||
But you can follow along at any experience level. We'll link out to information you need along the way!
|
||||
|
||||
Before you begin, you'll need to do the following:
|
||||
|
||||
1. Clone the [Using the GitHub API in your app](https://github.com/github-developer/using-the-github-api-in-your-app) repository.
|
||||
```shell
|
||||
$ git clone https://github.com/github-developer/using-the-github-api-in-your-app.git
|
||||
```
|
||||
|
||||
Inside the directory, you'll find a `template_server.rb` file with the template code you'll use in this quickstart and a `server.rb` file with the completed project code.
|
||||
|
||||
1. Follow the steps in the [Setting up your development environment](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app) quickstart to configure and run the `template_server.rb` app server. If you've previously completed a GitHub App quickstart other than [Setting up your development environment](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app), you should register a _new_ GitHub App and start a new Smee channel to use with this quickstart.
|
||||
|
||||
This quickstart includes the same `template_server.rb` code as the [Setting up your development environment](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app) quickstart. **Note:** As you follow along with the [Setting up your development environment](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app) quickstart, make sure to use the project files included in the [Using the GitHub API in your app](https://github.com/github-developer/using-the-github-api-in-your-app) repository.
|
||||
|
||||
See the [Troubleshooting](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#troubleshooting) section if you are running into problems setting up your template GitHub App.
|
||||
|
||||
## Building the app
|
||||
|
||||
Now that you're familiar with the `template_server.rb` code, you're going to create code that automatically adds the `needs-response` label to all issues opened in the repository where the app is installed.
|
||||
|
||||
The `template_server.rb` file contains app template code that has not yet been customized. In this file, you'll see some placeholder code for handling webhook events and some other code for initializing an Octokit.rb client.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** `template_server.rb` contains many code comments that complement this guide and explain additional technical details. You may find it helpful to read through the comments in that file now, before continuing with this section, to get an overview of how the code works.
|
||||
|
||||
The final customized code that you'll create by the end of this guide is provided in [`server.rb`](https://github.com/github-developer/using-the-github-api-in-your-app/blob/master/server.rb). Try waiting until the end to look at it, though!
|
||||
|
||||
{% endnote %}
|
||||
|
||||
These are the steps you'll complete to create your first GitHub App:
|
||||
|
||||
1. [Update app permissions](#step-1-update-app-permissions)
|
||||
2. [Add event handling](#step-2-add-event-handling)
|
||||
3. [Create a new label](#step-3-create-a-new-label)
|
||||
4. [Add label handling](#step-4-add-label-handling)
|
||||
|
||||
## Step 1. Update app permissions
|
||||
|
||||
When you [first registered your app](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-2-register-a-new-github-app), you accepted the default permissions, which means your app doesn't have access to most resources. For this example, your app will need permission to read issues and write labels.
|
||||
|
||||
To update your app's permissions:
|
||||
|
||||
1. Select your app from the [app settings page](https://github.com/settings/apps) and click **Permissions & Webhooks** in the sidebar.
|
||||
1. In the "Permissions" section, find "Issues," and select **Read & Write** in the "Access" dropdown next to it. The description says this option grants access to both issues and labels, which is just what you need.
|
||||
1. In the "Subscribe to events" section, select **Issues** to subscribe to the event.
|
||||
{% data reusables.apps.accept_new_permissions_steps %}
|
||||
|
||||
Great! Your app has permission to do the tasks you want it to do. Now you can add the code to make it work.
|
||||
|
||||
## Step 2. Add event handling
|
||||
|
||||
The first thing your app needs to do is listen for new issues that are opened. Now that you've subscribed to the **Issues** event, you'll start receiving the [`issues`](/webhooks-and-events/webhooks/webhook-events-and-payloads#issues) webhook, which is triggered when certain issue-related actions occur. You can filter this event type for the specific action you want in your code.
|
||||
|
||||
GitHub sends webhook payloads as `POST` requests. Because you forwarded your Smee webhook payloads to `http://localhost/event_handler:3000`, your server will receive the `POST` request payloads in the `post '/event_handler'` route.
|
||||
|
||||
An empty `post '/event_handler'` route is already included in the `template_server.rb` file, which you downloaded in the [prerequisites](#prerequisites) section. The empty route looks like this:
|
||||
|
||||
``` ruby
|
||||
post '/event_handler' do
|
||||
|
||||
# # # # # # # # # # # #
|
||||
# ADD YOUR CODE HERE #
|
||||
# # # # # # # # # # # #
|
||||
|
||||
200 # success status
|
||||
end
|
||||
```
|
||||
|
||||
Use this route to handle the `issues` event by adding the following code:
|
||||
|
||||
``` ruby
|
||||
case request.env['HTTP_X_GITHUB_EVENT']
|
||||
when 'issues'
|
||||
if @payload['action'] === 'opened'
|
||||
handle_issue_opened_event(@payload)
|
||||
end
|
||||
end
|
||||
```
|
||||
|
||||
Every event that GitHub sends includes a request header called `HTTP_X_GITHUB_EVENT`, which indicates the type of event in the `POST` request. Right now, you're only interested in `issues` event types. Each event has an additional `action` field that indicates the type of action that triggered the events. For `issues`, the `action` field can be `assigned`, `unassigned`, `labeled`, `unlabeled`, `opened`, `edited`, `milestoned`, `demilestoned`, `closed`, or `reopened`.
|
||||
|
||||
To test your event handler, try adding a temporary helper method. You'll update later when you [Add label handling](#step-4-add-label-handling). For now, add the following code inside the `helpers do` section of the code. You can put the new method above or below any of the other helper methods. Order doesn't matter.
|
||||
|
||||
``` ruby
|
||||
def handle_issue_opened_event(payload)
|
||||
logger.debug 'An issue was opened!'
|
||||
end
|
||||
```
|
||||
|
||||
This method receives a JSON-formatted event payload as an argument. This means you can parse the payload in the method and drill down to any specific data you need. You may find it helpful to inspect the full payload at some point: try changing `logger.debug 'An issue was opened!` to `logger.debug payload`. The payload structure you see should match what's [shown in the `issues` webhook event docs](/webhooks-and-events/webhooks/webhook-events-and-payloads#issues).
|
||||
|
||||
Great! It's time to test the changes.
|
||||
|
||||
{% data reusables.apps.sinatra_restart_instructions %}
|
||||
|
||||
In your browser, visit the repository where you installed your app. Open a new issue in this repository. The issue can say anything you like. It's just for testing.
|
||||
|
||||
When you look back at your Terminal, you should see a message in the output that says, `An issue was opened!` Congrats! You've added an event handler to your app. 💪
|
||||
|
||||
## Step 3. Create a new label
|
||||
|
||||
Okay, your app can tell when issues are opened. Now you want it to add the label `needs-response` to any newly opened issue in a repository the app is installed in.
|
||||
|
||||
Before the label can be _added_ anywhere, you'll need to _create_ the custom label in your repository. You'll only need to do this one time. For the purposes of this guide, create the label manually on GitHub. In your repository, click **Issues**, then **Labels**, then click **New label**. Name the new label `needs-response`.
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip**: Wouldn't it be great if your app could create the label programmatically? [It can](/rest/issues#create-a-label)! Try adding the code to do that on your own after you finish the steps in this guide.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
Now that the label exists, you can program your app to use the REST API to [add the label to any newly opened issue](/rest/issues#add-labels-to-an-issue).
|
||||
|
||||
## Step 4. Add label handling
|
||||
|
||||
Congrats—you've made it to the final step: adding label handling to your app. For this task, you'll want to use the [Octokit.rb Ruby library](https://octokit.github.io/octokit.rb/).
|
||||
|
||||
In the Octokit.rb docs, find the list of [label methods](https://octokit.github.io/octokit.rb/Octokit/Client/Labels.html). The method you'll want to use is [`add_labels_to_an_issue`](https://octokit.github.io/octokit.rb/Octokit/Client/Labels.html#add_labels_to_an_issue-instance_method).
|
||||
|
||||
Back in `template_server.rb`, find the method you defined previously:
|
||||
|
||||
``` ruby
|
||||
def handle_issue_opened_event(payload)
|
||||
logger.debug 'An issue was opened!'
|
||||
end
|
||||
```
|
||||
|
||||
The [`add_labels_to_an_issue`](https://octokit.github.io/octokit.rb/Octokit/Client/Labels.html#add_labels_to_an_issue-instance_method) docs show you'll need to pass three arguments to this method:
|
||||
|
||||
* Repo (string in `"owner/name"` format)
|
||||
* Issue number (integer)
|
||||
* Labels (array)
|
||||
|
||||
You can parse the payload to get both the repo and the issue number. Since the label name will always be the same (`needs-response`), you can pass it as a hardcoded string in the labels array. Putting these pieces together, your updated method might look like this:
|
||||
|
||||
``` ruby
|
||||
# When an issue is opened, add a label
|
||||
def handle_issue_opened_event(payload)
|
||||
repo = payload['repository']['full_name']
|
||||
issue_number = payload['issue']['number']
|
||||
@installation_client.add_labels_to_an_issue(repo, issue_number, ['needs-response'])
|
||||
end
|
||||
```
|
||||
|
||||
Try opening a new issue in your test repository and see what happens! If nothing happens right away, try refreshing.
|
||||
|
||||
You won't see much in the Terminal, _but_ you should see that the {% data variables.product.prodname_github_app %} has added a label to the issue.
|
||||
|
||||
If so, congrats! You've successfully built a working app! 🎉
|
||||
|
||||
You can see the final code in `server.rb` in the [app template repository](https://github.com/github-developer/using-the-github-api-in-your-app).
|
||||
|
||||
See "[Next steps](#next-steps)" for ideas about where you can go from here.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data reusables.support.prodname_support_forum_with_url %}.
|
||||
|
||||
* **Q:** My server isn't listening to events! The Smee client is running in a Terminal window, and I'm sending events on GitHub.com by opening new issues, but I don't see any output in the Terminal window where I'm running the server.
|
||||
|
||||
**A:** You may not have the correct Smee domain in your app settings. Visit your [app settings page](https://github.com/settings/apps) and double-check the fields shown in "[AUTOTITLE](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-2-register-a-new-github-app)." Make sure the domain in those fields matches the domain you used in your `smee -u <unique_channel>` command in "[AUTOTITLE](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-1-start-a-new-smee-channel)."
|
||||
|
||||
* **Q:** My app doesn't work! I opened a new issue, but even after refreshing, no label has been added to it.
|
||||
|
||||
**A:** Make sure all of the following are true:
|
||||
|
||||
* You [installed the app](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-7-install-the-app-on-your-account) on the repository where you're opening the issue.
|
||||
* Your [Smee client is running](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-1-start-a-new-smee-channel) in a Terminal window.
|
||||
* Your [web server is running](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-6-start-the-server) with no errors in another Terminal window.
|
||||
* Your app has [read & write permissions on issues and is subscribed to issue events](/apps/creating-github-apps/guides/setting-up-your-development-environment-to-create-a-github-app#step-1-start-a-new-smee-channel).
|
||||
* You [checked your email](#step-1-update-app-permissions) after updating the permissions and accepted the new permissions.
|
||||
|
||||
## Conclusion
|
||||
|
||||
After walking through this guide, you've learned the basic building blocks for developing GitHub Apps! To review, you:
|
||||
|
||||
* Programmed your app to listen for events
|
||||
* Used the Octokit.rb library to do REST API operations
|
||||
|
||||
## Next steps
|
||||
|
||||
Here are some ideas for what you can do next:
|
||||
|
||||
* [Rewrite your app using GraphQL](https://developer.github.com/changes/2018-04-30-graphql-supports-github-apps/)!
|
||||
* Rewrite your app in Node.js using [Probot](https://github.com/probot/probot)!
|
||||
* Have the app check whether the `needs-response` label already exists on the issue, and if not, add it.
|
||||
* When the bot successfully adds the label, show a message in the Terminal. (Hint: compare the `needs-response` label ID with the ID of the label in the payload as a condition for your message, so that the message only displays when the relevant label is added and not some other label.)
|
||||
* Add a landing page to your app and hook up a [Sinatra route](https://github.com/sinatra/sinatra#routes) for it.
|
||||
* Move your code to a hosted server (like Heroku). Don't forget to update your app settings with the new domain.
|
||||
* Share your project or get advice in the {% data reusables.support.prodname_support_forum_with_url %}{% ifversion fpt or ghec %}
|
||||
* Have you built a shiny new app you think others might find useful? [Add it to GitHub Marketplace](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace)!{% endif %}
|
||||
@@ -30,7 +30,7 @@ You can add multiple public keys to your account on {% data variables.product.pr
|
||||
{% ifversion upload-expired-or-revoked-gpg-key %}
|
||||
To verify as many of your commits as possible, you can add expired and revoked keys. If the key meets all other verification requirements, commits that were previously signed by any of the corresponding private keys will show as verified and indicate that their signing key is expired or revoked.
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.gpg.supported-gpg-key-algorithms %}
|
||||
|
||||
@@ -36,4 +36,4 @@ The spending information will display the total spending for each organization f
|
||||
1. In the "Access" section of the sidebar, click **{% octicon "credit-card" aria-hidden="true" %} Billing and plans**.
|
||||
1. Under "{% data variables.product.prodname_copilot_short %}", view the breakdown of your {% data variables.product.prodname_copilot %} usage and upcoming changes in your organization.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -117,7 +117,7 @@ The advanced setup for {% data variables.product.prodname_code_scanning %} is he
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
1. If the repository has already at least one workflow configured and running, click **New workflow** to display starter workflows. If there are currently no workflows configured for the repository, go to the next step.
|
||||
|
||||
|
||||
2. In the "Choose a workflow" or "Get started with {% data variables.product.prodname_actions %}" view, scroll down to the "Security" category and click **Configure** under the workflow you want to configure. You may need to click **View all** to find the security workflow you want to configure.
|
||||
|
||||
3. Follow any instructions in the workflow to customize it to your needs. For more general assistance about workflows, click **Documentation** on the right pane of the workflow page.
|
||||
@@ -261,7 +261,7 @@ There are other situations where there may be no analysis for the latest commit
|
||||
|
||||
To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_caps %} page, click the **Branch** drop-down and select the relevant branch.
|
||||
|
||||
|
||||
|
||||
|
||||
The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan.
|
||||
|
||||
|
||||
@@ -194,7 +194,7 @@ To dismiss {% ifversion delete-code-scanning-alerts %}or delete{% endif %} alert
|
||||
|
||||
{%- else %}
|
||||
1. Review the alert, then click **Dismiss** and choose a reason for closing the alert.
|
||||
|
||||
|
||||
{%- endif %}
|
||||
{% data reusables.code-scanning.choose-alert-dismissal-reason %}
|
||||
|
||||
|
||||
@@ -102,7 +102,7 @@ In the detailed view for an alert, some {% data variables.product.prodname_code_
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion code-scanning-pr-conversations-tab %}
|
||||
@@ -122,7 +122,7 @@ An alternative way of closing an alert is to dismiss it. You can dismiss an aler
|
||||
{% ifversion comment-dismissed-code-scanning-alert %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
||||
{% endif %}
|
||||
{% data reusables.code-scanning.choose-alert-dismissal-reason %}
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ The search bar also allows for full text searching of alerts and related securit
|
||||
{% endif %}
|
||||
|
||||
{% ifversion dependabot-bulk-alerts %}
|
||||
{% elsif ghes = 3.5 %}
|
||||
{% elsif ghes = 3.5 %}
|
||||
You can select a filter in a dropdown menu at the top of the list, then click the filter that you would like to apply.{% endif %}
|
||||
|
||||
{% ifversion dependabot-alerts-development-label %}
|
||||
@@ -94,7 +94,7 @@ For supported languages, {% data variables.product.prodname_dependabot %} automa
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
|
||||
|
||||
You can filter the view to show only alerts where {% data variables.product.prodname_dependabot %} detected at least one call to a vulnerable function using the `has:vulnerable-calls` filter in the search field.
|
||||
|
||||
@@ -118,7 +118,7 @@ For more information, see "[Reviewing and fixing alerts](#reviewing-and-fixing-a
|
||||
1. Optionally, to filter alerts, select a filter in a dropdown menu then click the filter that you would like to apply. You can also type filters into the search bar. {% ifversion dependabot-filter-label-security-advisory %}Alternatively, to filter by label, click a label assigned to an alert to automatically apply that filter to the alert list.{% endif %} For more information about filtering and sorting alerts, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-dependabot-alerts)."
|
||||
{%- ifversion dependabot-bulk-alerts %}
|
||||
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
1. Click the alert that you would like to view.
|
||||
{% else %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
@@ -196,7 +196,7 @@ If you schedule extensive work to upgrade a dependency, or decide that an alert
|
||||
4. Optionally, at the top of the list of alerts, select all alerts on the page.
|
||||
|
||||
5. Select the "Dismiss alerts" dropdown, and click a reason for dismissing the alerts.
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -241,6 +241,6 @@ You can view all open alerts, and you can reopen alerts that have been previousl
|
||||
When a member of your organization {% ifversion not fpt %}or enterprise {% endif %}performs an action related to {% data variables.product.prodname_dependabot_alerts %}, you can review the actions in the audit log. For more information about accessing the log, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log){% ifversion not fpt %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)."{% else %}."{% endif %}
|
||||
{% ifversion dependabot-alerts-audit-log %}
|
||||
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
Events in your audit log for {% data variables.product.prodname_dependabot_alerts %} include details such as who performed the action, what the action was, and when the action was performed. {% ifversion dependabot-alerts-audit-log %}The event also includes a link to the alert itself. When a member of your organization dismisses an alert, the event displays the dismissal reason and comment.{% endif %} For information on the {% data variables.product.prodname_dependabot_alerts %} actions, see the `repository_vulnerability_alert` category in "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization#repository_vulnerability_alert-category-actions){% ifversion not fpt %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#repository_vulnerability_alert-category-actions)."{% else %}."{% endif %}
|
||||
|
||||
@@ -65,15 +65,15 @@ You can use the organization settings page for "Code security and analysis" to e
|
||||
|
||||
{% ifversion secret-scanning-push-protection %}
|
||||
1. Optionally, if you want to enable push protection, click **Enable** to the right of "Push protection." {% data reusables.secret-scanning.push-protection-overview %} For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
||||
|
||||
|
||||
{% endif %}
|
||||
{% ifversion ghae %}
|
||||
1. Before you can enable {% data variables.product.prodname_secret_scanning %}, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**.
|
||||
|
||||
|
||||
2. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action.
|
||||
|
||||
|
||||
3. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**.
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
@@ -85,10 +85,10 @@ You can enable {% data variables.secret-scanning.user_alerts %} for all of your
|
||||
{% data reusables.user-settings.security-analysis %}
|
||||
1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Disable all** or **Enable all**.
|
||||
|
||||
|
||||
|
||||
1. Optionally, to automatically enable {% data variables.product.prodname_secret_scanning %} for any new public repositories that you create, below "{% data variables.product.prodname_secret_scanning_caps %}", select the checkbox for "Automatically enable for new public repositories."
|
||||
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -33,14 +33,14 @@ For more information about configuring notification preferences, see "[AUTOTITLE
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.security-and-analysis %}
|
||||
1. Under "Code security and analysis", to the right of "Private vulnerability reporting", click **Enable all** or **Disable all**, to enable or disable the feature for all the public repositories within the organization, respectively.
|
||||
|
||||
|
||||
|
||||
## Enabling or disabling private vulnerability reporting for new public repositories added to the organization
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.security-and-analysis %}
|
||||
1. Under "Code security and analysis", to the right of the feature, click **Automatically enable for new public repositories**.
|
||||
|
||||
|
||||
|
||||
1. To the right of "Private vulnerability reporting", click **Enable all** or **Disable all**, to enable or disable the feature for all new public repositories that will be added to the organization, respectively.
|
||||
|
||||
|
||||
@@ -72,7 +72,7 @@ For more information about these views, see "[AUTOTITLE](/code-security/security
|
||||
|
||||
### Understanding the main security overview
|
||||
|
||||
|
||||
|
||||
|
||||
Each repository is shown in security overview with an indicator for each type of security feature and how many alerts there are of each type. If a security feature is not enabled for a repository, the indicator for that feature will be grayed out. In addition, a risk score is calculated for each repository based on its code scanning, Dependabot and secret scanning alerts. This score is in beta and should be used with caution. Its algorithm and approach is subject to change.
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ Dependency review is available when dependency graph is enabled for {% data vari
|
||||
{% data reusables.repositories.navigate-to-code-security-and-analysis %}
|
||||
1. Under "Configure security and analysis features", check if the dependency graph is enabled.
|
||||
1. If dependency graph is enabled, click **Enable** next to "{% data variables.product.prodname_GH_advanced_security %}" to enable {% data variables.product.prodname_advanced_security %}, including dependency review. The enable button is disabled if your enterprise has no available licenses for {% data variables.product.prodname_advanced_security %}.{% ifversion ghes %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -186,7 +186,7 @@ With your dev container configuration added and a basic understanding of what ev
|
||||
1. Run the application by pressing `F5`.
|
||||
1. If a "toast" notification message is displayed at the bottom right corner of {% data variables.product.prodname_vscode_shortname %}, asking whether you want to switch to standard mode, click **Yes**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. When the project files have been imported, click the **Debug Console** tab to see the program output.
|
||||
|
||||
|
||||
@@ -102,4 +102,4 @@ This type of URL is useful, for instance, in a README for your repository as it
|
||||
|
||||
The example Markdown is rendered like this:
|
||||
|
||||
[](https://codespaces.new/github/docs)
|
||||
[](https://codespaces.new/github/docs)
|
||||
@@ -73,7 +73,7 @@ You can enable or disable {% data variables.product.prodname_copilot %} from wit
|
||||
|
||||
1. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable it globally, or for the language of the file you are currently editing. To disable globally, click **Disable Completions**. Alternatively, click the language-specific button to disable {% data variables.product.prodname_copilot %} for the specified language.
|
||||
|
||||
|
||||
|
||||
|
||||
## Configuring advanced settings for {% data variables.product.prodname_copilot %}
|
||||
|
||||
@@ -126,16 +126,16 @@ If you don't want to use the default keyboard shortcuts in {% data variables.pro
|
||||
|
||||
1. In the {% data variables.product.prodname_vs %} toolbar, under **Tools**, click **Options**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. In the "Options" dialog, under **Environment**, click **Keyboard**.
|
||||
1. Under "Show commands containing:", search for the command you want to rebind.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Under "Press shortcut keys," type the shortcut you want to assign to the command, then click **Assign**.
|
||||
|
||||
|
||||
|
||||
|
||||
{% data reusables.copilot.enabling-or-disabling-vs %}
|
||||
|
||||
@@ -144,7 +144,7 @@ If you don't want to use the default keyboard shortcuts in {% data variables.pro
|
||||
If you use ReSharper, {% data variables.product.prodname_copilot %} may work best when you configure ReSharper to use {% data variables.product.prodname_copilot %}'s native IntelliSense. For more information about ReSharper, see the [ReSharper documentation](https://www.jetbrains.com/resharper/documentation/documentation.html)
|
||||
|
||||
1. In the {% data variables.product.prodname_vs %} toolbar, under **Tools**, click **Options**.
|
||||
|
||||
|
||||
1. In the "Options" dialog, under **Environment**, click **IntelliSense** and then click **General**.
|
||||
1. Under "General" select **{% data variables.product.prodname_vs %}** and then click **Save**.
|
||||
|
||||
@@ -211,12 +211,12 @@ If you don't want to use the default keyboard shortcuts in {% data variables.pro
|
||||
|
||||
1. Click **Code**, click **Preferences**, then click **Keyboard Shortcuts**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.
|
||||
1. Next to the command you want to change, click the pencil icon.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Type the keystrokes you want to use for the command, then press <kbd>Enter</kbd>/<kbd>Return</kbd>.
|
||||
|
||||
@@ -224,12 +224,12 @@ If you don't want to use the default keyboard shortcuts in {% data variables.pro
|
||||
|
||||
1. Click the **File** menu, click **Preferences**, then click **Keyboard Shortcuts**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.
|
||||
1. Next to the command you want to change, click the pencil icon.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Type the keystrokes you want to use for the command, then press <kbd>Enter</kbd>/<kbd>Return</kbd>.
|
||||
|
||||
@@ -237,12 +237,12 @@ If you don't want to use the default keyboard shortcuts in {% data variables.pro
|
||||
|
||||
1. Click the **File** menu, click **Preferences**, then click **Keyboard Shortcuts**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.
|
||||
1. Next to the command you want to change, click the pencil icon.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Type the keystrokes you want to use for the command, then press <kbd>Enter</kbd>/<kbd>Return</kbd>.
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ Depending on the policy settings configured at the enterprise level, an organiza
|
||||
1. If you selected **Start from scratch**, click **Add people** or **Add teams** to add individual users, or entire teams.
|
||||
1. If you selected **Add people**, in the "Enable {% data variables.product.prodname_copilot %} access for selected members of ORGANIZATION" dialog, you can either search for individual members, or you can add members in bulk by uploading a CSV file.
|
||||
|
||||
|
||||
|
||||
|
||||
- To search for members, type the member's username, full name, or email address in the search bar.
|
||||
- To add members in bulk, click **Upload CSV**, and then upload a CSV file including either the username or email address for each member you want to add, separated by a comma.
|
||||
|
||||
@@ -59,7 +59,7 @@ To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you mus
|
||||
1. In the left-side menu of the **Settings/Preferences** dialog box, click **Plugins**.
|
||||
1. At the top of the **Settings/Preferences** dialog box, click **Marketplace**. In the search bar, search for **{% data variables.product.prodname_copilot %}**, then click **Install**.
|
||||
|
||||
|
||||
|
||||
1. After {% data variables.product.prodname_copilot %} is installed, click **Restart IDE**.
|
||||
1. After your JetBrains IDE has restarted, click the **Tools** menu. Click **{% data variables.product.prodname_copilot %}**, then click **Login to {% data variables.product.prodname_dotcom %}**.
|
||||
|
||||
@@ -67,7 +67,7 @@ To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you mus
|
||||
|
||||
1. In the "Sign in to {% data variables.product.prodname_dotcom %}" dialog box, to copy the device code and open the device activation window, click **Copy and Open**.
|
||||
|
||||
|
||||
|
||||
1. A device activation window will open in your browser. Paste the device code, then click **Continue**.
|
||||
1. {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click **Authorize {% data variables.product.prodname_copilot %} Plugin**.
|
||||
1. After the permissions have been approved, your JetBrains IDE will show a confirmation. To begin using {% data variables.product.prodname_copilot %}, click **OK**.
|
||||
@@ -135,13 +135,13 @@ You can enable or disable {% data variables.product.prodname_copilot %} for all
|
||||
|
||||
1. To enable or disable {% data variables.product.prodname_copilot %}, click the status icon in the bottom panel of the JetBrains window.
|
||||
|
||||
|
||||
|
||||
1. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable it globally, or for the language of the file you are currently editing.
|
||||
|
||||
- To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Disable Completions**.
|
||||
- To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Disable Completions for _LANGUAGE_**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Further reading
|
||||
@@ -176,14 +176,14 @@ If you use {% data variables.product.prodname_vs %}, you can view and incorporat
|
||||
To use {% data variables.product.prodname_copilot %}, you must first install the {% data variables.product.prodname_vs %} extension.
|
||||
1. In the Visual Studio toolbar, click **Extensions**, then click **Manage Extensions**.
|
||||
|
||||
|
||||
|
||||
1. In the "Manage Extensions" window, click **Visual Studio Marketplace**, search for the {% data variables.product.prodname_copilot %} extension, then click **Download**.
|
||||
|
||||
|
||||
|
||||
1. Close the "Manage Extensions" window, then exit and relaunch {% data variables.product.prodname_vs %}.
|
||||
1. Optionally, to check that {% data variables.product.prodname_copilot %} is installed and enabled, go back to **Manage Extensions**, click **Installed** to view your currently installed extensions, then click **{% data variables.product.prodname_copilot %}** to see status information.
|
||||
|
||||
|
||||
|
||||
1. Open or create a new project in {% data variables.product.prodname_vs %}.
|
||||
1. In the "Microsoft {% data variables.product.prodname_vs %}" dialog box, to copy your device activation code, click **OK**.
|
||||
1. A device activation window will open in your browser. Paste the device code, then click **Continue**.
|
||||
|
||||
@@ -69,7 +69,7 @@ Before you create a pull request, you'll need to push changes to a branch on {%
|
||||
|
||||
|
||||
{% data variables.product.prodname_desktop %} will advise you whether the current branch can be automatically merged into the base branch.
|
||||
|
||||
|
||||
|
||||
1. Click **Create Pull Request**. {% data variables.product.prodname_desktop %} will open your default browser to take you to {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ You can choose how to sort the list of discussions.
|
||||
{% data reusables.discussions.discussions-tab %}
|
||||
1. To the right of the **Search all discussions** field, select the **Sort by** dropdown menu, and click a time period.
|
||||
|
||||
|
||||
|
||||
|
||||
- Sort by **Latest activity** to display the discussions with the most recent activity at the top of the list.
|
||||
- Sort by **Date created** to display the discussions that were created most recently at the top of the list.
|
||||
|
||||
@@ -22,7 +22,7 @@ Discussion category forms are not supported for polls. For more information abou
|
||||
|
||||
Here is the rendered version of the issue form.
|
||||
|
||||
|
||||
|
||||
|
||||
## Creating discussion category forms
|
||||
|
||||
|
||||
@@ -51,7 +51,7 @@ You can pin a discussion above the list of discussions for the repository or org
|
||||
|
||||
This is what it looks like when you have a globally pinned discussion and a discussion pinned to the Ideas category.
|
||||
|
||||
|
||||
|
||||
|
||||
### Pinning a discussion globally
|
||||
{% endif %}
|
||||
@@ -116,7 +116,7 @@ You can unpin a globally pinned discussion. This will not delete the discussion,
|
||||
{% data reusables.discussions.click-discussion-in-list %}
|
||||
1. In the right sidebar, click {% octicon "pin" aria-hidden="true" %} **Unpin discussion**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Read the warning, then click **Unpin discussion**.
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ You can use discussions insights to help understand the contribution activity, p
|
||||
- **Discussions daily contributors** shows the daily count of unique users who have reacted, upvoted, marked an answer, commented, or posted in the selected time period.
|
||||
- **Discussions new contributors** shows the daily count of unique new users who have reacted, upvoted, marked an answer, commented, or posted in the selected time period.
|
||||
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -31,6 +31,6 @@ You can use discussions insights to help understand the contribution activity, p
|
||||
{% data reusables.repositories.accessing-repository-graphs %}
|
||||
1. In the left sidebar, click **Community**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Optionally, in the upper-right corner of the page, select the **Period** dropdown menu and click the time period for which you want to view data: **30 days**, **3 months**, or **1 year**.
|
||||
|
||||
@@ -24,7 +24,7 @@ MakeCode Arcade does not support multiplayer-editing for group assignments. Inst
|
||||
|
||||
By default, MakeCode Arcade is configured to push to the assignment repository on {% data variables.location.product_location %}. After making progress on an assignment with MakeCode Arcade, students should push changes to {% data variables.location.product_location %} using the {% octicon "mark-github" aria-label="The GitHub mark" %}{% octicon "arrow-up" aria-label="The up arrow icon" %} button at the bottom of the screen.
|
||||
|
||||
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -132,7 +132,7 @@ This community maintainer started a discussion to welcome the community, and to
|
||||
|
||||
This example shows a team post for the `octo-team` team.
|
||||
|
||||
|
||||
|
||||
|
||||
The `octocat` team member posted a team discussion, informing the team of various things:
|
||||
- A team member called Mona started remote game events.
|
||||
|
||||
@@ -54,7 +54,7 @@ This diagram shows:
|
||||
* A new branch called `feature`
|
||||
* The journey that `feature` takes before it's merged into `main`
|
||||
|
||||
|
||||
|
||||
|
||||
Have you ever saved different versions of a file? Something like:
|
||||
|
||||
|
||||
@@ -26,14 +26,14 @@ To include a math expression inline within your text, delimit the expression wit
|
||||
This sentence uses `$` delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
{% ifversion math-backtick-syntax %}
|
||||
````
|
||||
This sentence uses $\` and \`$ delimiters to show math inline: $`\sqrt{3x-1}+(1+x)^2`$
|
||||
````
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Writing expressions as blocks
|
||||
@@ -45,7 +45,7 @@ To add a math expression as a block, start a new line and delimit the expression
|
||||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
{% ifversion math-fenced-blocks %}
|
||||
|
||||
|
||||
@@ -15,9 +15,9 @@ versions:
|
||||
{% data reusables.user-settings.saved_replies %}
|
||||
1. Under "Add a saved reply", add a title for your saved reply.
|
||||
2. In the "Write" field, add the content you'd like to use for the saved reply. For information on using Markdown, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)."
|
||||
|
||||
|
||||
1. To review your reply, click **Preview**.
|
||||
|
||||
|
||||
1. Click **Add saved reply**.
|
||||
|
||||
## Further reading
|
||||
|
||||
@@ -20,7 +20,7 @@ If you reopen a {% data variables.projects.projects_v1_board %}, you have the op
|
||||
|
||||
1. Navigate to the list of {% data variables.projects.projects_v1_boards %} in your repository or organization, or owned by your personal account.
|
||||
2. In the projects list, next to the {% data variables.projects.projects_v1_board %} you want to close, click {% octicon "kebab-horizontal" aria-label="Project menu" %}.
|
||||
|
||||
|
||||
3. Click **Close**.
|
||||
|
||||
## Further reading
|
||||
|
||||
@@ -64,7 +64,7 @@ You can put a maximum of 2,500 cards into each project column. If a column has r
|
||||
3. Type the name of the project in **Filter projects** field.
|
||||
4. Select one or more {% data variables.projects.projects_v1_boards %} where you want to add the issue or pull request.
|
||||
5. Click **Awaiting triage**{% octicon "triangle-down" aria-hidden="true" %}, then click the column where you want your issue or pull request. The card will move to the bottom of the {% data variables.projects.projects_v1_board %} column you select.
|
||||
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ topics:
|
||||
|
||||
{% data reusables.projects.about-table-layout %} For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout)."
|
||||
|
||||
|
||||
|
||||
|
||||
## About the board layout
|
||||
|
||||
{% data reusables.projects.about-board-layout %} For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout)."
|
||||
|
||||
|
||||
|
||||
|
||||
{% ifversion projects-v2-roadmaps %}
|
||||
|
||||
@@ -30,7 +30,7 @@ topics:
|
||||
|
||||
{% data reusables.projects.about-roadmap-layout %} For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout)."
|
||||
|
||||
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ You can customize which items appear in your views using filters for item metada
|
||||
|
||||
To filter a view, click {% octicon "filter" aria-label="Filter by keyword or by field" %} and start typing the fields and values you would like to filter for. As you type, possible values will appear. You can also open the project command palette, by pressing {% data variables.projects.command-palette-shortcut %}, and type "Filter by" to choose from the available filters.
|
||||
|
||||
|
||||
|
||||
|
||||
In board layout, you can click on item data to filter for items with that value. For example, click on an assignee to show only items for that assignee. To remove the filter, click the item data again.
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ You can duplicate an existing view and use it as a base to make further changes.
|
||||
|
||||
When you make changes to a view - for example, sorting, reordering, filtering, or grouping the data in a view - a dot is displayed next to the view name to indicate that there are unsaved changes.
|
||||
|
||||
|
||||
|
||||
|
||||
If you don't want to save the changes, you can ignore this indicator. No one else will see your changes.
|
||||
|
||||
|
||||
@@ -74,7 +74,7 @@ Now, create a custom field named `Priority` and containing the values: `High`, `
|
||||
|
||||
Specify a priority for all issues in your project.
|
||||
|
||||
|
||||
|
||||
|
||||
## Grouping issues by priority
|
||||
|
||||
|
||||
@@ -66,7 +66,7 @@ You can only invite an individual user to collaborate on your organization-level
|
||||
1. Click **Manage access**.
|
||||
2. Under **Invite collaborators**, search for the team or individual user that you want to invite.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the role for the collaborator.
|
||||
- **Read**: The team or individual can view the project.
|
||||
@@ -82,7 +82,7 @@ You can only invite an individual user to collaborate on your organization-level
|
||||
|
||||
You can use the **Type** and **Role** drop-down menus to filter the access list.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Edit the role for the collaborator(s).
|
||||
1. Optionally, click **Remove** to remove the collaborator(s).
|
||||
@@ -101,7 +101,7 @@ This only affects collaborators for your project, not for repositories in your p
|
||||
1. Click **Manage access**.
|
||||
2. Under **Invite collaborators**, search for the user that you want to invite.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the role for the collaborator.
|
||||
- **Read**: The individual can view the project.
|
||||
|
||||
@@ -80,7 +80,7 @@ Click **Submit new issue** to create your issue. You can edit any of the above f
|
||||
|
||||
After your issue is created, continue the conversation by adding comments to the issue. You can @mention collaborators or teams to draw their attention to a comment. To link related issues in the same repository, you can type `#` followed by part of the issue title and then clicking the issue that you want to link. For more information, see "[AUTOTITLE](/get-started/writing-on-github)."
|
||||
|
||||
|
||||
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
@@ -114,6 +114,6 @@ If you disconnect an IdP group from a {% data variables.product.prodname_dotcom
|
||||
{%- elsif ghae %}
|
||||
1. Under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="Remove group" %}.
|
||||
|
||||
|
||||
|
||||
{%- endif %}
|
||||
1. Click **Save changes**.
|
||||
|
||||
@@ -22,7 +22,7 @@ shortTitle: Compare branches
|
||||
{% endnote %}
|
||||
|
||||
You can view proposed changes in a pull request in the Files changed tab.
|
||||
|
||||
|
||||
|
||||
Rather than viewing the commits themselves, you can view the proposed changes as they'll appear in the files once the pull request is merged. The files appear in alphabetical order within the Files changed tab. Additions to the files appear in green and are prefaced by a `+` sign while content that has been removed appears in red and is prefaced by a `-` sign.
|
||||
|
||||
|
||||
@@ -149,7 +149,7 @@ gh pr create --web
|
||||
|
||||
{% data variables.product.prodname_desktop %} will advise you whether the current branch can be automatically merged into the base branch.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Click **Create Pull Request**. {% data variables.product.prodname_desktop %} will open your default browser to take you to {% data variables.product.prodname_dotcom %}.
|
||||
{% data reusables.repositories.pr-title-description %}
|
||||
@@ -162,9 +162,9 @@ gh pr create --web
|
||||
{% codespaces %}
|
||||
|
||||
1. Once you've committed changes to your local copy of the repository, click the **Create Pull Request** icon.
|
||||
|
||||
|
||||
1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description.
|
||||
|
||||
|
||||
1. Click **Create**.
|
||||
|
||||
For more information on creating pull requests in {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests)."
|
||||
|
||||
@@ -36,7 +36,7 @@ A review has three possible statuses:
|
||||
|
||||
You can view all of the reviews a pull request has received in the Conversation timeline, and you can see reviews by repository owners and collaborators in the pull request's merge box.
|
||||
|
||||
|
||||
|
||||
|
||||
{% data reusables.search.requested_reviews_search_tip %}
|
||||
|
||||
|
||||
@@ -49,7 +49,7 @@ You can configure the {% data variables.dependency-review.action_name %} to bett
|
||||
|
||||
1. If the pull request contains many files, use the **File filter** drop-down menu to collapse all files that don't record dependencies. This will make it easier to focus your review on the dependency changes.
|
||||
|
||||
|
||||
|
||||
The dependency review provides a clearer view of what has changed in large lock files, where the source diff is not rendered by default.
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -55,19 +55,19 @@ You can use [{% data variables.product.prodname_github_codespaces %}](/codespace
|
||||
1. Open the pull request in a codespace, as described in "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests#opening-a-pull-request-in-codespaces)."
|
||||
2. In the Activity Bar, click the **GitHub Pull Request** view. This view only appears when you open a pull request in a codespace.
|
||||
|
||||
|
||||
|
||||
|
||||
3. To review a specific file, click the **Open File** icon in the Side Bar.
|
||||
|
||||
|
||||
|
||||
|
||||
4. To add review comments, click the **+** icon next to the line number. Type your review comment and then click **Start Review**.
|
||||
|
||||
|
||||
|
||||
|
||||
5. When you are finished adding review comments, from the Side Bar you can choose to either submit the comments, approve the changes, or request changes.
|
||||
|
||||
|
||||
|
||||
|
||||
For more information on reviewing pull requests in {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests)."
|
||||
|
||||
@@ -83,7 +83,7 @@ If the pull request contains changes to dependencies you can use the dependency
|
||||
|
||||
1. On the right of the header for a manifest or lock file, display the dependency review by clicking the **{% octicon "file" aria-label="The rich diff icon" %}** rich diff button.
|
||||
|
||||
|
||||
|
||||
|
||||
{% data reusables.repositories.return-to-source-diff %}
|
||||
{% endif %}
|
||||
|
||||
@@ -39,7 +39,7 @@ For more information about forks, see "[AUTOTITLE](/pull-requests/collaborating-
|
||||
{% ifversion fpt or ghec %}
|
||||
1. Select **Create a new repository**.
|
||||
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ Referring sites and popular content are ordered by views and unique visitors. Fu
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
||||
|
||||
|
||||
## Accessing the traffic graph
|
||||
|
||||
|
||||
@@ -28,6 +28,6 @@ An enterprise owner for {% data variables.product.product_name %} must enable {%
|
||||
|
||||
1. Sign into {% data variables.product.product_name %} and {% data variables.product.prodname_dotcom_the_website %}.
|
||||
1. On {% data variables.product.product_name %}, in the upper-right corner of any page, click your profile photo, then click **Settings**.
|
||||
|
||||
|
||||
{% data reusables.github-connect.github-connect-tab-user-settings %}
|
||||
{% data reusables.github-connect.connect-dotcom-and-enterprise %}
|
||||
|
||||
@@ -29,7 +29,7 @@ Your capabilities in the {% data variables.contact.support_portal %} depend on t
|
||||
1. Under the text box, you can read the comment history. The most recent response is at the top.
|
||||
1. Optionally, to translate the ticket comment, click {% octicon "globe" aria-label="The globe icon" %} and choose your preferred language from the dropdown menu. You can translate your support ticket into Chinese (Simplified), French, German, Japanese, Portuguese (Brazil), or Spanish.
|
||||
|
||||
|
||||
|
||||
|
||||
{% ifversion ghec or ghes or ghae %}
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
1. When the dry run finishes, you'll see a sample of results (up to 1000). Review the results and identify any false positive results.
|
||||
|
||||
|
||||
1. Edit the new custom pattern to fix any problems with the results, then, to test your changes, click **Save and dry run**.
|
||||
|
||||
|
||||
@@ -8,4 +8,4 @@
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
1. Under "{% data variables.product.prodname_secret_scanning_caps %}", under "Push protection", click **Enable**.
|
||||
|
||||
|
||||
|
||||
@@ -10,4 +10,4 @@ You can enable or disable {% data variables.product.prodname_copilot %} from wit
|
||||
|
||||
- To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Disable Globally**.
|
||||
- To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Disable for LANGUAGE**.
|
||||
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ The {% data variables.product.prodname_copilot %} status icon in the bottom pane
|
||||
|
||||
1. To enable or disable {% data variables.product.prodname_copilot %}, click the {% data variables.product.prodname_copilot %} icon in the bottom panel of the {% data variables.product.prodname_vs %} window.
|
||||
|
||||
|
||||
|
||||
|
||||
1. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable suggestions globally, or for the language of the file you are currently editing.
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
1. In the **File** menu, navigate to **Preferences** and click **Settings**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
1. In the search results, click the name of the user or organization.
|
||||
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
1. Under "Search users, organizations, teams, repositories, gists, and applications", type the name of the repository in the text field. Then to the right of the field, click **Search**.
|
||||
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
{% data reusables.user-settings.access_org %}
|
||||
1. Under your organization name, click {% octicon "table" aria-hidden="true" %} **Projects**.
|
||||
|
||||
|
||||
|
||||
1. Click **New project**.
|
||||
1. Optionally, in the text box under "Project name", type a name for your new project.
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
1. Under your repository name, click {% octicon "play" aria-hidden="true" %} **Actions**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
1. Under your repository name, click {% octicon "issue-opened" aria-hidden="true" %} **Issues** or {% octicon "git-pull-request" aria-hidden="true" %} **Pull requests**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,4 +6,4 @@ To create a task list, preface list items with a hyphen and space followed by `[
|
||||
- [ ] Add delight to the experience when all tasks are complete :tada:
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
When private vulnerability reporting is enabled for a repository, security researchers will see a new button in the **Advisories** page of the repository. The security researcher can click this button to privately report a security vulnerability to the repository maintainer.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
1. In the upper-right corner of any page, click your profile photo, then click ** Your stars**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -8,10 +8,19 @@ export const imageAltTextPeriod = {
|
||||
forEachInlineChild(params, 'image', function forToken(token) {
|
||||
const imageAltText = token.content.trim()
|
||||
if (!imageAltText.endsWith('.') && !imageAltText.endsWith('."')) {
|
||||
const period = imageAltText.endsWith('"') ? '."' : '.'
|
||||
addError(
|
||||
onError,
|
||||
token.lineNumber,
|
||||
`On line ${token.lineNumber}, the image alt text: "${imageAltText}" must have a period at the end of it.`
|
||||
`On line ${token.lineNumber}, the image alt text: "${imageAltText}" must have a period at the end of it.`,
|
||||
undefined,
|
||||
undefined,
|
||||
{
|
||||
lineNumber: token.lineNumber,
|
||||
editColumn: token.line.indexOf(']') + 1,
|
||||
deleteCount: 0,
|
||||
insertText: period,
|
||||
}
|
||||
)
|
||||
}
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user