text stringlengths 12 91.7k | metadata dict |
|---|---|
Priority of grouped security update settings
Settings for grouped are applied in the following order, from highest to lowest priority:
1. Settings defined in a dependabot.yml file. See About the dependabot.yml file.
1. Repository-level settings defined in the UI
1. Organization-level settings defined in the UI
Enable... | {
"source": "github-docs/code-security/reference/supply-chain-security/dependabot-security-updates.md",
"title": "Dependabot security updates reference"
} |
Understanding the table
The dependency graph supports different methods of submitting data for direct and indirect (transitive) dependencies. See AUTOTITLE.
In the table below:
The Static transitive dependencies, graph jobs (currently not available for ), and Automatic dependency submission columns show you supported... | {
"source": "github-docs/code-security/reference/supply-chain-security/dependency-graph-supported-package-ecosystems.md",
"title": "Dependency graph supported package ecosystems"
} |
uses the url, scm, and issueManagement fields in pom.xml files to create pull requests for Java dependency updates. When you include this metadata, pull requests will contain links to release notes and issue trackers, helping users update packages with confidence.
Metadata that needs in pom.xml files
uses the URLs f... | {
"source": "github-docs/code-security/reference/supply-chain-security/java-package-metadata-dependabot.md",
"title": "Java package metadata for Dependabot updates"
} |
This article provides reference information about the package ecosystems and repository types that supports.
is a tool that helps keep your dependencies secure and up to date. It automatically detects vulnerable or outdated dependencies in your repositories and creates pull requests to update them, making it easier ... | {
"source": "github-docs/code-security/reference/supply-chain-security/supported-ecosystems-and-repositories.md",
"title": "Dependabot supported ecosystems and repositories"
} |
When encounters errors while updating your dependencies, you can use this reference to diagnose and fix common problems.
How to view errors
Security update errors
When is blocked from creating a pull request to fix a alert, it posts the error message on the alert. The view shows a list of any alerts that have not... | {
"source": "github-docs/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors.md",
"title": "Dependabot errors"
} |
Troubleshooting failures when triggers existing workflows
Some troubleshooting advice is provided in this article. You can also see AUTOTITLE.
Accessing secrets
When a event triggers a workflow, the only secrets available to the workflow are secrets. secrets are not available. You must therefore store any secrets ... | {
"source": "github-docs/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-on-actions.md",
"title": "Troubleshooting Dependabot on GitHub Actions"
} |
When maintainers of a repository stop interacting with pull requests, temporarily pauses its updates and lets you know.
stops rebasing pull requests for version and security updates after 30 days, reducing notifications for inactive pull requests.
About automatic deactivation of
pauses updates on your repositor... | {
"source": "github-docs/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-updates-stopped.md",
"title": "Dependabot update pull requests no longer generated"
} |
Does the dependency graph only find dependencies in manifests and lockfiles?
The dependency graph automatically includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transi... | {
"source": "github-docs/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependency-graph-errors.md",
"title": "Troubleshooting the dependency graph"
} |
Missing or undetected dependencies
generates and displays dependency data differently than other tools. Consequently, if you've been using another tool to identify dependencies you will almost certainly see different results. Consider the following:
is one of the data sources that uses to identify vulnerable depend... | {
"source": "github-docs/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerability-detection.md",
"title": "Vulnerable dependency detection"
} |
What is an Application Card?
1. Overview
GitHub's security and quality platform includes several AI-powered capabilities that help developers find and fix security vulnerabilities, detect leaked secrets, and improve code quality. This application card covers the following experiences:
Copilot Autofix for code scannin... | {
"source": "github-docs/code-security/responsible-use/security-and-quality-ai-features.md",
"title": "Application card: GitHub security and quality AI features"
} |
About these articles
(GHAS) products help teams build more secure code faster using integrated tooling such as secret scanning and code scanning using . To understand the security features available through , see AUTOTITLE.
GHAS is a suite of tools that requires active participation from developers across your enterpr... | {
"source": "github-docs/code-security/tutorials/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md",
"title": "Introduction to adopting {% data variables.product.prodname_GHAS %} at scale"
} |
[!TIP]
This article is part of a series on adopting at scale. For the introduction to this series, see AUTOTITLE.
Set clear goals for your company’s rollout
To build a foundation for the direction of your company's rollout, outline goals for GHAS within your company, and communicate those goals to your team. Your go... | {
"source": "github-docs/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md",
"title": "Phase 1: Align on your rollout strategy and goals"
} |
[!TIP]
This article is part of a series on adopting at scale. For the previous article in this series, see AUTOTITLE.
Preparing to enable
For more information, see AUTOTITLE.
Rolling out across hundreds of repositories can be difficult, especially when done inefficiently. Following these steps will ensure your ro... | {
"source": "github-docs/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md",
"title": "Phase 2: Preparing to enable at scale"
} |
[!TIP]
This article is part of a series on adopting at scale. For the previous article in this series, see AUTOTITLE.
About pilot programs
We recommend you identify a few high-impact projects or teams to use in a pilot rollout of GHAS. This allows an initial group within your company to get familiar with GHAS and bu... | {
"source": "github-docs/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md",
"title": "Phase 3: Pilot programs"
} |
[!TIP]
This article is part of a series on adopting at scale. For the previous article in this series, see AUTOTITLE.
Before enabling , you should create internal documentation that defines processes for teams to follow. Everyone needs to know what to do when they receive a security alert, even if the process simply ... | {
"source": "github-docs/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation.md",
"title": "Phase 4: Create internal documentation"
} |
[!TIP]
This article is part of a series on adopting at scale. For the previous article in this series, see AUTOTITLE.
Enabling code scanning
After piloting and creating internal documentation for best practices, you can enable across your company. You can configure default setup for all repositories in an organiz... | {
"source": "github-docs/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md",
"title": "Phase 5: Rollout and scale code scanning"
} |
[!TIP]
This article is part of a series on adopting at scale. For the previous article in this series, see AUTOTITLE.
This article explains a high-level process focusing on enabling for all repositories in an organization. The principles described in this article can still be applied even if you take a more staggere... | {
"source": "github-docs/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md",
"title": "Phase 6: Rollout and scale secret scanning"
} |
About analyzing databases with the
To analyze a codebase, you run queries against a database extracted from the code. analyses produce results that can be uploaded to to generate code scanning alerts.
Prerequisites
Before starting an analysis you must:
Set up the to run commands locally.
Create a database for ... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/analyze-code.md",
"title": "Analyzing your code with CodeQL queries"
} |
About packs and the
packs are used to create, share, depend on, and run queries and libraries.
You can use the pack command in the to create packs, add dependencies to packs, and install or update dependencies. You can also publish and download packs using the pack command.
Creating a pack
You can create a pa... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/create-and-work-with-codeql-packs.md",
"title": "Creating and working with CodeQL packs"
} |
You can create query suites for the queries that you want to frequently use in your analyses. For more information, see AUTOTITLE.
[!NOTE]
Any custom queries that you want to add to a query suite must be in a pack and contain the correct query metadata. For more information, see AUTOTITLE.
Locating queries to add ... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/create-query-suites.md",
"title": "Creating CodeQL query suites"
} |
You can customize your analysis by downloading packs created by others and running them on your codebase. For more information, see AUTOTITLE.
Downloading and using query packs
Before you can use a query pack to analyze a database, you must download any packages you require from the . This can be done either by us... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/customize-analysis.md",
"title": "Customizing analysis with CodeQL packs"
} |
When you first start using , you'll likely use default setup. This guide describes how to evaluate how default setup for is working for you, and what steps to take if something isn't working as you expect. This guide also describes how you can customize if you find that you have a specific use case that your new conf... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/evaluate-default-setup.md",
"title": "Evaluating default setup for code scanning"
} |
<!--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/codeql-docs/indirect-tracing.--
About preparing your code for analysis
Before you analyze your code using , you need to create a database containing al... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/prepare-code-for-analysis.md",
"title": "Preparing your code for CodeQL analysis"
} |
About with a containerized build
If you're configuring for a compiled language, and you're building the code in a containerized environment, the analysis may fail with the error message "No source code was seen during the build." This indicates that was unable to monitor your code as it was compiled.
You must run i... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/run-in-a-container.md",
"title": "Running CodeQL code scanning in a container"
} |
After analyzing a database using the , you will have a SARIF file that contains the results. You can then use the to upload results to .
If you used a method other than the to generate results, you can use other upload methods. For more information, see AUTOTITLE.
Generating a token for authentication with
Before ... | {
"source": "github-docs/code-security/tutorials/customize-code-scanning/upload-results.md",
"title": "Uploading CodeQL analysis results to GitHub"
} |
Prerequisites
Before you can collaborate in a temporary private fork, you must create a draft security advisory. For more information, see AUTOTITLE.
Creating a temporary private fork
To keep information about vulnerabilities secure, integrations, including CI, cannot access temporary private forks.
1. In the "Securit... | {
"source": "github-docs/code-security/tutorials/fix-reported-vulnerabilities/collaborate-in-a-fork.md",
"title": "Collaborating in a temporary private fork to resolve a repository security vulnerability"
} |
About security advisories for repositories
For more information, see AUTOTITLE.
We recommend you use the syntax used in the , especially the version formatting, when you write a repository security advisory, or make a community contribution to a global security advisory.
If you follow the syntax for the , especially w... | {
"source": "github-docs/code-security/tutorials/fix-reported-vulnerabilities/write-security-advisories.md",
"title": "Best practices for writing repository security advisories"
} |
What is the end-to-end supply chain?
At its core, end-to-end software supply chain security is about making sure the code you distribute hasn't been tampered with. Previously, attackers focused on targeting dependencies you use, for example libraries and frameworks. Attackers have now expanded their focus to include ta... | {
"source": "github-docs/code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview.md",
"title": "Securing your end-to-end supply chain"
} |
About this guide
This guide describes the highest impact changes you can make to increase account security. Each section outlines a change you can make to your processes to improve the security. The highest impact changes are listed first.
What's the risk?
Account security is fundamental to the security of your supply... | {
"source": "github-docs/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md",
"title": "Best practices for securing accounts"
} |
About this guide
This guide describes the highest impact changes you can make to improve the security of your build systems. Each section outlines a change you can make to your processes to improve security. The highest impact changes are listed first.
What's the risk?
Some attacks on software supply chains target the... | {
"source": "github-docs/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md",
"title": "Best practices for securing your build system"
} |
About this guide
This guide describes the highest impact changes you can make to improve the security of your code. Each section outlines a change you can make to your processes to improve security. The highest impact changes are listed first.
What's the risk?
Key risks in the development process include:
Using depen... | {
"source": "github-docs/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md",
"title": "Best practices for securing code in your supply chain"
} |
Introduction
In this tutorial, you'll follow a single pull request through 's analysis, from first comment to merge. You'll learn:
How to read the comments on a pull request and tell the two types of finding apart.
How to use a finding's severity label to decide what to fix, what to dismiss, and in what order.
How ... | {
"source": "github-docs/code-security/tutorials/improve-code-quality/catch-issues-before-merge.md",
"title": "Preventing code quality issues from reaching your default branch"
} |
Introduction
In this tutorial, you'll work through a backlog of findings on your default branch, prioritize by risk, resolve the highest-impact findings, and communicate the result to stakeholders. You'll learn:
How to read the dashboard and understand what your scores mean.
How to prioritize remediation and decide ... | {
"source": "github-docs/code-security/tutorials/improve-code-quality/raise-your-quality-rating.md",
"title": "Raising your repository's code quality score"
} |
What is a code security campaign?
A code security campaign is a focused effort to remediate a defined group of alerts across one or more repositories.
Campaigns are created by organization owners or security managers and typically target alerts detected in the default branches of repositories. If you’re participating ... | {
"source": "github-docs/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md",
"title": "Participating in a code security campaign"
} |
Prioritizing using metrics
Application Security (AppSec) managers often face a flood of , making it challenging to determine which vulnerabilities to address first. metrics provide valuable insights that help prioritize alerts efficiently, ensuring that critical security issues are resolved promptly. Users can make i... | {
"source": "github-docs/code-security/tutorials/manage-security-alerts/prioritizing-dependabot-alerts-using-metrics.md",
"title": "Prioritizing Dependabot alerts using metrics"
} |
Introduction
After enabling (GHSP) for your organization, you'll want to assess its impact and understand how it's protecting your organization. This tutorial walks you through accessing secret-related data and interpreting the results to measure GHSP performance.
In this tutorial, you'll learn how to:
Access your ... | {
"source": "github-docs/code-security/tutorials/remediate-leaked-secrets/assessing-ghsp-impact.md",
"title": "Assessing the impact of GitHub Secret Protection"
} |
What is the cost savings calculator?
You can use the to estimate the cost avoided by preventing leaked secrets with push protection. This information can help you:
Determine how widely to enable in your organization.
Compare the estimated impact of push protection in different teams or environments.
Communicate ti... | {
"source": "github-docs/code-security/tutorials/remediate-leaked-secrets/calculate-cost-savings.md",
"title": "Calculating the cost savings of push protection"
} |
About evaluating alerts
There are some additional features that can help you to evaluate alerts in order to better prioritize and manage them. You can:
Check the validity of a secret, to see if the secret is still active. Applies to tokens only. See Checking a secret's validity.
Perform an "on-demand" validity check... | {
"source": "github-docs/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md",
"title": "Evaluating alerts from secret scanning"
} |
MetadataDescription
---------------------------------------------------------------------------------------------------------
Secret name The name given to the token by its creator
Secret owner The handle of the token's owner
Created on Date the token was created
Expired on Date the token expired
Last used on Date th... | {
"source": "github-docs/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md",
"title": "Evaluating alerts from secret scanning"
} |
Access Whether the token has organization access
If access is granted, will notify the owner of the repository containing the leaked secret, report the action in the repository owner and enterprise audit logs, and enable access for 2 hours. For more information, see AUTOTITLE.
Reviewing extended metadata for a token... | {
"source": "github-docs/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md",
"title": "Evaluating alerts from secret scanning"
} |
LabelDescriptionAlert view information
----------------------------------------------------------------------------------------------------------------------------------
public leak The secret detected in your repository has also been found as publicly leaked by at least one of 's scans of code, discussions, gists, iss... | {
"source": "github-docs/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md",
"title": "Evaluating alerts from secret scanning"
} |
Introduction
Secrets, such as API keys, tokens and credentials, can pose significant security risks to your team and organization if inadvertently exposed in your codebase or stored improperly.
You should consider any leaked secret to be immediately compromised and it is essential that you undertake proper remediation ... | {
"source": "github-docs/code-security/tutorials/remediate-leaked-secrets/remediating-a-leaked-secret.md",
"title": "Remediating a leaked secret in your repository"
} |
scans repositories for known secret formats to prevent fraudulent use of credentials that were committed accidentally. happens by default on public repositories and public npm packages. Repository administrators and organization owners can also enable on private repositories. As a service provider, you can partner wi... | {
"source": "github-docs/code-security/tutorials/secret-scanning-partner-program.md",
"title": "Secret scanning partner program"
} |
Sample HTTP POST sent to verify endpoint
POST / HTTP/2
Host: HOST
Accept: */*
Content-Length: 104
Content-Type: application/json
Github-Public-Key-Identifier: bcb53661c06b4728e59d897fb6165d5c9cda0fd9cdf9d09ead458168deb7518c
Github-Public-Key-Signature: MEQCIQDaMKqrGnE27S0kgMrEK0eYBmyG0LeZismAEz/BgZyt7AIfXt9fErtRS4XaeSt... | {
"source": "github-docs/code-security/tutorials/secret-scanning-partner-program.md",
"title": "Secret scanning partner program"
} |
Validation sample in Go
package main
import (
"crypto/ecdsa"
"crypto/sha256"
"crypto/x509"
"encoding/asn1"
"encoding/base64"
"encoding/json"
"encoding/pem"
"errors"
"fmt"
"math/big"
"net/http"
"os"
)
func main() {
payload := `[{"source":"commit","token":"some_token","type":"some_type","url":"h... | {
"source": "github-docs/code-security/tutorials/secret-scanning-partner-program.md",
"title": "Secret scanning partner program"
} |
Validation sample in Ruby
require 'openssl'
require 'net/http'
require 'uri'
require 'json'
require 'base64'
payload = <<-EOL
[{"source":"commit","token":"some_token","type":"some_type","url":"https://example.com/base-repo-url/"}]
EOL
payload = payload
signature = "MEQCIQDaMKqrGnE27S0kgMrEK0eYBmyG0LeZismAEz/BgZyt7AIfXt... | {
"source": "github-docs/code-security/tutorials/secret-scanning-partner-program.md",
"title": "Secret scanning partner program"
} |
Validation sample in JavaScript
const crypto = require("crypto");
const axios = require("axios");
const GITHUB_KEYS_URI = "https://api.github.com/meta/public_keys/secret_scanning";
/**
* Verify a payload and signature against a public key
* @param {String} payload the value to verify
* @param {String} signature the ... | {
"source": "github-docs/code-security/tutorials/secret-scanning-partner-program.md",
"title": "Secret scanning partner program"
} |
[!NOTE] This article explains how to automate -related tasks using . For more information about running using , see AUTOTITLE instead.
You can use to perform automated tasks when creates pull requests to update dependencies. You may find this useful if you want to:
Ensure that pull requests (version updates and se... | {
"source": "github-docs/code-security/tutorials/secure-your-dependencies/automate-dependabot-with-actions.md",
"title": "Automating Dependabot with GitHub Actions"
} |
Introduction
The scans your pull requests for dependency changes and raises an error if any new dependencies have known vulnerabilities. Once installed, if the workflow run is marked as required, pull requests introducing known vulnerable packages will be blocked from merging.
This guide shows you how to add three ver... | {
"source": "github-docs/code-security/tutorials/secure-your-dependencies/customize-dependency-review-action.md",
"title": "Customizing your dependency review action configuration"
} |
There are various ways to customize your pull requests so that they better suit your own internal processes.
For example, to integrate 's pull requests into your CI/CD pipelines, it can apply custom labels to pull requests, which you can then use to trigger action workflows.
There are several different customization o... | {
"source": "github-docs/code-security/tutorials/secure-your-dependencies/customizing-dependabot-prs.md",
"title": "Customizing Dependabot pull requests to fit your processes"
} |
About
This quickstart guide walks you through setting up and enabling , viewing , and updating your repository to use a secure version of the dependency.
Prerequisites
Before you can use the feature in , you must ensure that your enterprise administrator enables for the instance. For more information, see AUTOTITLE... | {
"source": "github-docs/code-security/tutorials/secure-your-dependencies/dependabot-quickstart.md",
"title": "Dependabot quickstart guide"
} |
By default, opens a new pull request to update each dependency. When you enable security updates, new pull requests are opened when a vulnerable dependency is found. When you configure version updates for one or more ecosystems, new pull requests are opened when new versions of dependencies are available, with the fre... | {
"source": "github-docs/code-security/tutorials/secure-your-dependencies/optimizing-pr-creation-version-updates.md",
"title": "Optimizing the creation of pull requests for Dependabot version updates"
} |
Working with the (ARC)
This article provides step-by-step instructions for setting up ARC on a Kubernetes cluster and configuring to run on self-hosted action runners. The article:
Contains an overview of the ARC and integration.
Provides detailed installation and configuration steps using helm scripts.
What is A... | {
"source": "github-docs/code-security/tutorials/secure-your-dependencies/setting-dependabot-to-run-on-self-hosted-runners-using-arc.md",
"title": "Setting up Dependabot to run on self-hosted action runners using the Actions Runner Controller"
} |
Launching your first campaign
In this tutorial, you’ll plan and run your first organization-wide security campaign focused on XSS alerts. Along the way, you’ll learn how to select the right alerts, prepare developers for success, and structure a campaign that drives meaningful improvements in your security posture.
Ima... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/best-practice-fix-alerts-at-scale.md",
"title": "Running a security campaign to fix alerts at scale"
} |
Introduction
In this tutorial, you'll interpret your results, and learn how to:
Understand risk metrics on the dashboard
Identify which repositories and languages are most affected
Prioritize vulnerabilities for remediation
Prerequisites
You must generate a report and wait for the scan to complete. See AUTOTITLE.... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/interpret-code-security-risk-assessment.md",
"title": "Interpreting code security risk assessment results"
} |
Introduction
In this tutorial, you'll interpret your secret risk assessment results, and learn how to:
Understand risk metrics on the dashboard
Identify high-risk secret leaks
Prioritize secrets for remediation
Prerequisites
You must generate a report and wait for the scan to complete. See AUTOTITLE.
Step 1: Unde... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/interpret-secret-risk-assessment.md",
"title": "Interpreting secret risk assessment results"
} |
Introduction
In this tutorial, you'll organize remediation efforts for leaked secrets. You'll learn how to:
Create security campaigns to track remediation work
Assign alerts based on ownership
Monitor remediation progress
Communicate with stakeholders
Prerequisites
You must have both and enabled for your organi... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/organize-leak-remediation.md",
"title": "Organizing remediation efforts for leaked secrets"
} |
The guidance in this article is aimed at enterprise owners, organization owners, security managers and security teams. However, you will need to have the enterprise owner role to enable several of the features referenced in this article.
Introduction
When a security incident occurs, the ability to investigate what hap... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/prepare-for-a-security-incident.md",
"title": "Preparing for a security incident"
} |
About this guide
As an organization owner, preventing exposure of private or sensitive data should be a top priority. Whether intentional or accidental, data leaks can cause substantial risk to the parties involved. While takes measures to help protect you against data leaks, you are also responsible for administering... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/prevent-data-leaks.md",
"title": "Best practices for preventing data leaks in your organization"
} |
Recommendation More information
------------------ -----------------
Disable the ability to fork repositories. AUTOTITLE
Disable changing repository visibility. AUTOTITLE
Restrict repository creation to private or internal. AUTOTITLE
Disable repository deletion and transfer. AUTOTITLE
Disable the ability to use ... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/prevent-data-leaks.md",
"title": "Best practices for preventing data leaks in your organization"
} |
Application Security (AppSec) managers are often overwhelmed by a high volume of alerts, many of which may not represent real risk because the affected code never makes it to production. By associating production context with your alerts, you can filter and prioritize vulnerabilities that impact artifacts actually appr... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md",
"title": "Prioritizing Dependabot and code scanning alerts using production context"
} |
Introduction
Preventing security incidents is less costly and less disruptive than responding
to them. By proactively hardening your environment on , you reduce your exposure to threats such as exploited credentials, unauthorized access, and supply chain attacks.
This guide primarily focuses on the protective measures ... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/protect-against-threats.md",
"title": "Protecting against security threats"
} |
The guidance in this article is aimed at enterprise owners, organization owners, security managers and security teams. However, you will need to have the enterprise owner role to perform several of the actions outlined in this article. Some steps may require coordination with organization owners or repository administr... | {
"source": "github-docs/code-security/tutorials/secure-your-organization/respond-to-a-security-incident.md",
"title": "Responding to a security incident"
} |
This article assumes that you have planned and then started a trial of . For more information, see AUTOTITLE.
The aim is to enable all the security features you want to trial quickly, as a starting point for deeper exploration. You should start getting results soon on the repositories in your trial enterprise and you c... | {
"source": "github-docs/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md",
"title": "Enabling security features in your trial enterprise"
} |
This guide assumes that you have planned and started a trial of for an existing or trial enterprise account, see AUTOTITLE.
Introduction
and dependency analysis work in the same way in public repositories and in private and internal repositories with enabled. In addition, enables you to create security campaigns ... | {
"source": "github-docs/code-security/tutorials/trialing-github-advanced-security/explore-trial-code-scanning.md",
"title": "Exploring your enterprise trial of {% data variables.product.prodname_GH_code_security_always %}"
} |
This guide assumes that you have planned and started a trial of for an existing or trial enterprise account. See AUTOTITLE.
Introduction
features work the same way in private and internal repositories as they do in all public repositories. This article focuses on the additional functionality that you can use to pro... | {
"source": "github-docs/code-security/tutorials/trialing-github-advanced-security/explore-trial-secret-scanning.md",
"title": "Exploring your enterprise trial of {% data variables.product.prodname_GH_secret_protection_always %}"
} |
Is a self-serve trial right for you?
This article is for organizations that want to begin a trial of independently, without the help of an expert or partner. Typically, that means you're a small or medium-sized organization.
This article helps you plan for a self-serve trial of . A self-serve trial is right for you if... | {
"source": "github-docs/code-security/tutorials/trialing-github-advanced-security/planning-a-trial-of-ghas.md",
"title": "Planning a trial of {% data variables.product.prodname_GHAS %}"
} |
Prerequisites
To set up a trial of using this method, you must meet the following criteria:
1. You are an owner of an enterprise account. See AUTOTITLE.
1. You pay by credit card or PayPal.
1. You have not previously purchased (that is, you do not currently or in the past have a paid license for ).
1. You are not alr... | {
"source": "github-docs/code-security/tutorials/trialing-github-advanced-security/trial-advanced-security.md",
"title": "Setting up a trial of GitHub Advanced Security"
} |
features
Preconfigured development environments
You can work in a development environment that has been specifically configured for the repository. It will have all of the tools, languages, and configurations you need to work on that project. Everyone who works on that repository in a codespace will have the same envi... | {
"source": "github-docs/codespaces/about-codespaces/codespaces-features.md",
"title": "GitHub Codespaces features"
} |
is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. is also configurable, allowing you to create a customized development environment for your project. By configuring a custom development environment for your project, you ... | {
"source": "github-docs/codespaces/about-codespaces/deep-dive.md",
"title": "Deep dive into {% data variables.product.prodname_github_codespaces %}"
} |
To stop your codespace you can
In the browser: on your list of codespaces at https://github.com/codespaces, click the ellipsis (...) to the right of the codespace you want to stop and click Stop codespace.
In : open the - for example, by pressing <kbdCtrl</kbd+<kbdShift</kbd+<kbdP</kbd (Windows/Linux) or <kbdShift</... | {
"source": "github-docs/codespaces/about-codespaces/deep-dive.md",
"title": "Deep dive into {% data variables.product.prodname_github_codespaces %}"
} |
[!NOTE]
This article explains the stages in the life of a codespace, from creation to deletion. If you have read the AUTOTITLE article and you now want to start using for your own work, see the articles under AUTOTITLE.
About the lifecycle of a codespace
The lifecycle of a codespace begins when you create a codespac... | {
"source": "github-docs/codespaces/about-codespaces/understanding-the-codespace-lifecycle.md",
"title": "Understanding the codespace lifecycle"
} |
Introduction
A codespace is a development environment that's hosted in the cloud. You can customize your project for by committing configuration files to your repository (often known as Configuration-as-Code), which creates a repeatable codespace configuration for all users of your project. See AUTOTITLE.
Each codespa... | {
"source": "github-docs/codespaces/about-codespaces/what-are-codespaces.md",
"title": "What are {% data variables.product.prodname_github_codespaces %}?"
} |
About machine types
You can choose an alternative machine type either when you create a codespace or at any time after you've created a codespace.
For information on choosing a machine type when you create a codespace, see AUTOTITLE.
For more information, see AUTOTITLE.
Changing the machine type
[!NOTE]
The numb... | {
"source": "github-docs/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md",
"title": "Changing the machine type for your codespace"
} |
When you're working in a codespace, you can open a new terminal window with a shell of your choice, change your default shell for new terminal windows, or install a new shell. You can also use dotfiles to configure your shell.
Codespaces that use the default dev container image come with the bash, zsh, and fish shells ... | {
"source": "github-docs/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md",
"title": "Changing the shell in a codespace"
} |
About renaming a codespace
When you create a codespace it's assigned an auto-generated display name. If you have multiple codespaces, the display name helps you to differentiate between codespaces. For example: literate space parakeet. You can change the display name for your codespace.
To find the display name of a co... | {
"source": "github-docs/codespaces/customizing-your-codespace/renaming-a-codespace.md",
"title": "Renaming a codespace"
} |
About codespace networking
By default, your codespaces have access to all resources on the public internet, including package managers, license servers, databases, and cloud platform APIs, but they have no access to resources on private networks.
Connecting to resources on a private network
There are currently two met... | {
"source": "github-docs/codespaces/developing-in-a-codespace/connecting-to-a-private-network.md",
"title": "Connecting to a private network"
} |
About creating a codespace for a repository
Use the tabs in this article to display instructions for each of these ways of creating a codespace.
You can use on your personal account, with the quota of free use included each month for accounts on the Free and Pro plans.
Organizations can enable members and outside c... | {
"source": "github-docs/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md",
"title": "Creating a codespace for a repository"
} |
About templates for
If you're starting a new project, you can get started with development work quickly by creating a codespace from a template. You'll be able to work on your project in a cloud-based development environment, save your files in the cloud, and publish your work to a new remote repository that you can s... | {
"source": "github-docs/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md",
"title": "Creating a codespace from a template"
} |
About default environment variables
sets default environment variables for every codespace. Commands run in codespaces can create, read, and modify environment variables.
[!NOTE]
Environment variables are case-sensitive.
List of default environment variables
Environment variable Description
--------------------... | {
"source": "github-docs/codespaces/developing-in-a-codespace/default-environment-variables-for-your-codespace.md",
"title": "Default environment variables for your codespace"
} |
Overview
See AUTOTITLE.
You can manually delete a codespace in a variety of ways:
In the terminal by using
In
In your web browser
Use the tabs at the top of this article to display instructions for each of these ways of deleting a codespace.
[!NOTE]
You can't delete a codespace from within JupyterLab.
Why you ... | {
"source": "github-docs/codespaces/developing-in-a-codespace/deleting-a-codespace.md",
"title": "Deleting a codespace"
} |
About development with
You can develop code in a codespace using your choice of tool:
A command shell, via an SSH connection initiated using
The desktop application
A browser-based version of
The tabs in this article allow you to switch between information for each of these ways of working. You're currently on t... | {
"source": "github-docs/codespaces/developing-in-a-codespace/developing-in-a-codespace.md",
"title": "Developing in a codespace"
} |
About forwarded ports
Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on a particular port in your codespace, you can forward that port. This allows you to access the application from the browser on your local machine for testing and debuggin... | {
"source": "github-docs/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md",
"title": "Forwarding ports in your codespace"
} |
Introduction
This guide introduces you to machine learning with . You’ll build a simple image classifier, learn about some of the tools that come preinstalled in , and find out how to open your codespace in JupyterLab.
Building a simple image classifier
We'll use a Jupyter notebook to build a simple image classifier.
... | {
"source": "github-docs/codespaces/developing-in-a-codespace/getting-started-with-github-codespaces-for-machine-learning.md",
"title": "Getting started with GitHub Codespaces for machine learning"
} |
You can reopen any of your active or stopped codespaces on , in , or by using . You can't reopen a codespace that has been deleted. See AUTOTITLE.
You can view all your codespaces on the "Your codespaces" page at github.com/codespaces. From this page, you can:
Open, stop, or delete your codespaces.
See who owns (and ... | {
"source": "github-docs/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md",
"title": "Opening an existing codespace"
} |
Setting persistent environment variables
You can set persistent custom environment variables in multiple ways, depending on which codespaces, repositories, or users you want the variables to be available to.
For all the methods of setting custom variables listed below, you can access the custom variable in your codespa... | {
"source": "github-docs/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files.md",
"title": "Persisting environment variables and temporary files"
} |
About rebuilding the dev container
When you work in a codespace, your development environment is a Docker container that runs on a virtual machine. If you make changes to your dev container configuration from within a codespace, and you want to apply those changes to the current codespace, you need to rebuild the conta... | {
"source": "github-docs/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace.md",
"title": "Rebuilding the container in a codespace"
} |
About stopping and starting a codespace
Regardless of where you created or access your codespaces, you can view and manage them in your browser at https://github.com/codespaces.
Stopping a codespace
1. To the right of the codespace you want to stop, click the ellipsis (...).
1. Click Stop codespace.
!Screenshot o... | {
"source": "github-docs/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md",
"title": "Stopping and starting a codespace"
} |
Using a codespace to work on a pull request gives you all the benefits of . For more information, see AUTOTITLE.
About pull requests in
provides you with many of the capabilities you might need to work with pull requests:
Create a pull request - Using either the Terminal and Git commands or the "Source Control" vie... | {
"source": "github-docs/codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests.md",
"title": "Using GitHub Codespaces for pull requests"
} |
About in
You can use your local install of to create, manage, work in, and delete codespaces. For more information on setting up in , see Prerequisites.
By default, if you create a new codespace on , it will open in the browser. If you would prefer to open any new codespaces in automatically, you can set your def... | {
"source": "github-docs/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code.md",
"title": "Using GitHub Codespaces in Visual Studio Code"
} |
About
For more information, see AUTOTITLE.
You can work with in the to:
List all of your codespaces
Create a new codespace
View details of a codespace
Stop a codespace
Delete a codespace
Rename a codespace
Rebuild a codespace
SSH into a codespace
Open a codespace in
Open a codespace in JupyterLab
Copy a... | {
"source": "github-docs/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli.md",
"title": "Using GitHub Codespaces with GitHub CLI"
} |
About source control in
You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from a remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter ... | {
"source": "github-docs/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md",
"title": "Using source control in your codespace"
} |
Live Share lets you collaboratively edit and debug with others in real time, within a codespace. You can securely share your current codespace, or access a codespace created by someone else.
You can start a Live Share session either within the web client in your browser, or within the desktop application.
For more in... | {
"source": "github-docs/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace.md",
"title": "Working collaboratively in a codespace"
} |
Overview
If you're the owner of an organization on a or plan, you can pay for your members' and collaborators' usage of . Paying for usage will allow people to use to work in your repositories without having to do so at their own expense and will give your organization more control over the codespaces created from y... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md",
"title": "Choosing who owns and pays for codespaces in your organization"
} |
About enabling and disabling
is always available in an organization's public repositories. Any user can create a codespace from these repositories.
If your organization is on a plan, is always available in your organization's private repositories. Any user with access to these repositories can create a codespace at... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md",
"title": "Enabling or disabling GitHub Codespaces for your organization"
} |
Overview
As an organization owner, you can list all of the currently active and stopped codespaces for your organization. You might want to do this to check how many codespaces users are creating, to make sure they aren't incurring unnecessary costs. For information about pricing, see AUTOTITLE.
The easiest way to list... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/listing-the-codespaces-in-your-organization.md",
"title": "Listing the codespaces in your organization"
} |
About secrets
Development environment secrets are encrypted environment variables that you create in the settings for an organization, a repository, or a personal account. This article explains how to manage organization secrets and repository secrets. For information on creating user-specific secrets, see AUTOTITLE.
... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization.md",
"title": "Managing development environment secrets for your repository or organization"
} |
Overview
Your organization is billed according to its compute and storage usage for . This article explains the ways in which you, as an organization owner, can manage these costs.
To learn about pricing for , see AUTOTITLE.
Spending limits
You can set a spending limit for for your organization. This limit is applied... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md",
"title": "Managing the cost of GitHub Codespaces in your organization"
} |
Overview
Typically, when you create a codespace you are offered a choice of specifications for the machine that will run your codespace. You can choose the machine type that best suits your needs. For more information, see AUTOTITLE.
If you pay for using then your choice of machine type will affect how much you are bi... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md",
"title": "Restricting access to machine types"
} |
Overview
When you create a codespace, a development container is automatically created on a remote virtual machine. This dev container is created from a Docker image. The image is effectively a template for Docker containers and it determines many aspects of the resulting environment provided by the codespace. For more... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md",
"title": "Restricting the base image for codespaces"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.