-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Document organization deletion feature #9475
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
3ea9725
Adding new page with instructions to delete organizations and projects
yaningo 3863ed8
Adding navigation item pointing to new page
yaningo e85535e
Adjusting layout
yaningo 02e5dd7
Removing project deletion content and linking to new location
yaningo 284baa8
Small fixes
yaningo 1aa6dd6
Turning sentence into caution block
yaningo e387b36
Changing header alignment
yaningo 6695cf4
Rewording
yaningo c1e4b39
Adding warning
yaningo 012737a
Modifying some text
yaningo be8d6ac
Adding note and link to 'Stop building' page
yaningo 1ad0d19
Adding notes for BB Data Center
yaningo daca291
Adding actions and roles to permission matrix
yaningo b6e5cee
Merge branch 'main' into DOCSS-1859-document-delete-org-feature
rosieyohannan ba5090f
Implementing review suggestions
yaningo 06584ab
Merge branch 'main' into DOCSS-1859-document-delete-org-feature
yaningo a7078c6
Merge branch 'main' into DOCSS-1859-document-delete-org-feature
yaningo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
119 changes: 119 additions & 0 deletions
119
docs/guides/modules/security/pages/delete-organizations-and-projects.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
= Delete organizations and projects | ||
:page-platform: Cloud | ||
:page-description: Learn how to delete organizations and projects in CircleCI. | ||
:experimental: | ||
|
||
This page details everything you need to know about deleting organizations and projects connected to CircleCI. | ||
|
||
If you only want to stop builds for a project and keep the complete build history, see the xref:security:stop-building-a-project-on-circleci.adoc[Stop building a project on CircleCI] page. | ||
|
||
[cols="1,^1,^1,2", options="header"] | ||
|=== | ||
| VCS integration | Delete organization | Delete project | Notes | ||
|
||
| GitHub App | ||
| [.circle-green]#Yes# | ||
| [.circle-green]#Yes# | ||
| The organization will remain visible for several hours before disappearing. | ||
|
||
| GitLab | ||
| [.circle-green]#Yes# | ||
| [.circle-green]#Yes# | ||
| The organization will remain visible for several hours before disappearing. | ||
|
||
| Bitbucket Data Center | ||
| [.circle-green]#Yes# | ||
| [.circle-green]#Yes# | ||
| The organization will remain visible for several hours before disappearing. | ||
|
||
| GitHub OAuth app | ||
| [.circle-green]#Yes# | ||
| [.circle-green]#Yes# | ||
| Deleting the organization removes all content from the organization. The organization will remain visible but without data underneath. | ||
|
||
| Bitbucket Cloud | ||
| [.circle-green]#Yes# | ||
| [.circle-green]#Yes# | ||
| Deleting the organization removes all content from the organization. The organization will remain visible but without data underneath. | ||
|
||
|=== | ||
|
||
|
||
[#delete-an-organization] | ||
== Delete an organization | ||
|
||
[NOTE] | ||
==== | ||
You can only delete an organization when both the below conditions are met: | ||
|
||
- The organization is on a Free Plan. | ||
- The user performing the action has an admin role in the organization. | ||
==== | ||
You can delete your organization from the CircleCI web app or via the CircleCI API: | ||
|
||
CAUTION: This action will permanently delete the organization for you and all organization members. | ||
|
||
[tabs] | ||
==== | ||
CircleCI web app:: | ||
+ | ||
-- | ||
. In the link:https://app.circleci.com[CircleCI web app], select your org from the org cards on your user homepage. | ||
. Select **Organization Settings** in the sidebar. | ||
. Scroll to the bottom of the Overview page and select btn:[Delete Organization]. | ||
. Confirm your choice by typing the organization name and selecting btn:[Permanently Delete Organization] in the popup. | ||
-- | ||
API:: | ||
+ | ||
-- | ||
. Set up your API authentication. Steps are available in the xref:toolkit:api-developers-guide.adoc#add-an-api-token[API developers guide]. | ||
. You can use the link:https://circleci.com/docs/api/v2/#tag/Organization/operation/deleteOrganization[Delete an organization] endpoint with either your organization ID or your organization slug. You can retrieve both from the CircleCI web app under menu:Organization Settings[Overview]. | ||
+ | ||
[,shell] | ||
---- | ||
curl --request DELETE \ | ||
--url https://circleci.com/api/v2/organization/<org-slug-or-id> \ | ||
--header "Circle-Token: ${CIRCLE_TOKEN}" | ||
---- | ||
-- | ||
==== | ||
|
||
[#delete-a-project] | ||
== Delete a project | ||
|
||
NOTE: Only organization admins and project admins can delete projects. | ||
|
||
If you want to remove a project from your CircleCI account, follow the steps below. | ||
|
||
CAUTION: Deleting a project will remove the complete build history. | ||
|
||
[tabs] | ||
==== | ||
CircleCI web app:: | ||
+ | ||
-- | ||
include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[] | ||
|
||
[start=4] | ||
. Scroll to the bottom of the Overview page, select **Delete Project**. | ||
. Confirm your choice by typing the project name and selecting btn:[Permanently Delete Project] in the popup. | ||
-- | ||
API:: | ||
+ | ||
-- | ||
. Set up your API authentication. Steps are available in the xref:toolkit:api-developers-guide.adoc#add-an-api-token[API developers guide]. | ||
. You need the project slug to use the link:https://circleci.com/docs/api/v2/#tag/Project/operation/deleteProjectBySlug[Delete a project] endpoint. You can retrieve the project slug from the CircleCI web app under menu:Project Settings[Overview]. | ||
+ | ||
[,shell] | ||
---- | ||
curl --request DELETE \ | ||
--url https://circleci.com/api/v2/project/<project-slug> \ | ||
--header "Circle-Token: ${CIRCLE_TOKEN}" | ||
---- | ||
-- | ||
==== | ||
|
||
If you encounter an error, open a new link:https://support.circleci.com/hc/en-us/requests/new[support request] with details of the project that you wish to remove. Choose the "Build Failure/Configuration Help/Service Issue" option when opening the request. | ||
|
||
For more information on submitting support requests, see https://support.circleci.com/hc/en-us/articles/27162205043995-How-to-submit-a-support-ticket[How to submit a support ticket | ||
]. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.