Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a migrate command #41

Closed
janechu opened this issue May 12, 2022 · 0 comments · Fixed by #137
Closed

Add a migrate command #41

janechu opened this issue May 12, 2022 · 0 comments · Fixed by #137
Assignees
@janechu
Labels
category:experience The experience for developers using the CLI feature A new feature
Milestone
1.0.0

Comments

@janechu
Copy link
Contributor

janechu commented May 12, 2022

Description

The following dependencies that the CLI relies on for templates may be updated at various points:

  • @microsoft/fast-foundation
  • @microsoft/fast-element
  • @microsoft/adaptive-ui (tbd)

There may be others but these are the primary dependencies for foundation components.

Due to this there is a need for the CLI to facilitate migration. The 2.x release of @microsoft/fast-element is coming up, along with planned changes for @microsoft/fast-foundation which will facilitate a major version bump.

Each major version bump has the capability to break the CLI and any users on the CLI. If a user is interested in updating to a new version of the CLI, this must be addressed.

Additionally, when the CLI is released, it should provide a migration path for users on the previous version of @microsoft/fast-element.

Requirements

  • List all dependencies that would facilitate a major version bump of the CLI
  • Determine a method of tracking these dependencies
  • Add a migrate command with arguments for which version should be targeted
    • The targeted version must be greater than the current version
@janechu janechu added category:experience The experience for developers using the CLI feature A new feature labels May 12, 2022
@janechu janechu added this to the CLI 1.0 milestone May 12, 2022
@janechu janechu self-assigned this May 12, 2022
@janechu janechu mentioned this issue May 12, 2022
Open
This was referenced Aug 5, 2022
Merged
Merged
Merged
Merged
Merged
Merged
@janechu janechu mentioned this issue Aug 15, 2022
Merged
3 tasks
@janechu janechu mentioned this issue Oct 7, 2022
Merged
3 tasks
janechu added a commit that referenced this issue Oct 7, 2022
@janechu
Add migration matrix for version control (#134)
da7df70 
# Pull Request

## 📖 Description

<!--- Provide some background and a description of your work. -->
This change adds a version control dictionary which will act as a migration matrix when the `migrate` command is used.

### 🎫 Issues

<!---
List and link relevant issues here using the keyword "closes"
if this PR will close an issue, eg. closes #411
-->
Related to #41 

## ✅ Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [x] I have added tests for my changes.
- [x] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.

## ⏭ Next Steps

<!---
If there is relevant follow-up work to this PR, please list any existing issues or provide brief descriptions of what you would like to do next.
-->
- Add the actual migrate command
- Update all projects and components to the new version using the migrate command
This was referenced Oct 14, 2022
Merged
Merged
Merged
janechu added a commit that referenced this issue Oct 14, 2022
@janechu
Added a copy of the initial project version to a test folder (#135)
2b18ae2 
# Pull Request

## 📖 Description

<!--- Provide some background and a description of your work. -->
This adds a static copy of the current project for the purposes of testing the `migrate` command.

### 🎫 Issues

<!---
List and link relevant issues here using the keyword "closes"
if this PR will close an issue, eg. closes #411
-->
Continues work on #41

## 👩‍💻 Reviewer Notes

<!---
Provide some notes for reviewers to help them provide targeted feedback and testing.
-->
This is just a static copy, it's purposefully not up-to-date with the latest from `@microsoft/fast-element` and `@microsoft/fast-foundation`, that step will occur after the migrate command is completed.

## ✅ Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
janechu added a commit that referenced this issue Oct 14, 2022
@janechu
Updated migration rules for 1.0.0-alpha.1 (#136)
28b123d 
# Pull Request

## 📖 Description

<!--- Provide some background and a description of your work. -->
After adding in E2E testing, some issues were found in the migrate ESLint ruleset for `1.0.0-alpha.1`, these are the corrections needed to accomplish a successful `migrate` to `1.0.0-alpha.2`.

### 🎫 Issues

<!---
List and link relevant issues here using the keyword "closes"
if this PR will close an issue, eg. closes #411
-->
Continues work on #41

## ✅ Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [x] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
janechu added a commit that referenced this issue Oct 14, 2022
@janechu
Added the migrate command (#137)
a8d39ed 
# Pull Request

## 📖 Description

<!--- Provide some background and a description of your work. -->
This work adds the `migrate` command, leveraging the ESLint ruleset and version matrix established in previous PRs.

### 🎫 Issues

<!---
List and link relevant issues here using the keyword "closes"
if this PR will close an issue, eg. closes #411
-->
Closes #41

## 👩‍💻 Reviewer Notes

<!---
Provide some notes for reviewers to help them provide targeted feedback and testing.
-->
This will fail until #135 and #136 are merged.

## ✅ Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [x] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@janechu janechu

Labels
category:experience The experience for developers using the CLI feature A new feature
Projects
FAST Tools Roadmap
Status: Done
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

Added the migrate command microsoft/fast-cli
1 participant
@janechu