docs: remove migrating section

This commit is contained in:
Andrea Lamparelli 2024-03-29 09:36:57 +01:00
parent 80a0b554f0
commit ef5add0c1b

View file

@ -24,7 +24,6 @@ Table of content
* **[CLI tool](#cli-tool)** * **[CLI tool](#cli-tool)**
* **[GitHub action](#github-action)** * **[GitHub action](#github-action)**
* **[Future works](#future-works)** * **[Future works](#future-works)**
* **[Migrating to v4](#migrating-to-v4)**
* **[Development](#development)** * **[Development](#development)**
* **[Contributing](#contributing)** * **[Contributing](#contributing)**
* **[License](#license)** * **[License](#license)**
@ -39,7 +38,7 @@ Therefore this tools is for anybody who is working on projects where they have t
## CLI tool ## CLI tool
> All instructions provided below pertain to version `v4` of the tool. If you wish to use an earlier version, we strongly encourage you to consider migrating to version `v4` as there are no valid reason to keep using older versions. Please refer to [Migrating to v4](#migrating-to-v4) section for comprehensive details on how to properly migrate to version `v4`. > All instructions provided below pertain to version `v4` of the tool. If you wish to use an earlier version, please refer to the documentation from the corresponding tag/release.
This tool is released on the [public npm registry](https://www.npmjs.com/), therefore it can be easily installed using `npm`: This tool is released on the [public npm registry](https://www.npmjs.com/), therefore it can be easily installed using `npm`:
@ -244,23 +243,6 @@ For a complete description of all inputs see [Inputs section](#inputs).
- Integrate it into other CI/CD services like gitlab CI. - Integrate it into other CI/CD services like gitlab CI.
- Provide some reusable *GitHub* workflows. - Provide some reusable *GitHub* workflows.
## Migrating to v4
From version `v4` the project has been moved under [@kiegroup](https://github.com/kiegroup) organization. During this migration we changed some things that you should be aware of. I'll try to summarize them in the following table:
> **NOTE**: these changes did not affect the tool features.
| | **v4 (after migration)** | v3 or older (before migration) |
|-------------|--------------------------|--------------------------------|
| Owner | kiegroup | lampajr |
| Repository | git-backporting | backporting |
| NPM package | @kie/git-backporting | @lampajr/bper |
| CLI tool | git-backporting | bper |
So everytime you would use older version keep in mind that these changes are madnatory to make the tool working.
> **NOTE**: Versions `v3.1.1` and `v4.0.0` offer identical features; the only distinction lies in the project's renaming and organization movement.
## Development ## Development
### Package release ### Package release