Skip to content

Commit

Permalink
docs: Document tagged versions
Browse files Browse the repository at this point in the history
  • Loading branch information
TingPing committed Apr 12, 2024
1 parent e2a1b8f commit 4fa0636
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/03-Tagged-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Tagged versions

Over time the SDK will introduce major changes that will change behavior;
In order to easily use older versions we support tagged versions.

There are two parts to a SDK version the scripts and the image.

## Images

To use an older image with the latest scripts you can set `WKDEV_SDK_TAG`, e.g.:

```sh
export WKDEV_SDK_TAG='23.04'
wkdev-create --name='example-name'
```

As the scripts diverge from older images this *may* fail but for now should work fine.

## Scripts

To use older scripts you can simply checkout the branch for that tag: `git checkout tag/23.04`.

This will use the `23.04` image by default but you may override it with `WKDEV_SDK_TAG`.

## Creating a tag

The entire process of creating a tag is automated, simply create a branch named `tag/${tag_name}`
and CI will publish an image under that name.

0 comments on commit 4fa0636

Please sign in to comment.