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

include URL checker in pipeline #21

Closed
matteodelucchi opened this issue Mar 16, 2024 · 4 comments · Fixed by #24
Closed

include URL checker in pipeline #21

matteodelucchi opened this issue Mar 16, 2024 · 4 comments · Fixed by #24
Assignees
Labels
enhancement New feature or request

Comments

@matteodelucchi
Copy link

CRAN checks all URLs (and URIs) in a package. This makes sense, and we should include this too.
They seem to use urlchecker.
As this is not abn specific but required for all packages, I think it makes the most sense to have it implemented directly in the container. Also because we don't want the urlchecker package as a suggests in abn because it is unrelated to its functionality.

@matteodelucchi matteodelucchi added the enhancement New feature or request label Mar 16, 2024
@j-i-l
Copy link
Contributor

j-i-l commented Mar 16, 2024

CRAN checks all URLs (and URIs) in a package. This makes sense, and we should include this too. They seem to use urlchecker. As this is not abn specific but required for all packages, I think it makes the most sense to have it implemented directly in the container. Also because we don't want the urlchecker package as a suggests in abn because it is unrelated to its functionality.

Doing sanity checks on URL's/URI's is part of a testing procedure. As such, I would install the urlchecker in the container, but perform the actual sanity check in the tests of the abn package. In doing so we keep the clean separation between the container that provides a the testing environment and the tests that are tied to the development lifecycle of the package, after all URL's and URI's are part of the package content, just like code.

So my suggestion would be:

  1. install urlchecker in the container
  2. adapt the tests to perform an url check (and even do the automatic update in case of 301) in the abn package

Does this make sense to you, @matteodelucchi

@matteodelucchi
Copy link
Author

CRAN checks all URLs (and URIs) in a package. This makes sense, and we should include this too. They seem to use urlchecker. As this is not abn specific but required for all packages, I think it makes the most sense to have it implemented directly in the container. Also because we don't want the urlchecker package as a suggests in abn because it is unrelated to its functionality.

Doing sanity checks on URL's/URI's is part of a testing procedure. As such, I would install the urlchecker in the container, but perform the actual sanity check in the tests of the abn package. In doing so we keep the clean separation between the container that provides a the testing environment and the tests that are tied to the development lifecycle of the package, after all URL's and URI's are part of the package content, just like code.

So my suggestion would be:

  1. install urlchecker in the container
  2. adapt the tests to perform an url check (and even do the automatic update in case of 301) in the abn package

Does this make sense to you, @matteodelucchi

awesome, that's how we gonna do it!

@j-i-l
Copy link
Contributor

j-i-l commented Mar 16, 2024

One thing we might consider is to define a github action in this repository and then call the action in the tests of abn. In that way the sanity check of urls becomes portable to other repo's.

@matteodelucchi
Copy link
Author

Implement it as an additional job in the quick tests because it is fast and usually requires only a simple fix.

@j-i-l j-i-l linked a pull request Apr 9, 2024 that will close this issue
@j-i-l j-i-l closed this as completed in #24 Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants