Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

fastify/deprecate-modules

Repository files navigation

Working With This Repo

The puprose of this repository is to facilitate publishing deprecation packages as Fastiy moves from fastify-* packages to @fastify/* packages.

Each package defined in lib/modules.json will generate a deprecation package in the out/ directory. This is accomplished by running npm run build. Subsequently, npm run publish:live will issue a publish of those modules to the live npmjs.org registry.

Dry Run

  1. Copy sample.env to .env and adjust with real values
  2. node build-data.mjs to generate source data
  3. node index.mjs to generate deprecated module sources and repo changes
  4. docker-compose up to start Verdaccio server
  5. npm run publish:local to publish modules to Verdaccio server

Publishing Live Modules

  1. Copy sample.env to .env and adjust with real values.
  2. node build-data.mjs to generate ./lib/modules.json.
  3. DRY_RUN=0 node index.mjs | tee build.log.json to generate deprecated modules sources and create PRs to rename modules with new major versions. This step will generate log data that looks like:
    {
      "fastify-bearer-auth": {
        "deprecationModule": {
          "published": true,
          "versionPublished": "6.3.0-rc.1"
        },
        "replacementModule": {
          "prCreated": true,
          "prUrl": "https://github.com/fastify/fastify-bearer-auth/pull/127"
        }
      }
    }
  4. DRY_RUN=0 ./publish-live.sh to publish the deprecated modules.

About

No description, website, or topics provided.

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published