Skip to content

Commit 2941948

Browse files
committed
Add docs about upgrading
1 parent ab5e775 commit 2941948

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

packages/docs/.vitepress/config.mts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ export default defineConfigWithTheme({
5959
{
6060
text: 'Files in <code>dist</code>',
6161
link: '/dist-files'
62+
}, {
63+
text: 'Upgrading',
64+
link: '/upgrading'
6265
}
6366
]
6467
}

packages/docs/src/upgrading.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Upgrading
2+
3+
As a new tool, there hasn't really been time to establish how `@skirtle/create-vue-lib` handles upgrades. But it's maybe still worth some brief notes on how it's intended to be used.
4+
5+
Much like [`create-vue`](https://github.com/vuejs/create-vue), there isn't any explicit support for upgrading projects. Both tools aim to create new projects, with any upgrades being managed manually. In most cases this just involves bumping dependencies regularly, so there's no need to involve the scaffolding tool.
6+
7+
With both tools it's assumed that project developers will alter their project configurations after they're created, so it isn't really practical for the tool to perform automated upgrades.
8+
9+
Sometimes there are significant changes required to upgrade to the latest version of a dependency, for example when a dependency needs changes to its configuration file. The complexity of such upgrades usually depends on how much you've changed the project configuration after it was created.
10+
11+
A common approach to upgrading is to create a completely new project and then use that as a reference point. It's usually possible to get everything working by copying across dependency versions and chunks of config files.
12+
13+
It can also work the other way, copying bits of the old project across to a new project to check what works and what doesn't.
14+
15+
With `@skirtle/create-vue-lib`, you could also consider the following approach:
16+
17+
1. Ensure all files from your project are checked into git.
18+
2. Run `@skirtle/create-vue-lib` in the same directory, so that it overwrites the existing configuration files.
19+
3. Use a diff tool, such as the one in your IDE, to compare the new files to those checked into git. You may need to revert a lot of the changes, but that's usually a relatively straightforward process.

0 commit comments

Comments
 (0)