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

Feat/425 publish dataset and collection #520

Merged
merged 29 commits into from
Oct 16, 2024

Conversation

ekraffmiller
Copy link
Contributor

@ekraffmiller ekraffmiller commented Oct 9, 2024

What this PR does / why we need it:

Implements the Publish Dataset feature where both the dataset and it's parent collection are not published. In this case, the Publish Dataset Modal allows the user to publish both the dataset and collection at the same time.

Note that this feature depends on a js-dataverse PR that is not yet merged: IQSS/dataverse-client-javascript#199. When it is merged, package.json can be updated to use the latest 'alpha' version.

Which issue(s) this PR closes:

Special notes for your reviewer:

I'm using feat/461-publish-collection as the base branch because it contains the integration code to call the Publish Collection js-dataverse use case.

Suggestions on how to test this:

Step 1: Run the Development Environment

  1. Execute npm i.
  2. Navigate with cd packages/design-system && npm run build.
  3. Return with cd ../../.
  4. Ensure you have a .env file similar to .env.example, with the variable VITE_DATAVERSE_BACKEND_URL=http://localhost:8000.
  5. Navigate with cd dev-env.
  6. Start the environment using ./run-env.sh unstable.
  7. To verify the environment, visit http://localhost:8000 and check your local Dataverse installation.

Step 2: Test the feature

  1. Create a collection. When it is created, it will have the 'Unreleased' status
  2. Within the new collection, create a dataset.
  3. On the Dataset page, Choose Publish Dataset, and Publish.
  4. On the Publish Dataset Modal, there will be a text asking if you want to publish the parent collection as well as the dataset. It will contain a link to then parent collection
  5. Choose 'Continue' to publish the dataset and collection
  6. When the publish is completed, check that the dataset and the collection are both published. The dataset should be Version 1.0, and the collection should no longer have the 'Unreleased' status

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

This is not a change from the JSF, but here is what the JSF modal looks like. 'Unpublished' is the name of the parent collection.
Screenshot 2024-10-06 at 12 09 15 PM

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

Additional documentation:

@ekraffmiller ekraffmiller marked this pull request as draft October 9, 2024 10:07
@coveralls
Copy link

coveralls commented Oct 9, 2024

Coverage Status

coverage: 97.378% (+0.2%) from 97.179%
when pulling 26bdf2f on feat/425-publish-dataset-and-collection
into ac7e2fc on develop.

@ekraffmiller ekraffmiller changed the base branch from develop to feat/461-publish-collection October 10, 2024 03:54
@ekraffmiller ekraffmiller marked this pull request as ready for review October 10, 2024 12:05
@ekraffmiller ekraffmiller added GREI Re-arch GREI re-architecture-related SPA.Q4 Not related to any specific Q4 feature FY25 Sprint 8 FY25 Sprint 8 (2024-10-09 - 2024-10-23) Original size: 3 labels Oct 10, 2024
@g-saracca
Copy link
Contributor

Hi @ekraffmiller could you update js-dataverse package version with 2.0.0-alpha.2, IQSS/dataverse-client-javascript#199 is already merged, thanks!

Base automatically changed from feat/461-publish-collection to develop October 10, 2024 20:05
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.

@ekraffmiller , looks awesome! just some minor comments and there is a conflict in package.json

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 great! thanks, approving!

@ofahimIQSS
Copy link
Contributor

tested in local - no issues found.
Testing of 520.docx

@ofahimIQSS ofahimIQSS merged commit 643a0b7 into develop Oct 16, 2024
14 checks passed
@ofahimIQSS ofahimIQSS deleted the feat/425-publish-dataset-and-collection branch October 16, 2024 15:40
@ofahimIQSS ofahimIQSS removed their assignment Oct 18, 2024
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) GREI Re-arch GREI re-architecture-related Original size: 3 SPA: Dataset page (View) SPA.Q4 Not related to any specific Q4 feature
Projects
Status: Done 🧹
Development

Successfully merging this pull request may close these issues.

Publish Dataset: Publish Dataset and Dataset Collection at the same time
4 participants