Working with projects in SourceCraft

A project consists of several repositories with one organization. You can use projects to logically separate repositories, e.g., by product or command, and to assign roles for all the project's repositories at once and manage access to them based on general rules.

For more information, see Projects.

Creating a project

Note

To create a project, you need the Project maintainer role or higher at the organization level.

  1. Open the SourceCraft home page.

  2. On the Home tab, navigate to Organizations and select an organization.

  3. In the Your craftspace section, navigate to Projects.

  4. In the top-right corner, click New project.

  5. In the window that opens:

    1. Enter a name for the project.

    2. Set an ID or leave the one generated automatically. The ID shows the path the project will be available at:

      https://sourcecraft.dev/<organization_slug>/projects/<project_ID>/repos
      

      The ID may contain lowercase Latin letters, digits, and hyphens.

    3. Optionally, add a description for the project.

    4. Set the project visibility:

      • Public: The visibility of public, internal, and private repositories added to the project does not change.
      • Internal: Public repositories added to the project become internal. The visibility of internal and private repositories added to the project does not change.
      • Private: Public and internal repositories added to the project become private. The visibility of private repositories added to the project does not change.

      Note

      When a repository is moved to another project, its visibility changes according to the project settings.

      When a repository is removed from a project, its visibility changes according to the settings of the repository itself.

  6. Click Create project.

Updating a project

Note

To update a project, as well as add and remove repositories in it, you need the Project maintainer role or higher at the project or organization level.

Adding a repository to a project

  1. Open the SourceCraft home page.

  2. On the Home tab, navigate to Organizations and select an organization.

  3. In the Your craftspace section, navigate to Projects.

  4. Click to the right of the project to which you want to add a repository.

  5. Select a repository.

    Warning

    A repository can only belong to one project.

    When moving it to another project, users may lose access to the repository. This will happen if they do not have the required roles at the organization, team, or repository level.

Removing a repository from a project

  1. Open the SourceCraft home page.
  2. On the Home tab, navigate to Organizations and select an organization.
  3. In the Your craftspace section, navigate to Projects and select your project.
  4. Under Repositories, click next to the project and select Remove from project.
  5. Confirm the deletion.

The repository will only be removed from the project but will remain in the organization.

Warning

When removing it from the project, users may lose access to the repository. This will happen if they do not have the required roles at the organization, team, or repository level.

Updating settings

  1. Open the SourceCraft home page.

  2. On the Home tab, navigate to Organizations and select an organization.

  3. In the Your craftspace section, navigate to Projects.

  4. To the right of your project, click .

  5. Under Settings:

    1. Enter a name for the project.

    2. Set an ID or leave the one generated automatically. The ID shows the path the project will be available at:

      https://sourcecraft.dev/<organization_slug>/projects/<project_ID>/repos
      

      The ID may contain lowercase Latin letters, digits, and hyphens.

    3. Optionally, add a description for the project.

    4. Set the project visibility:

      • Public: The visibility of public, internal, and private repositories added to the project does not change.
      • Internal: Public repositories added to the project become internal. The visibility of internal and private repositories added to the project does not change.
      • Private: Public and internal repositories added to the project become private. The visibility of private repositories added to the project does not change.

      Note

      When a repository is moved to another project, its visibility changes according to the project settings.

      When a repository is removed from a project, its visibility changes according to the settings of the repository itself.

  6. Click Update settings.

Deleting a project

Note

To delete a project, you need the Project admin role or higher at the project or organization level.

  1. Open the SourceCraft home page.
  2. On the Home tab, navigate to Organizations and select an organization.
  3. In the Your craftspace section, navigate to Projects.
  4. To the right of your project, click .
  5. In Settings, under Danger zone, click Delete Project.
  6. Enter the ID and confirm deletion.

Alert

Deleting a project is irreversible. Repositories that were part of the project will remain in the organization but will be detached from the project. Users may lose access to the repositories. This will happen if they do not have the required roles at the organization, team, or repository level.

Useful links