Skip to content

Commit 7b0ea55

Browse files
specify project naming limits & also remove uneeded warning (circleci#8934)
* Update create-project.adoc no longer need that prompt since this went out https://circleci.com/changelog/changes-to-github-repository-selection-in-project-creation-flow-of-circleci/ * update tip for project naming * Update jekyll/_cci2/concepts.adoc * Update jekyll/_cci2/create-project.adoc --------- Co-authored-by: Rosie Yohannan <[email protected]>
1 parent bfb550f commit 7b0ea55

File tree

2 files changed

+52
-2
lines changed

2 files changed

+52
-2
lines changed

jekyll/_cci2/concepts.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,18 @@ See the xref:pipelines#[Pipelines overview] page for more information.
461461

462462
For xref:github-integration#[GitHub OAuth app] and xref:bitbucket-integration#[Bitbucket Cloud] accounts, a _project_ in CircleCI is tied to, and shares the name of the associated code repository in your VCS.
463463

464-
For xref:github-apps-integration#[GitHub App], xref:gitlab-integration#[GitLab SaaS and self-managed] and xref:bitbucket-data-center-integration#[Bitbucket Data Center] users, a _project_ in CircleCI is standalone. You name your project and then connect your code (in your GitHub, GitLab or Bitbucket Data Center repository) to that project. A standalone project can have:
464+
For xref:github-apps-integration#[GitHub App], xref:gitlab-integration#[GitLab SaaS and self-managed] and xref:bitbucket-data-center-integration#[Bitbucket Data Center] users, a _project_ in CircleCI is standalone. You name your project and then connect your code (in your GitHub, GitLab or Bitbucket Data Center repository) to that project.
465+
466+
[TIP]
467+
====
468+
**Project names** must meet the following requirements:
469+
470+
* Begin with a letter
471+
* 3-40 characters long
472+
* Contain only letters, numbers, spaces, or the following characters `" - _ . : ! & + [ ] " ;`
473+
====
474+
475+
A standalone project can have:
465476

466477
* One or more configurations (pipeline definitions), including, but not limited to, a `.circleci/config.yml` file in the repository associated with the project.
467478
* One or more triggers (events from a source of change), including, but not limited to, a VCS. A trigger determines which configuration it should use to start a pipeline.

jekyll/_cci2/create-project.adoc

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,18 @@ image::create-project/what-project.png[Screenshot showing options to choose what
5151
+
5252
image::create-project/choose-a-repo.png[Choose a repository window with option to add another VCS]
5353
+
54-
NOTE: **First GitHub project?** If this is the first GitHub project you are creating, you will be redirected to GitHub and asked to install and authorise the CircleCI GitHub App. At this point you can choose to connect CircleCI to all your repositories, or select a subset of repositories to connect. **If your GitHub organization has more than 100 repositories**, select the **Only select repositories** option. There is a known issue where GitHub organizations with more than 100 repositories cannot view their repositories in CircleCI if they select the "All repositories" option when installing the CircleCI GitHub App.
54+
NOTE: **First GitHub project?** If this is the first GitHub project you are creating, you will be redirected to GitHub and asked to install and authorise the CircleCI GitHub App. At this point you can choose to connect CircleCI to all your repositories, or select a subset of repositories to connect.
5555

5656
. Follow the in-app prompts to give your project a name.
57+
+
58+
[TIP]
59+
====
60+
**Project names** must meet the following requirements:
61+
62+
* Begin with a letter
63+
* 3-40 characters long
64+
* Contain only letters, numbers, or the following characters `" - _ . : ! & + [ ] " ;`
65+
====
5766

5867
. If a CircleCI config file exists in your repository already you will be redirected to the pipelines page. Otherwise, CircleCI automatically generates a custom configuration file based on the programming languages and frameworks detected in your selected repository. If CircleCI is unable to generate a custom configuration file, a fallback template is used. Select btn:[Commit and Run].
5968
--
@@ -81,6 +90,16 @@ image::create-project/create-new-gitlab-project.png[Create new project window]
8190
+
8291
** If you see a blue btn:[Connect] button rather than your GitLab username, select btn:[Connect] to redirect to GitLab and authorise the connection.
8392
** The **Project Name** field (bottom of the window) is automatically populated with the name of your repository, but you can change this if required.
93+
+
94+
[TIP]
95+
====
96+
**Project names** must meet the following requirements:
97+
98+
* Begin with a letter
99+
* 3-40 characters long
100+
* Contain only letters, numbers, or the following characters `" - _ . : ! & + [ ] " ;`
101+
====
102+
84103
** Use the repository dropdown menu to tell CircleCI where your code is stored.
85104
** Choose an option for managing your `.circleci/config.yml` file:
86105
*** **Fastest:** Use a config file that already exists in your repository.
@@ -128,7 +147,18 @@ If this is your first GitLab self-managed project you will now set up your integ
128147
* Generate an add a personal access token
129148
* Add your known hosts, following the instructions in the app
130149
====
150+
131151
** The **Project Name** field (bottom of the window) is automatically populated with the name of your repository, but you can change this if required.
152+
+
153+
[TIP]
154+
====
155+
**Project names** must meet the following requirements:
156+
157+
* Begin with a letter
158+
* 3-40 characters long
159+
* Contain only letters, numbers, or the following characters `" - _ . : ! & + [ ] " ;`
160+
====
161+
132162
** Use the repository dropdown menu to tell CircleCI where your code is stored.
133163
** Select **Create Project**. You will then be redirected to the Pipelines page.
134164
** The express CircleCI configuration setup is not currently available for GitLab self-managed projects. You will need to add a `.circleci/config.yml` file in your repository if it has not yet been set up. If the repository you selected already contains a `.circleci/config.yml`, push a commit to see your pipeline on the dashboard.
@@ -164,6 +194,15 @@ image::create-project/what-project.png[Screenshot showing options to choose what
164194
image::create-project/choose-a-repo.png[Choose a repository window with option to add another VCS]
165195

166196
. On the next screen give your project a descriptive name.
197+
+
198+
[TIP]
199+
====
200+
**Project names** must meet the following requirements:
201+
202+
* Begin with a letter
203+
* 3-40 characters long
204+
* Contain only letters, numbers, or the following characters `" - _ . : ! & + [ ] " ;`
205+
====
167206

168207
. Next, follow the steps on the xref:bitbucket-data-center-integration#integrate-a-project-with-circleci[Bitbucket integration setup] page to set up the following:
169208
** An integration with your Bitbucket Data Center instance (if not already set up for your org).

0 commit comments

Comments
 (0)