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.

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

Add the what's new feature which shows updates for past releases #67

Merged
merged 4 commits into from
Nov 2, 2021

Conversation

janechu
Copy link
Contributor

@janechu janechu commented Oct 30, 2021

Pull Request

📖 Description

This change:

  • Updates the version badge in the upper left of the application to use the package version
  • Adds a "what's new" dialog using fast-dialog which will trigger if the users locally stored versions are out of date with the current version, this also formats the changelog versions into HTML for the dialog contents
  • Adds a generator script for writing files which updates the last 20 changes (minus package bumps) for the following packages:
    • @microsoft/fast-tooling
    • @microsoft/fast-tooling-react
    • @microsoft/fast-creator
  • These aforementioned generated files are then dynamically imported when the user is out of date with any of the versions.

The badge showing the version as there are no updates:
Screen Shot 2021-10-30 at 9 27 23 AM

The button showing because there are updates and the modal can now be opened:
Screen Shot 2021-10-30 at 9 26 58 AM

The dialog showing the updates:
Screen Shot 2021-10-30 at 9 27 04 AM

👩‍💻 Reviewer Notes

After the first load of the site, if you want to view the dialog again, you will need to clean your local storage of the 3 keys that have been added to store the last version number.

✅ Checklist

General

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.

@janechu janechu force-pushed the users/janechu/add-whats-new-feature branch from 5726eca to 0430f87 Compare October 30, 2021 16:54
@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-mushroom-0d77ce210-67.centralus.azurestaticapps.net

1 similar comment
@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-mushroom-0d77ce210-67.centralus.azurestaticapps.net

@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-mushroom-0d77ce210-67.centralus.azurestaticapps.net

janechu added a commit that referenced this pull request Nov 1, 2021
…idation and deploy (#68)

# Pull Request

## 📖 Description

<!--- Provide some background and a description of your work. -->
This causes the build step to build the release branch for the deployed artifact and not the PR branch that triggered the workflow.

See: https://github.com/actions/checkout#usage

## ✅ 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.
- [ ] 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.
-->
This should enable PRs such as #67 to show the feature work in the deployed site.
@github-actions
Copy link

github-actions bot commented Nov 1, 2021

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-mushroom-0d77ce210-67.centralus.azurestaticapps.net

@github-actions
Copy link

github-actions bot commented Nov 2, 2021

Azure Static Web Apps: Your stage site is ready! Visit it here: https://mango-sand-02c786f10-67.centralus.azurestaticapps.net

@awentzel awentzel merged commit b31ca74 into release Nov 2, 2021
@awentzel awentzel deleted the users/janechu/add-whats-new-feature branch November 2, 2021 15:33
janechu added a commit that referenced this pull request Nov 9, 2021
…idation and deploy (#68)

# Pull Request

## 📖 Description

<!--- Provide some background and a description of your work. -->
This causes the build step to build the release branch for the deployed artifact and not the PR branch that triggered the workflow.

See: https://github.com/actions/checkout#usage

## ✅ 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.
- [ ] 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.
-->
This should enable PRs such as #67 to show the feature work in the deployed site.
janechu added a commit that referenced this pull request Nov 9, 2021
* Add the what's new feature which shows updates for past releases

* eslint fix

Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants