Skip to content
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

Bitbucket Data Center support #8876

Merged
merged 24 commits into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
bda92f0
first few pages
rosieyohannan Jul 24, 2024
2bc6cfe
add closed preview banner
rosieyohannan Jul 24, 2024
6aa84a7
start updating screenshots for project creation flow inc BBDC
rosieyohannan Jul 25, 2024
afdc7ef
working towards getting steps right for now and will epand later afte…
rosieyohannan Jul 29, 2024
00ed20e
add placeholder for known hosts info to be added
rosieyohannan Jul 29, 2024
f051da8
fix conflict
rosieyohannan Jul 31, 2024
923e822
Merge branch 'master' into DOCSS-1470-BBDC-support
rosieyohannan Aug 6, 2024
bdaf053
update bitbucket integration page to specify Bitbucket Cloud
rosieyohannan Aug 7, 2024
e67f64e
update bbdc integration page
rosieyohannan Aug 12, 2024
9aa49ee
update built-in env vars list to include bitbucket cloud
rosieyohannan Aug 12, 2024
2db215c
move steps to set up integration pipeline and trigger to integration …
rosieyohannan Aug 12, 2024
51619fe
add trigger steps
rosieyohannan Aug 13, 2024
bc58c20
move sections around to make flow better
rosieyohannan Aug 13, 2024
699caeb
add references to BBDC and BB Cloud
rosieyohannan Aug 13, 2024
15185b4
fix conflicts
rosieyohannan Aug 13, 2024
222bc83
fix lint errors
rosieyohannan Aug 13, 2024
0dfd5f6
fix lint error
rosieyohannan Aug 13, 2024
43011ce
improve flow of integration setup steps
rosieyohannan Aug 14, 2024
3ad952d
add hello world example to sample config
rosieyohannan Aug 14, 2024
31b4d65
update link to waiting list form
rosieyohannan Aug 14, 2024
0e45f82
suggestions from review
rosieyohannan Aug 14, 2024
27274a9
Merge branch 'master' into DOCSS-1470-BBDC-support
rosieyohannan Aug 14, 2024
3f85ccf
simplify some pipeline value entries
rosieyohannan Aug 14, 2024
05c9b46
simplify built-in env var support
rosieyohannan Aug 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions jekyll/_cci2/add-ssh-key.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ contentTags:

Add additional SSH keys to your project for access to deploy other services or to write to, or checkout code from other repositories.

