Publishing a security advisory

You can publish a security advisory to alert your community about a security vulnerability in your project.

Anyone with admin permissions to a security advisory can publish the security advisory.

In this article

Prerequisites

Before you can publish a security advisory or request a CVE identification number, you must create a draft security advisory and provide information about the versions of your project affected by the security vulnerability.

If you've created a security advisory but haven't yet provided details about the versions of your project that the security vulnerability affects, you can edit the security advisory's details at the top of the security advisory.

For more information, see "Creating a security advisory."

About publishing a security advisory

When you publish a security advisory, you notify your community about the security vulnerability that the security advisory addresses. Publishing a security advisory makes it easier for your community to update package dependencies and research the impact of the security vulnerability.

After you publish a security advisory, anyone with read access to the repository can see the security advisory. The URL for the security advisory will remain the same as before you published the security advisory.

Before you publish a security advisory, you can privately collaborate to fix the vulnerability in a temporary private fork. For more information, see "Collaborating in a temporary private fork to resolve a security vulnerability."

Requesting a CVE identification number

Anyone with admin permissions to a security advisory can request a CVE identification number for the security advisory.

If you don't already have a CVE identification number for the security vulnerability in your project, you can request a CVE identification number from GitHub. Assigning a CVE identification number generally takes 72 hours or less. For more information, see "About GitHub Security Advisories."

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Security.

    Security tab

  3. In the left sidebar, click Advisories.

    Advisories tab

  4. In the "Security Advisories" list, click the security advisory you'd like to request a CVE identification number for.

    Security advisory in list

  5. Use the Publish advisory drop-down menu, and click Request CVE.

    Request CVE in drop-down

  6. Click Request CVE.

    Request CVE button

Publishing a security advisory

Publishing a security advisory deletes the temporary private fork for the security advisory.

GitHub will review each published security advisory, add it to the GitHub Advisory Database, and may use the security advisory to send security alerts to affected repositories. If the security advisory comes from a fork, we'll only send an alert if the fork owns a package, published under a unique name, on a public package registry. This process can take up to 72 hours and GitHub may contact you for more information.

For more information about security alerts, see "About security alerts for vulnerable dependencies." For more information about GitHub Advisory Database, see "Browsing security vulnerabilities in the GitHub Advisory Database."

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Security.

    Security tab

  3. In the left sidebar, click Advisories.

    Advisories tab

  4. In the "Security Advisories" list, click the security advisory you'd like to publish.

    Security advisory in list

  5. At the bottom of the page, click Publish advisory.

    Publish advisory button

Security alerts for published security advisories

GitHub will review each published security advisory, add it to the GitHub Advisory Database, and may use the security advisory to send security alerts to affected repositories. If the security advisory comes from a fork, we'll only send an alert if the fork owns a package, published under a unique name, on a public package registry. This process can take up to 72 hours and GitHub may contact you for more information.

For more information about security alerts, see "About security alerts for vulnerable dependencies." For more information about GitHub Advisory Database, see "Browsing security vulnerabilities in the GitHub Advisory Database."

Further reading

Ask a human

Can't find what you're looking for?

Contact us