publishing-a-repository-security-advisory.md

title	intro	redirect_from	versions	type	topics	shortTitle
Publishing a repository security advisory	You can publish a security advisory to alert your community about a security vulnerability in your project.	/articles/publishing-a-maintainer-security-advisory /github/managing-security-vulnerabilities/publishing-a-maintainer-security-advisory /github/managing-security-vulnerabilities/publishing-a-security-advisory /code-security/security-advisories/publishing-a-security-advisory /code-security/repository-security-advisories/publishing-a-repository-security-advisory /code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory	fpt ghec * *	how_to	Security advisories Vulnerabilities CVEs Repositories	Publish repository advisories

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

{% data reusables.security-advisory.repository-level-advisory-note %}

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. For more information, see "AUTOTITLE."

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. For more information, see "AUTOTITLE."

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.

{% data reusables.repositories.security-advisories-republishing %}

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

{% warning %}

Warning: Whenever possible, you should always add a fix version to a security advisory prior to publishing the advisory. If you don't, the advisory will be published without a fixed version, and {% data variables.product.prodname_dependabot %} will alert your users about the issue, without offering any safe version to update to.

We recommend you take the following steps in these different situations:

• If a fix version is imminently available, and you are able to, wait to disclose the issue when the fix is ready.
• If a fix version is in development but not yet available, mention this in the advisory, and edit the advisory later, after publication.
• If you are not planning to fix the issue, be clear about it in the advisory so that your users don't contact you to ask when a fix will be made. In this case, it is helpful to include steps users can take to mitigate the issue.

{% endwarning %}

When you publish a draft advisory from a public repository, everyone is able to see:

• The current version of the advisory data.
• Any advisory credits that the credited users have accepted.

{% note %}

Note: The general public will never have access to the edit history of the advisory, and will only see the published version.

{% endnote %}

After you publish a security advisory, the URL for the security advisory will remain the same as before you published the security advisory. Anyone with read access to the repository can see the security advisory. Collaborators on the security advisory can continue to view past conversations, including the full comment stream, in the security advisory unless someone with admin permissions removes the collaborator from the security advisory.

If you need to update or correct information in a security advisory that you've published, you can edit the security advisory. For more information, see "AUTOTITLE."

Publishing a security advisory

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

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %}

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

2. Scroll to the bottom of the advisory form and click Publish advisory.

   

{% note %}

Note: If you selected "Request CVE ID later", you will see a Request CVE button in place of the Publish advisory button. For more information, see "Requesting a CVE identification number (Optional)" below.

{% endnote %}

{% data variables.product.prodname_dependabot_alerts %} for published security advisories

{% data reusables.repositories.github-reviews-security-advisories %}

Requesting a CVE identification number (Optional)

{% data reusables.repositories.request-security-advisory-cve-id %} For more information, see "AUTOTITLE."

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %}

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

2. Scroll to the bottom of the advisory form and click Request CVE.

   

Further reading

• "AUTOTITLE"