If you want to set up an SSH key in order to checkout code from additional repositories in GitHub (xref:github-integration#[GitHub OAuth app only]) or Bitbucket within a job, refer to the xref:github-integration#enable-your-project-to-check-out-additional-private-repositories[GitHub] or xref:bitbucket-integration#enable-your-project-to-check-out-additional-private-repositories[Bitbucket] integration pages. If you need additional SSH keys to access other services and your org is set up to the use xref:github-integration#[GitHub OAuth app] or Bitbucket, follow the steps below.
If you want to set up an SSH key in order to checkout code from additional repositories in GitHub (xref:github-integration#[GitHub OAuth app only]) or Bitbucket Cloud within a job, refer to the xref:github-integration#enable-your-project-to-check-out-additional-private-repositories[GitHub OAuth app] or xref:bitbucket-integration#enable-your-project-to-check-out-additional-private-repositories[Bitbucket Cloud] integration pages. If you need additional SSH keys to access other services and your org is set up to the use xref:github-integration#[GitHub OAuth app] or Bitbucket Cloud, follow the steps below.

You may need to add the public key to `~/.ssh/authorized_keys` in order to add SSH keys.

Expand All @@ -34,14 +34,14 @@ CircleCI cannot decrypt SSH keys, therefore every new key must have an empty pas

. In a terminal, generate the key with `ssh-keygen -t ed25519 -C "your_email@example.com"`. See link:https://www.ssh.com/ssh/keygen/[Secure Shell documentation] for additional details.
. In the CircleCI application, go to your project's settings by clicking the *Project Settings* button (top-right on the *Pipelines* page of the project).
. On the *Project Settings* page, click on *SSH Keys*.
. On the *Project Settings* page, select *SSH Keys*.
. Scroll down to the *Additional SSH Keys* section.
+
If you have a GitLab integration, you will find that an additional SSH key already exists. This was created automatically by CircleCI during the project creation process. This key is used to checkout your code so it should not be removed.
. Click the *Add SSH Key* button.
. Select *Add SSH Key*.
. In the *Hostname* field, enter the key's associated host (for example, `git.heroku.com`). If you do not specify a hostname, the key will be used for all hosts.
. In the *Private Key* field, paste the SSH key you are adding.
. Click the *Add SSH Key* button.
. Select *Add SSH Key*.

[#add-ssh-keys-to-a-job]
== 2. Add SSH keys to a job
Expand Down Expand Up @@ -79,7 +79,8 @@ If you need to add multiple SSH keys with blank hostnames to your project, you w
[#see-also]
== See also

* xref:github-integration#[GitHub OAuth Integration]
* xref:github-apps-integration#[GitHub Apps Integration]
* xref:bitbucket-integration#[Bitbucket Integration]
* xref:gitlab-integration#[GitLab CI Integration]
* xref:github-integration#[GitHub OAuth app integration]
* xref:github-apps-integration#[GitHub App integration]
* xref:bitbucket-integration#[Bitbucket integration]
* xref:bitbucket-data-center-integration#[Bitbucket Data Center integration]
* xref:gitlab-integration#[GitLab integration]
10 changes: 5 additions & 5 deletions jekyll/_cci2/api-developers-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ curl --header "Circle-Token: $CIRCLE_TOKEN" \
== Getting started with the API

[#github-and-bitbucket-projects]
=== GitHub OAuth and Bitbucket projects
=== GitHub OAuth and Bitbucket Cloud projects

[NOTE]
====
Expand Down Expand Up @@ -120,10 +120,10 @@ The `project_slug` is also included in the response payload when looking up a pi

image::{{ site.baseurl }}/assets/img/docs/api-structure.png[API structure]

For GitHub and Bitbucket projects, `project_slug` is currently usable as a human-readable identifier for a given project. For <<gitlab-saas-support-projects,GitHub App and GitLab projects>>, the slug format has been changed.
For GitHub and Bitbucket Cloud projects, `project_slug` is currently usable as a human-readable identifier for a given project. For <<gitlab-saas-support-projects,GitHub App, GitLab and Bitbucket Data Center projects>>, the slug format has been changed.

[#gitlab-saas-support-projects]
=== GitHub App and GitLab projects
=== GitHub App, GitLab and Bitbucket Data Center projects

[NOTE]
====
Expand Down Expand Up @@ -191,8 +191,8 @@ Many of the API calls make use of the `+{project-slug}+` triplet, described <<ge
[#prerequisites]
=== Prerequisites

* A GitHub, Bitbucket, or GitLab account with a repository to set up with CircleCI. *GitHub App and GitLab users:* Note the <<gitlab-saas-support-projects,change in the definition>> for the project slug references in the examples and use cases on the rest of this document.
* Completion of the CircleCI link:{{ site.baseurl }}/getting-started[onboarding].
* A GitHub, Bitbucket, or GitLab account with a repository to set up with CircleCI. *GitHub App, GitLab and Bitbucket Data Center users:* Note the <<gitlab-saas-support-projects,change in the definition>> for the project slug references in the examples and use cases on the rest of this document.
* Completion of the CircleCI xref:getting-started#[onboarding].

[#steps]
=== Steps
Expand Down
8 changes: 4 additions & 4 deletions jekyll/_cci2/api-intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ NOTE: Currently, xref:managing-api-tokens#creating-a-personal-api-token[Personal

[NOTE]
====
*GitHub App and GitLab users:* Note that the definition of *project slug* provided in this section, as well as its usage throughout this document applies to GitHub and Bitbucket projects only. GitLab projects currently use a new slug format:
*GitHub App and GitLab users:* Note that the definition of *project slug* provided in this section, as well as its usage throughout this document applies to GitHub and Bitbucket Cloud projects only. GitLab, GitHub App and Bitbucket Data Center projects currently use a new slug format:

`circleci/:slug-remainder`

The project slug for GitLab projects can be found by navigating to your project in the CircleCI web app and taking the string from the browser address bar. The slug must be treated as an opaque string and passed in its entirety in API requests. Read the link:{{site.baseurl}}/api-developers-guide/#getting-started-with-the-api/[API Developer's Guide] for more details.
The project slug for GitLab, GitHub App and Bitbucket Data Center projects can be found by navigating to your project in the CircleCI web app and taking the string from the browser address bar. The slug must be treated as an opaque string and passed in its entirety in API requests. Read the link:{{site.baseurl}}/api-developers-guide/#getting-started-with-the-api/[API Developer's Guide] for more details.
====

CircleCI API v2 uses a string representation called the `project_slug`, which is a "triplet" of your version control system (VCS), the name of your organization, and the name of the repository. `project_slug` takes the following form:
Expand All @@ -51,12 +51,12 @@ CircleCI API v2 uses a string representation called the `project_slug`, which is
:vcs_type/:org_name/:repo_name
----

The `project_slug` is included in the response payload when pulling information about a project as well as when looking up a pipeline or workflow by ID. The `project_slug` can then be used to get information about the project. For GitHub OAuth app and Bitbucket projects, it is currently usable as a human-readable identifier for a given project.
The `project_slug` is included in the response payload when pulling information about a project as well as when looking up a pipeline or workflow by ID. The `project_slug` can then be used to get information about the project. For GitHub OAuth app and Bitbucket Cloud projects, it is currently usable as a human-readable identifier for a given project.

[#authentication]
== Authentication

The CircleCI API v2 enables users to be authenticated by sending your xref:managing-api-tokens#creating-a-personal-api-token[Personal API token] as a HTTP header in the request, with the name `Circle-Token` and the token as the value. You can find examples in the xref:api-developers-guide#[API Developer's Guide].
The CircleCI API v2 enables users to be authenticated by sending your xref:managing-api-tokens#creating-a-personal-api-token[Personal API token] as an HTTP header in the request, with the name `Circle-Token` and the token as the value. You can find examples in the xref:api-developers-guide#[API Developer's Guide].

[discrete#triggering-a-pipeline-with-parameters-example]
==== Triggering a pipeline with parameters example
Expand Down
Loading