Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add initial manual migration steps #498

Merged
merged 1 commit into from
Jun 19, 2024
Merged

doc: add initial manual migration steps #498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ If you have questions or feedback regarding Community Plugins, you can visit the
- [Release](#release)
- [Creating a new Workspace](#creating-a-new-workspace)
- [Creating new plugins or packages in a Workspace](#creating-new-plugins-or-packages-in-a-workspace)
- [Migrating a plugin](#migrating-a-plugin)
- [Manual migration steps](#manual-migration-steps)
- [Developer Certificate of Origin](#developer-certificate-of-origin)

## Code of Conduct
Expand Down Expand Up @@ -141,6 +143,55 @@ cd workspaces/adr
yarn new
```

## Migrating a plugin

Before proceeding with migrating a plugin, please review the following sections of the `README`:

- [What is the community plugins repository](https://github.com/backstage/community-plugins?tab=readme-ov-file#what-is-the-community-plugins-repository)
- [Community Plugins Workflow](https://github.com/backstage/community-plugins#community-plugins-workflow)

By migrating a plugin to this repository you will need to ensure you can meet certain requirements and adhere to some specific guidelines:

- Agree to publish the plugin to the `@backstage-community` npm scope.
- Adopt the Changesets workflow for releasing new plugin versions.
- Adhere to the repository security process for handling security-related issues.
- Plugins moved to the repository should be licensed under Apache 2.0.

### Manual migration steps

1. Prepare your environment by cloning both the repository you are migrating from and the `backstage/community-plugins` repository:

```sh
git clone https://github.com/source-repo/existing-plugins.git
git clone https://github.com/backstage/community-plugins.git
```

2. Identify the plugin(s) you wish to migrate. If you're migrating multiple plugins, is recommended to group the migration of these by workspace.

3. Within the `backstage/community-plugins` repository create a new branch for your changes:

```sh
git checkout -b migrate-workspace
```

3. Create a new workspace in the community plugins repository.

4. Copy the plugin files from the source repository to the `backstage/community-plugins` repository.

```sh
cp -r ../existing-plugins/plugins/plugin-name plugins/
```

5. Ensure all metadata files (`package.json`) are updated to reflect the new repository. This includes updating repository URLs, issues URLs, and other references.

6. Add maintainers to the `CODEOWNERS` file for the new workspace.

7. Create a new pull request from your branch.

8. Update external references to the old plugin location such as documentation to point to the new location in the `backstage/community-plugins` repository.

9. In the original repository, update the plugin to indicate that it has been moved to the `backstage/community-plugins` repository. You may wish to deprecate the old version on npm.

## Developer Certificate of Origin

Backstage Community Plugins has adopted a [Developers Certificate of Origin (DCO)](https://developercertificate.org/) - refer to the Backstage [CONTRIBUTING.md#developer-certificate-of-origin](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md#developer-certificate-of-origin) for more information on the DCO and guidance on signing commits.
Loading