discourse/migrations/README.md

# Migrations Tooling

## Command line interface

```bash
./bin/cli help
```

## Converters

Public converters are stored in `lib/converters/`.
If you need to run a private converter, put its code into a subdirectory of `private/converters/`

## Development

### Installing gems

```bash
bundle config set --local with migrations
bundle install
```

### Updating gems

```bash
bundle update --group migrations
```

### Running tests

You need to execute `rspec` in the root of the project.

```bash
bin/rspec --default-path migrations/spec
```
DEV: Prepare new structure for migrations-tooling (#26631) * Moves existing files around. All essential scripts are in `migrations/bin`, and non-essential scripts like benchmarks are in `migrations/scripts` * Dependabot configuration for migrations-tooling (disabled for now) * Updates test configuration for migrations-tooling * Shorter configuration for intermediate DB for now. We will add the rest table by table. * Adds a couple of benchmark scripts * RSpec setup especially for migrations-tooling and the first tests * Adds sorting/formatting to the `generate_schema` script 2024-04-16 00:47:40 +08:00			`# Migrations Tooling`

DEV: Add converter framework for migrations-tooling (#28540) * Updates GitHub Actions * Switches from `bundler/inline` to an optional group in the `Gemfile` because the previous solution didn't work well with rspec * Adds the converter framework and tests * Allows loading private converters (see README) * Switches from multiple CLI tools to a single CLI * Makes DB connections reusable and adds a new abstraction for the `IntermediateDB` * `IntermediateDB` acts as an interface for IPC calls when a converter steps runs in parallel (forks). Only the main process writes to the DB. * Includes a simple example implementation of a converter for now. 2024-09-09 23:14:39 +08:00			`## Command line interface`

			```bash
			`./bin/cli help`
			```

			`## Converters`

			Public converters are stored in `lib/converters/`.
			If you need to run a private converter, put its code into a subdirectory of `private/converters/`

DEV: Prepare new structure for migrations-tooling (#26631) * Moves existing files around. All essential scripts are in `migrations/bin`, and non-essential scripts like benchmarks are in `migrations/scripts` * Dependabot configuration for migrations-tooling (disabled for now) * Updates test configuration for migrations-tooling * Shorter configuration for intermediate DB for now. We will add the rest table by table. * Adds a couple of benchmark scripts * RSpec setup especially for migrations-tooling and the first tests * Adds sorting/formatting to the `generate_schema` script 2024-04-16 00:47:40 +08:00			`## Development`

DEV: Add converter framework for migrations-tooling (#28540) * Updates GitHub Actions * Switches from `bundler/inline` to an optional group in the `Gemfile` because the previous solution didn't work well with rspec * Adds the converter framework and tests * Allows loading private converters (see README) * Switches from multiple CLI tools to a single CLI * Makes DB connections reusable and adds a new abstraction for the `IntermediateDB` * `IntermediateDB` acts as an interface for IPC calls when a converter steps runs in parallel (forks). Only the main process writes to the DB. * Includes a simple example implementation of a converter for now. 2024-09-09 23:14:39 +08:00			`### Installing gems`

			```bash
			`bundle config set --local with migrations`
			`bundle install`
			```

			`### Updating gems`

			```bash
			`bundle update --group migrations`
			```

DEV: Prepare new structure for migrations-tooling (#26631) * Moves existing files around. All essential scripts are in `migrations/bin`, and non-essential scripts like benchmarks are in `migrations/scripts` * Dependabot configuration for migrations-tooling (disabled for now) * Updates test configuration for migrations-tooling * Shorter configuration for intermediate DB for now. We will add the rest table by table. * Adds a couple of benchmark scripts * RSpec setup especially for migrations-tooling and the first tests * Adds sorting/formatting to the `generate_schema` script 2024-04-16 00:47:40 +08:00			`### Running tests`

			You need to execute `rspec` in the root of the project.

			```bash
			`bin/rspec --default-path migrations/spec`
			```