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

version 0.3.7 #132

Merged
merged 23 commits into from
Jul 19, 2024
Merged

version 0.3.7 #132

merged 23 commits into from
Jul 19, 2024

Conversation

ThierryO
Copy link
Collaborator

No description provided.

@wlangera
Copy link
Contributor

I still have some issues:

1. multiple zenodo communities

I cannot set multiple zenodo communities in the organisation.yml and DESCRIPTION.

checklist::update_citation()
#> Error in initialize(...) : `community` must be a string

2. adding [email protected] as email in DESCRIPTION

I cannot set [email protected] as email for "Research Institute for Nature and Forest (INBO)" in DESCRIPTION.
Still same warnings as in #129.
Maybe a clash with organisation.yml?

3. copyright holder differs from funder

After checklist::check_package().
I can allow notes on this when I have a different copyrightholder and funder in DESCRIPTION.

#> `Research Institute for Nature and Forest (INBO)` must be listed as copyright holder and funder and use `NA_character_` as email.

But I get an error if I also adjust this in the organisation.yml.

Error in check_authors(read_organisation(x$get_path), this_desc = this_desc) : 
  TO DO: handle funder not equal to rightsholder

4. GitHub action has problem with CITATION.cff

This branch has no errors (only the shortcommings from 1-3 above).
But on GitHub I get this warning.

 /github/workspace/check/CITATION.cff is modified. Run `checklist::update_citation()` locally. Please commit changes.

Running checklist::update_citation() does not change anything.

@wlangera
Copy link
Contributor

I created a separate branch here with the problems mentioned above.

@wlangera
Copy link
Contributor

wlangera commented Jul 2, 2024

This time, I created a project with for a different organisation. Here are my issues:

1. Not possible to set 2 zenodo communities (?)
I have added an organisation.yml which enables me to use the b3 community instead of the inbo community.
Yet, I want both. How can I do this?

In my README.md <!-- community: b3; inbo --> does not work:

Errors found while parsing citation meta data

------------------------------------------------------------------------------------------------------------
missing required Zenodo community `b3`

2. Use MIT licence

I want the MIT licence: usethis::use_mit_license(copyright_holder = "Research Institute for Nature and Forest (INBO)").
Even when removing licence checking from checklist.yml, checklist still returns an error because I changed the licence.

CITATION: 1 error
------------------------------------------------------------------------------------------------------------
 LICENSE.md doesn't match with CC-BY-4.0 license

I created a separate branch here with the problems mentioned above.

@ThierryO
Copy link
Collaborator Author

ThierryO commented Jul 8, 2024

@hansvancalster Can you look at the MIT license error? You wrote that code. Please improve the error message.

@wlangera
Copy link
Contributor

wlangera commented Jul 8, 2024

@ThierryO I am not sure this is an error related to the MIT licence or also something bigger.
I get errors from checklist::check_project() regarding the license AND folder names even if I remove these from the checklist.yml.

@hansvancalster
Copy link
Contributor

@wlangera the repo you point to is not an R package. Checklist currently only allows GPL or MIT license for R packages, but forces CC-BY 4.0 for repos that are not R packages. Ignoring the license.md file seems to only have the effect that it is ignored during spell checking (if I look at your checklist.yml file)? The tutorial indeed suggests that checking the LICENSE.md file can be ignored entirely:

image

which suggests that it could be used as a way to "allow" any other license for repos that are not R packages (with the caveat that checklist will not check it).

@ThierryO the error " LICENSE.md doesn't match with CC-BY-4.0 license" is thrown by the internal function checklist:::citation_readme() which is code that you wrote. I only wrote code to allow MIT license in R packages, but this issue is reported from a repo that was probably created by checklist::create_project().

@ThierryO
Copy link
Collaborator Author

1. Not possible to set 2 zenodo communities (?) I have added an organisation.yml which enables me to use the b3 community instead of the inbo community. Yet, I want both. How can I do this?

In my README.md <!-- community: b3; inbo --> does not work:

Write it as

<!-- community: b3 -->
<!-- community: inbo -->
Errors found while parsing citation meta data

------------------------------------------------------------------------------------------------------------
missing required Zenodo community `b3`

2. Use MIT licence

I want the MIT licence: usethis::use_mit_license(copyright_holder = "Research Institute for Nature and Forest (INBO)"). Even when removing licence checking from checklist.yml, checklist still returns an error because I changed the licence.

CITATION: 1 error
------------------------------------------------------------------------------------------------------------
 LICENSE.md doesn't match with CC-BY-4.0 license

As @hansvancalster mentioned you need to use the CC-BY license for projects. Use the new checklist::set_license().

@wlangera
Copy link
Contributor

Thanks @ThierryO for all your work.
I can pass my checks now.

Copy link
Contributor

@wlangera wlangera left a comment

Choose a reason for hiding this comment

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

Thanks. This version works for me for both projects and packages for an external organisation (B-Cubed project).

@ThierryO ThierryO merged commit 5649985 into main Jul 19, 2024
8 checks passed
@ThierryO ThierryO deleted the codeowners branch July 19, 2024 15:03
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.

3 participants