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/492 publish dataset with compare versions #551

Open
wants to merge 14 commits into
base: develop
Choose a base branch
from

Conversation

ekraffmiller
Copy link
Contributor

@ekraffmiller ekraffmiller commented Nov 18, 2024

What this PR does / why we need it:

This PR adds a use case for comparing dataset versions, and uses it to add a property to the Dataset object, a boolean that indicates whether the next version should be a major or minor version update.
The boolean requiresMajorVersionUpdate will be true if the draft contains added, removed or replaced files. If this boolean is true, then the PublishDatasetModal will include help text describing the major version update.

Which issue(s) this PR closes:

Special notes for your reviewer:

The dataverse API hasn't been merged yet, so to run locally, use the PR image:
./run-env.sh 10888-add-api-for-comparing-dataset-versions

Suggestions on how to test this:

  1. Create and publish a dataset.
  2. Edit the metadata of the dataset, and click the Publish button. The PublishDatasetModal will show an option for choosing either minor or major version update.
  3. Publish the dataset, and then create another draft version, with an uploaded, removed or replaced file.
  4. Click the publish button again, and the PublishDatasetModal should display help text about the required major version update.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

Add a waiting tag because this Dataverse PR IQSS/dataverse#10945 needs to be merged for e2e tests to work

@coveralls
Copy link

coveralls commented Nov 18, 2024

Coverage Status

coverage: 97.353% (+0.008%) from 97.345%
when pulling e2e050c on feature/492-publish-dataset-with-compare-versions
into 88d218a on develop.

@ekraffmiller ekraffmiller marked this pull request as ready for review November 20, 2024 15:25
@ekraffmiller ekraffmiller linked an issue Nov 20, 2024 that may be closed by this pull request
@ekraffmiller ekraffmiller added FY25 Sprint 10 FY25 Sprint 10 (2024-11-06 - 2024-11-20) SPA: Dataset page (View) Size: 3 A percentage of a sprint. 2.1 hours. Original size: 3 SPA.Q4.10 Resolve TODOs and tech debt GREI Re-arch GREI re-architecture-related and removed Waiting labels Nov 20, 2024
@g-saracca g-saracca self-assigned this Nov 21, 2024
@cmbz cmbz added the FY25 Sprint 11 FY25 Sprint 11 (2024-11-20 - 2024-12-04) label Nov 21, 2024
Copy link
Contributor

@g-saracca g-saracca left a comment

Choose a reason for hiding this comment

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

Looks good, just some questions

@ekraffmiller
Copy link
Contributor Author

thanks @g-saracca, ready to review now

@ekraffmiller ekraffmiller removed their assignment Nov 22, 2024
Copy link
Contributor

@g-saracca g-saracca left a comment

Choose a reason for hiding this comment

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

Great job @ekraffmiller , approving!
Just one comment, you are mapping the js-dataverse versionDiff in toDatasetVersionDiff but not changing any property, maybe we don't need the mapper at all?

@g-saracca g-saracca removed their assignment Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 10 FY25 Sprint 10 (2024-11-06 - 2024-11-20) FY25 Sprint 11 FY25 Sprint 11 (2024-11-20 - 2024-12-04) GREI Re-arch GREI re-architecture-related Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA: Dataset page (View) SPA.Q4.10 Resolve TODOs and tech debt
Projects
Status: Ready for QA ⏩
4 participants