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

Adding the USNISTGOV SCTK (word error rate scoring toolkit) as a conda package #24726

Merged
merged 21 commits into from
Jan 13, 2024

Conversation

egaznep
Copy link
Contributor

@egaznep egaznep commented Dec 8, 2023

Checklist

  • Title of this PR is meaningful: e.g. "Adding my_nifty_package", not "updated meta.yaml".
  • License file is packaged (see here for an example).
  • Source is from official source.
  • Package does not vendor other packages. (If a package uses the source of another package, they should be separate packages or the licenses of all packages need to be packaged).
  • If static libraries are linked in, the license of the static library is packaged.
  • Package does not ship static libraries. If static libraries are needed, follow CFEP-18.
  • Build number is 0.
  • A tarball (url) rather than a repo (e.g. git_url) is used in your recipe (see here for more details).
  • GitHub users listed in the maintainer section have posted a comment confirming they are willing to be listed there.
  • When in trouble, please check our knowledge base documentation before pinging a team.

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found some lint.

Here's what I've got...

For recipes/sctk:

  • The summary item is expected in the about section.
  • The recipe must have some tests.
  • The recipe must have a build/number section.

For recipes/sctk:

  • License is not an SPDX identifier (or a custom LicenseRef) nor an SPDX license expression.

Documentation on acceptable licenses can be found here.

Copy link

Hi! Thanks for your contribution to conda-forge.
When submitting a pull request, please do not change anything in the example recipe.
Please make sure that any changes are reverted before you submit it for review.
Thanks!

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found some lint.

Here's what I've got...

For recipes/sctk:

  • The summary item is expected in the about section.
  • The recipe must have some tests.
  • The recipe must have a build/number section.
  • Please do not delete the example recipe found in recipes/example/meta.yaml.

For recipes/sctk:

  • License is not an SPDX identifier (or a custom LicenseRef) nor an SPDX license expression.

Documentation on acceptable licenses can be found here.

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found some lint.

Here's what I've got...

For recipes/sctk:

  • The top level meta keys are in an unexpected order. Expecting ['package', 'source', 'build', 'requirements', 'about', 'extra'].
  • The summary item is expected in the about section.
  • The recipe must have some tests.

For recipes/sctk:

  • License is not an SPDX identifier (or a custom LicenseRef) nor an SPDX license expression.

Documentation on acceptable licenses can be found here.

- add build number: 0 as requested
- license
@egaznep
Copy link
Contributor Author

egaznep commented Dec 12, 2023

@conda-forge-admin, please ping team @conda-forge/help-c-cpp

I need help regarding the license file. Even though SPDX lists NIST-Software as a valid identifier, the linter complains about it.
(I plan to resolve rest of the issues myself)

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-webservice.

I was asked to ping @conda-forge/staged-recipes and so here I am doing that.

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I just wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found it was in an excellent condition.

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found some lint.

Here's what I've got...

For recipes/sctk:

  • Failed to even lint the recipe, probably because of a conda-smithy bug 😢. This likely indicates a problem in your meta.yaml, though. To get a traceback to help figure out what's going on, install conda-smithy and run conda smithy recipe-lint . from the recipe directory.

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found some lint.

Here's what I've got...

For recipes/sctk:

  • Selectors are suggested to take a <two spaces>#<one space>[<expression>] form. See lines [13, 21, 25]

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I just wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found it was in an excellent condition.

recipes/sctk/meta.yaml Outdated Show resolved Hide resolved
Co-authored-by: Filipe <ocefpaf@gmail.com>
sc_stats V1.3 - sclite's Statistical Significance Comparison tool
rover V0.1 - Recognition Output Voting Error Reduction
asclite V1.11 - Multidimensional alignment replacement for sclite
license: LicenseRef-NIST-Software
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
license: LicenseRef-NIST-Software
license: NIST-Software

This license is not yet added to our linting tool. Probably because the list of allowed licenses hasn't been updated in a year. Please open a PR like this one on the conda-smithy feedstock with the updated licenses. (Note that there is a tool provided to autogenerate the list).

Comment on lines 24 to 29
test:
source_files:
- makefile
- src/**
commands:
- make check -C $SRC_DIR # [not win]
Copy link
Member

Choose a reason for hiding this comment

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

If you want to run make check, please do it as part of the build script instead of including a copy of the entire source tree in the package.

My understanding is that this package is a collection of CLI tools, so the tests section should be calling "$ tool --help" or like "$ tool --version", to check that they return without error.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I understand. Unfortunately the developer did not add either option. What would be the recommendation in this case, simply checking for the existence of the files?

build:
- {{ compiler('c') }}
- {{ compiler('cxx') }}
- cmake
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- cmake

There appears to be no CMakeLists.txt in the upstream project, so CMake is probably not needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did this change myself, should've "accepted your suggestion" instead. I would be glad if you could re-check.

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipes/espeak-ng, recipes/pcaudiolib, recipes/sctk) and found some lint.

Here's what I've got...

For recipes/pcaudiolib:

  • The recipe must have some tests.

For recipes/pcaudiolib:

  • Jinja2 variable references are suggested to take a {{<one space><variable name><one space>}} form. See lines [9].

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-linting service.

I just wanted to let you know that I linted all conda-recipes in your PR (recipes/sctk) and found it was in an excellent condition.

I do have some suggestions for making it better though...

For recipes/sctk:

  • License is not an SPDX identifier (or a custom LicenseRef) nor an SPDX license expression.

Documentation on acceptable licenses can be found here.

@egaznep egaznep requested a review from carterbox January 9, 2024 09:41
@egaznep
Copy link
Contributor Author

egaznep commented Jan 9, 2024

@conda-forge-admin, please ping team @conda-forge/help-c-cpp, ready for review!

@conda-forge-webservices
Copy link

Hi! This is the friendly automated conda-forge-webservice.

I was asked to ping @conda-forge/staged-recipes and so here I am doing that.

Copy link

github-actions bot commented Jan 9, 2024

To help direct your pull request to the best reviewers, please mention a topic-specifc team if your recipe matches any of the following: conda-forge/help-c-cpp, conda-forge/help-cdts, conda-forge/help-go, conda-forge/help-java, conda-forge/help-julia, conda-forge/help-nodejs, conda-forge/help-perl, conda-forge/help-python, conda-forge/help-python-c, conda-forge/help-r, or conda-forge/help-ruby. Thanks!

@xhochy xhochy merged commit 634a34f into conda-forge:main Jan 13, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants