https://github.com/webiny/webiny-upgrades

Contains upgrade scripts, executed via the `webiny upgrade` command.
https://github.com/webiny/webiny-upgrades

Last synced: 20 days ago
JSON representation

Contains upgrade scripts, executed via the `webiny upgrade` command.

• Host: GitHub
• URL: https://github.com/webiny/webiny-upgrades
• Owner: webiny
• Created: 2021-11-18T17:28:53.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-20T11:49:21.000Z (29 days ago)
• Last Synced: 2024-12-20T12:36:40.134Z (29 days ago)
• Language: TypeScript
• Size: 2.26 MB
• Stars: 0
• Watchers: 8
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# webiny-upgrades

Contains upgrade scripts, executed via the `webiny upgrade` command.

# Development Notes

## Creating New Upgrades

The first step is to create a new folder in the repository root. 

For example, if we're writing an upgrade script for the upcoming `5.50.0` version of Webiny, we need to create a folder named `5.50.0`. Once that's done, simply create an `index.js` file in it, and start writing your script For example:

```js

const { log } = require("../utils");

module.exports = async context => {

    log.info("Doing something...");

    

    // Do whatever you might need to do...

    

    // Format updated files.

    const files = [...];

    await prettierFormat(files, context);

    /**

     * Install new packages.

     */

    await yarnInstall({

        context

    });

};

```

## Fixing An Existing Upgrade Script

Noticed something is off with a live upgrade script?

When fixing an upgrade script, in order to avoid further affecting the existing live one, it's recommended we just copy/paste the existing script. So, for example, copy the code from the existing `5.50.0` into a new `5.50.0-hot-fix` folder. Then, when testing the upgrade script via the Webiny CLI, just tell the upgrade command to use the new code, via the `--use-version` flag. For example:

```

yarn webiny upgrade --use-version 5.50.0-hot-fix

```

Once you've concluded the fix is ready to go live, simply delete the initial `5.50.0` folder and remove the `-hot-fix` suffix from the `5.50.0-hot-fix` folder name.

## Local Testing

Let's say you have a Webiny project on which you'd like to test the new upgrade script.

You don't need to make a change and push it into the `webiny-upgrades` repository in order to test it. Via terminal, simply navigate to your Webiny project, and from there run the upgrade directly. For example:

```

node ../webiny-upgrades/index.js 5.50.0-hot-fix

```

> Note that the `webiny-upgrades` folder contains a clone of this repo.

Once you're done, it's still advised that you push the changes and do a complete end-to-end test with the Webiny CLI. For example, from the new Webiny project directory, run:

```

yarn webiny upgrade --use-version 5.50.0-hot-fix

```

> IMPORTANT: the version you pass to the Webiny CLI *must* match the upgrade folder name in this repo!

You can also run the upgrade command via the Webiny CLI from a locally cloned `webiny-js` repository:

```

node ../webiny-js/packages/cli/bin.js upgrade --use-version 5.50.0-hot-fix

```