Updating Repositories

Bit components used or maintained in your repository might have newer versions available in their remote scopes. These component changes can be introduced by other collaborators who maintain these components outside of your repository.

For this reason, we recommend that updates to the main branch, including those originating from the components' remote scopes, should be made via the standard feature-branch workflow.

1. Create a new feature branch
2. Update components in the repository with the latest versions from the remote scopes
3. Commit and push the changes to the remote repository
4. Create a pull request and merge the changes to the main branch

See the Automated updates section for an automated workflow.

External dependencies are Bit components or packages that are not maintained in the repository, but are consumed by components in the repository.

Repositories without a Bit workspace can update their external dependencies, components and packages, using the standard package manager commands.

To update dependencies to their latest version within the permissible range, as listed in the workspace.jsonc or package.json files, run the following command:

$bit install --update

Copied

Note that component-to-component dependencies are always concrete. That means, that a component's dependency graph will include version ranges for packages, but will only include concrete versions for components.

When updating external dependencies based on a range, the range for component versions will only be read from the workspace dependency policy or the package.json file, but not in the component's dependency graph.

For example, the following workspace dependency policy permits updating the @my-org/design.icon dependency (component) to any version within the ^1.1.0 range (i.e, 1.1.0 up to 2.0.0 - excluding 2.0.2):

/* @filename: workspace.jsonc */

{
  "teambit.dependencies/dependency-resolver": {
    "policy": {
      "dependencies": {
        "@my-org/design.icon": "^1.1.0"
      }
    }
  }
}
Copied

Assuming the latest available version is 1.1.1, the output for the previous command should be:

This option is particularly useful when component dependencies are not listed in the workspace dependency policy or the package.json file. As mentioned earlier, a component's dependency graph will only include concrete versions for components. In this case, updates withing a range will not be possible.

Run the following command to update external dependencies in your repository:

$bit update

Copied

Use the --yes flag to skip the interactive prompt, and accept all available updates.

The interactive prompt displays the available updates for dependencies listed in your workspace.jsonc, but also for dependencies that are read from the component snaps.

For example, the following prompt lists two available updates, and the Bit components that will be affected by these updates:

A component is more than its source code. It also includes, among other things, its dependency graph. When Bit resolves a component's dependency version to a newer version, the component's dependency graph is modified (and so is the component).

Run the following to examine the changes introduced to components in your repository, as a result of a dependency update:

$bit diff

Copied

The output should list the affected components and the changes made to their dependency graph:

Workspace components are components maintained in your repository.

To learn how to checkout the latest version of a component (available in its remote scope) into your repository, see Update workspace components.

To update your components' envs to the latest version available run the following command:

$bit envs update

Copied

Changes to the component configuration (in this case, their env version) are registered in the .bitmap file, until the components are snapped (at which point the changes are stored in the component snap).

For example, the following .bitmap file lists the updated env version for the my-component component:

/* @filename: .bitmap */

{
    "my-component": {
        "scope": "my-org.my-scope",
        "version": "0.0.1",
        "mainFile": "index.ts",
        "rootDir": "my-scope/my-component",
        "config": {
            "teambit.react/react-env@0.1.13": {}
        }
    },
}
Copied

The following workflows automate the process of updating external dependencies, components and envs in your repository.

1. The CI job is triggered by a schedule or by a webhook
2. One or more of the following actions are performed (in the order listed below):
   1. Workspace components update
   2. External dependencies update
   3. Component envs update
3. A pull request is created with the changes

See a demo of this automated workflow using Github Actions, scheduled to run at every midnight.

Choose the implementation that best fits your needs:

name: Dependency Update
on:
  schedule:
    - cron: '0 0 * * *' # run every day at midnight
Copied

- name: Bit Dependency Update
uses: bit-tasks/dependency-update@v1
    branch: 'main' # the target branch to update
    allow: 'all' # permissible updates
Copied

This option is only available for repositories using the package.json file to manage their dependencies.

This option uses Dependabot to update components used (but not maintained) in your repository. For more information read the full documentation or check out this demo.

1. Create a file named dependabot.yml under your .github directory and add the following configuration:

version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "daily"
    groups:
      bit-scope-dependencies:
         patterns:
           - "@my-bit-org*" # your bit.cloud organization or account name
Copied

2. At the root of your project (next to package.json), create npm configuration file named .npmrc and add the following (replace your-bit-cloud-organization with your bit.cloud account or organization name):

registry=https://registry.npmjs.org/
@your-bit-cloud-organization:registry=https://node-registry.bit.cloud 
@bit:registry=https://node.bit.cloud
@teambit:registry=https://node-registry.bit.cloud
//node.bit.cloud/:_authToken=${BIT_CONFIG_USER_TOKEN}
Copied