Skip to content

Commit 2f28bd0

Browse files
committed
add upgrade guide for 4.2.0
1 parent 6fcb420 commit 2f28bd0

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

docs/upgrade-guides/4-1-1-to-4-2-0.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,31 @@
22

33
This document describes the upgrade instructions from `4.1.1` to `4.2.0`.
44

5+
## Repository Renames
6+
This is our first release since renaming our core code repositories to [`plandev`](https://github.com/NASA-AMMOS/plandev),
7+
[`plandev-ui`](https://github.com/NASA-AMMOS/plandev-ui),
8+
[`plandev-gateway`](https://github.com/NASA-AMMOS/plandev-gateway) and
9+
[`plandev-docs`](https://github.com/NASA-AMMOS/plandev-docs).
10+
11+
This was communicated previously, and redirects from the old URLs are in place, so we do not expect any user impact from this change.
12+
However, it's a good idea to update any old references in your code or documents to their new names.
13+
14+
## DB Migrations
15+
Multiple DB migrations were added in this release. If you are upgrading from a past version and want to preserve your data, follow the instructions in the
16+
[Database Migrations Guide](../deployment/advanced-database-migrations.mdx) to apply migrations after upgrading. Make sure to either pass the `--all` flag, or apply **all** migrations interactively.
17+
18+
## SeqDev Action Versioning
19+
SeqDev 4.2.0 includes a new UI for managing and running actions, and a new **versioned Actions** feature. Instead of uploading
20+
a new action every time you make a change, you can now add a new version of an existing Action in the UI by opening it in your Workspace
21+
and clicking "Upload New Version" in the top left. You can also deprecate old versions of actions by clicking "Archive Version" on the
22+
action's "Configure" page - this will preserve records of previous runs from this version, but prevent users from running it in future.
23+
24+
## SeqDev Workspace File Metadata
25+
This SeqDev release adds support for saving additional metadata alongside your workspace files. SeqDev will automatically maintain some metadata,
26+
such as "created by" and "last edited by", while allowing users to store additional arbitrary JSON-shaped metadata in a `user` field, accessible
27+
via the UI or the [`aerie-actions` API v1.2.4](https://github.com/NASA-AMMOS/aerie-actions/releases). We also keep a "read-only" flag in metadata
28+
which, when set by the user, will prevent files from being accidentally overwritten or deleted.
29+
30+
Note that this metadata is stored in our Docker file system volume as hidden `.meta.seqdev` files alongside the regular Workspace files. If you do any
31+
manual manipulation of these files in the filesystem (ie. not using the UI or API), make sure to maintain their associated `.meta.seqdev` files or the
32+
file metadata may be lost.

0 commit comments

Comments
 (0)