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

allow links between dataset types and metadata blocks #11001

Merged
merged 23 commits into from
Feb 5, 2025

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Nov 4, 2024

What this PR does / why we need it:

This pull request builds on the first pull request for dataset types, bringing us closer to the proposal in the parent issue.

For the APIs used by the new Dataverse UI ( https://github.com/IQSS/dataverse-frontend ):

  • The list of fields shown when creating a dataset will include fields marked as "displayoncreate" (in the tsv/database) for metadata blocks (e.g. "CodeMeta") that are linked to the dataset type (e.g. "software") that is passed to the API.
  • The metadata blocks shown when editing a dataset will include metadata blocks (e.g. "CodeMeta") that are linked to the dataset type (e.g. "software") that is passed to the API.

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Try the documented APIs.

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

No, but the idea is that some day the SPA might show the ability to choose between types when creating a dataset (as discussed in Slack and IQSS/dataverse-client-javascript#210), like these examples:

Screenshot 2024-09-12 at 11 57 48 AM
image

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

Yes, included.

Additional documentation:

Included. See these pages:

@coveralls
Copy link

coveralls commented Nov 5, 2024

Coverage Status

coverage: 22.732% (-0.02%) from 22.754%
when pulling ce03b30 on 10519-dataset-types
into 1e1bd6d on develop.

This comment has been minimized.

@GPortas GPortas self-assigned this Nov 5, 2024
@GPortas
Copy link
Contributor

GPortas commented Nov 5, 2024

I just moved this back to in progress to work on JPA criteria queries. @pdurbin

@pdurbin pdurbin self-assigned this Nov 5, 2024
@GPortas GPortas assigned pdurbin and unassigned pdurbin and GPortas Nov 5, 2024
@cmbz cmbz added the FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) label Nov 5, 2024

This comment has been minimized.

@pdurbin pdurbin removed their assignment Nov 5, 2024
@pdurbin pdurbin added Type: Feature a feature request Size: 3 A percentage of a sprint. 2.1 hours. GREI 6 Connect Digital Objects Requested SPA Improvement Desired improvement for SPA, do not duplicate JSF UI GREI Year 3 Year 3 GREI task FY25 Sprint 8 FY25 Sprint 8 (2024-10-09 - 2024-10-23) labels Nov 5, 2024

This comment has been minimized.

1 similar comment

This comment has been minimized.

@pdurbin pdurbin removed their assignment Jan 23, 2025

This comment has been minimized.

This comment has been minimized.

@pdurbin pdurbin self-assigned this Jan 24, 2025
In Docker, we were testing with the Codemeta block. This made for a nice
real-world story of creating a "software" dataset type and using it with
the Codemeta block.

The Codemeta block also has the advantage of having some fields that are
set to displayOnCreate, which helped us make assertions that the code is
working properly. It's the only non-citation block with fields set to
displayOnCreate.

However, Jenkins doesn't have the Codemeta block, meaning that tests are
failing. Also, we aren't ready to promote the Codemeta block to be
shipped with Dataverse because a new version is out:
#10859

So, we are switching from Codemeta to the Astrophysics block. We create
an "instrument" dataset type. Like all non-citation blocks (except for
Codemeta), there are no fields that are set to displayOnCreate=true.
Therefore, we added an API for this.
@pdurbin
Copy link
Member Author

pdurbin commented Jan 24, 2025

Tests were failing. Long story. I wrote it up in a commit message: 9b2fb8d

@stevenwinship or others, please take a look. Thanks.

@pdurbin pdurbin removed their assignment Jan 24, 2025

This comment has been minimized.

@stevenwinship stevenwinship removed their assignment Jan 24, 2025
@cmbz cmbz added the FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) label Jan 30, 2025
@ofahimIQSS
Copy link
Contributor

This PR has merge conflicts - please resolve

Conflicts:
src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java
@pdurbin
Copy link
Member Author

pdurbin commented Feb 3, 2025

@ofahimIQSS resolved!

This comment has been minimized.

@ofahimIQSS ofahimIQSS self-assigned this Feb 5, 2025
Co-authored-by: Omer Fahim <mfahim11427@gmail.com>

This comment has been minimized.

@ofahimIQSS
Copy link
Contributor

Tested in internal - followed the updates on guides (also proofread), no issues found. Merging PR
11001testing.txt

@ofahimIQSS ofahimIQSS merged commit 9ee8754 into develop Feb 5, 2025
10 of 11 checks passed
@ofahimIQSS ofahimIQSS deleted the 10519-dataset-types branch February 5, 2025 17:29
@ofahimIQSS ofahimIQSS removed their assignment Feb 5, 2025
Copy link

github-actions bot commented Feb 5, 2025

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10519-dataset-types
ghcr.io/gdcc/configbaker:10519-dataset-types

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 8 FY25 Sprint 8 (2024-10-09 - 2024-10-23) FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) FY25 Sprint 10 FY25 Sprint 10 (2024-11-06 - 2024-11-20) FY25 Sprint 11 FY25 Sprint 11 (2024-11-20 - 2024-12-04) FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) FY25 Sprint 14 FY25 Sprint 14 (2025-01-02 - 2025-01-15) FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) GREI Year 3 Year 3 GREI task GREI 6 Connect Digital Objects Requested SPA Improvement Desired improvement for SPA, do not duplicate JSF UI Size: 3 A percentage of a sprint. 2.1 hours. Type: Feature a feature request
Projects
Status: Done 🧹
Development

Successfully merging this pull request may close these issues.

Implement datasetType metadata block support (at global level)
6 participants