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

Feature/1368 display changelog in workbench #1681

Merged

Conversation

emilyanndavis
Copy link
Member

@emilyanndavis emilyanndavis commented Nov 6, 2024

Description

Fixes #1368.

On first launch of a new version, the workbench will display a modal containing the relevant section of the changelog (i.e., only the items that are new in this version).

On the first launch (of any version) ever, the workbench will display the "download sample data" modal as usual. Then, only once the download modal has been closed, the changelog modal will open. Once the changelog modal has been closed, it will not open again.

Note this also supports multiple installed versions. That is, a user who is actively using multiple versions of the workbench will not see the changelog every time they close one version and open another.

Checklist

  • Updated HISTORY.rst and link to any relevant issue (if these changes are user-facing)
  • [ ] Updated the user's guide (if needed)
  • Tested the Workbench UI (if relevant)

Example

Note the changelog for 3.14.2 is rendered because 3.14.2 is the most recent version. Once a new version is released, the app will automatically render the relevant section of the changelog.

workbench-changelog_2024-11-07

@emilyanndavis emilyanndavis marked this pull request as ready for review November 8, 2024 01:01
Copy link
Contributor

@davemfish davemfish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @emilyanndavis , this works great! Looks like you got the puppeteer tests working. And there's probably something unrelated going on the the GHA Mac runners.

I have mostly minor comments; happy to discuss any of them.

workbench/src/renderer/components/Changelog/index.jsx Outdated Show resolved Hide resolved
workbench/src/renderer/components/Changelog/index.jsx Outdated Show resolved Hide resolved
workbench/src/renderer/styles/style.css Show resolved Hide resolved
workbench/tests/binary_tests/puppet.test.js Show resolved Hide resolved
workbench/tests/renderer/changelog.test.js Outdated Show resolved Hide resolved
workbench/tests/renderer/changelog.test.js Outdated Show resolved Hide resolved
workbench/tests/renderer/changelog.test.js Show resolved Hide resolved
workbench/src/renderer/components/Changelog/index.jsx Outdated Show resolved Hide resolved
};
document.querySelectorAll('.link-external').forEach(link => {
link.addEventListener('click', openLinkInBrowser);
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a great solution!

@davemfish davemfish merged commit 3fc95d2 into natcap:main Nov 13, 2024
29 checks passed
@emilyanndavis emilyanndavis deleted the feature/1368-display-changelog-in-workbench branch November 13, 2024 22:36
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.

Workbench: display invest changelog the first time a new install is launched
2 participants