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

Added DataFileCategoryService to manage data file categories configuration #8478

Merged
merged 3 commits into from
Mar 22, 2022

Conversation

abujeda
Copy link
Contributor

@abujeda abujeda commented Mar 10, 2022

What this PR does / why we need it:
This is my first PR, so not sure there are other changes needed.

From the Harvard Data Commons project, we have a requirement to add a new file tag "Workflow" to the default list of Dataset file tags.

We thought that making this list configurable will provide value as well as meeting our requirements.

Which issue(s) this PR closes:

Closes #8461

Special notes for your reviewer:
N/A

Suggestions on how to test this:
To add a new list of default file tags, eg:
curl -X PUT -d 'Docs,Data,Code,Workflow' http://localhost:8080/api/admin/settings/:FileCategories

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

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

Additional documentation:
N/A

Copy link
Contributor

@landreev landreev left a comment

Choose a reason for hiding this comment

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

Thank you for the PR, @adaybujeda! This looks good. The Mock tests of the service methods are definitely appreciated.
One quick request, could you please document the new setting in doc/sphinx-guides/source/installation/config.rst, under this section:

.. _database-settings:

Database Settings
-----------------

(this becomes https://guides.dataverse.org/en/latest/installation/config.html#id156, in the formatted version of the guide). Please use the descriptions of other settings there as a model. At a minimum, all it needs is the name of the setting (:FileCategories), a brief explanation of what it does (overrides the default file categories...) and a command line example (the example you provided under "How to test this" would work perfectly).

Thank you again, for your first Dataverse PR! 🥇 😄

@abujeda abujeda force-pushed the 8461-datafilecategory-configuration branch from b4d8be8 to cb27476 Compare March 17, 2022 10:38
@abujeda
Copy link
Contributor Author

abujeda commented Mar 17, 2022

Thanks for the comments @landreev.

I have updated the Database settings docs.

@landreev
Copy link
Contributor

OK, thank you. Please note that I added a simple "release note" directly to the branch: doc/release-notes/8461-filecategories-config.md. This is our standard way of keeping track of new features/important fixes/etc., to be included in the combined notes for the next release.
Please edit it as you see fit, if you want to add any extra information etc.

@landreev
Copy link
Contributor

One last thing, could you please rename DataFileCategoryService.java as DataFileCategoryServiceBean.java, for consistency with how we've been naming our service beans - thank you!

@abujeda
Copy link
Contributor Author

abujeda commented Mar 18, 2022

Thanks @landreev!

I have renamed the service bean.
Release notes LGTM.

Copy link
Contributor

@landreev landreev left a comment

Choose a reason for hiding this comment

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

OK, perfect, thank you.
I'm moving it along into QA, hopefully will be merged shortly.

@landreev landreev removed their assignment Mar 18, 2022
@abujeda
Copy link
Contributor Author

abujeda commented Mar 18, 2022

Thanks @landreev 🚀

@landreev
Copy link
Contributor

OK, this is the real last thing for sure: could you please sync the branch up with develop? - The QA are asking all the developers with unmerged PRs to do this manually; with the new release out and the project version having been changed in the main pom file.

@kcondon kcondon self-assigned this Mar 21, 2022
@abujeda abujeda force-pushed the 8461-datafilecategory-configuration branch from 5cac8bc to 3b8d5e8 Compare March 21, 2022 18:49
@abujeda
Copy link
Contributor Author

abujeda commented Mar 21, 2022

Sure @landreev.
I have rebased from develop. PR updated.

@kcondon kcondon merged commit 7abaa67 into IQSS:develop Mar 22, 2022
@coveralls
Copy link

Coverage Status

Coverage increased (+0.03%) to 18.895% when pulling 3b8d5e8 on adaybujeda:8461-datafilecategory-configuration into 27a733f on IQSS:develop.

@pdurbin pdurbin added this to the 5.11 milestone Mar 29, 2022
@scolapasta scolapasta added HDC: 2 Harvard Data Commons Obj. 2 HDC Harvard Data Commons labels Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
HDC Harvard Data Commons HDC: 2 Harvard Data Commons Obj. 2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request/Idea: Customize the list of default file categories
6 participants