@pubpub/migrate
v1.2.1
Published
CLI tool for migrating PubPub archives to various academic publishing platforms
Maintainers
Readme
PubPub Migrate CLI
What is this?
pubpub-migrate is a CLI tool that you can run locally which will help you migrate your PubPub Legacy community to different platforms.
Currently supported platforms are:
- OJS
Planned platforms are:
- Wordpress
- Ghost
How to use
For a more detailed guide, see the full migration guide
Install
Install from npm
npm install -g @pubpub/migrate
# yarn install -g @pubpub/migrate
# pnpm install -g @pubpub/migrate
# bun install -g @pubpub/migratethen run it with
pubpub-migrate⬇️ Export
First, you will need to download an archive of your PubPub community (may not be available for all communities yet).
For this, you need to be an admin of a legacy PubPub community.
Go to \<your community>/admin/settings, scroll down to the "Export" section, and click "Download Export".
Running
See specific platform documentation for more details.
Telemetry
You can disable telemetry by setting the DISABLE_TELEMETRY environment variable to true.
DISABLE_TELEMETRY=true pubpub-migrateDevelopment
Setup
To run tests, and have something to test the CLI against in general, you must first download the test data:
bun run download-test-dataThis will download the test data (latest community export for the Journal of Trial and Error) to ./test-data/static.
Releases
Releases are fully automated through GitHub Actions when code is pushed to the main branch. We uses semantic-release to auto-determine version bumps based on commit messages.
feat!: triggers major version bumpfeat: triggers minor version bumpfix: triggers patch version bump
All other commit types will not trigger a release, but will get their own heading in the changelog. See .czrc for more details.
