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

Add paperless-ngx to latest #3922

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

BenAhrdt
Copy link
Contributor

Please add my adapter ioBroker.paperless-ngx to latest.

This pull request was created by https://www.iobroker.dev c0726ff.

@github-actions github-actions bot added auto-checked This PR was automatically checked for obvious criterias must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels Aug 10, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Aug 10, 2024

RE-CHECK!

@mcm1957
Copy link
Collaborator

mcm1957 commented Aug 10, 2024

Thanks for spending your time and providing a new adapter for ioBroker.

Your adapter will get a manual review as soon as possible. Please stand by - this might last one or two weeks. Feel free to continue your work and create new releases. You do NOT need to close or update this PR in case of new releases.

In the meantime please check any feedback issues logged by automatic adapter checker and try to fix them.

You will find the results of the review and eventually issues / suggestings as a comment to this PR. So please keep this PR watched.

If you have any urgent questions feel free to ask.

reminder 17.8.2024

@mcm1957 mcm1957 added (RE-)REVIEW pending (mcm1957) Changes requested by review have been applied, re-review could be done. and removed must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels Aug 10, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Sep 1, 2024

First of all - THANK YOU for the time and effort you spend to maintain this adapter.

I would like to give some feedback based on my personal oppinion. @Apollon77 might have additional suggestions or even a different oppinion to one or the other statement. Please feel free to contact him if you cannot follow my suggestions or want to discuss some special aspects.

  • Readme.md is very short

    The README.md of this adapter is very minimalistic. Please add a short description about the functionality of the adapter, add links the the manufacturer site (if applicable) and add a description of the configuration of the adapter. If you provide an external documentation - which should be located at doc/xx directory - please add links to at least the english documentation.

  • Please add unique adapter icon

    Please add a unique adapter icon and use it in README.md.

  • invalid characters should be filtered from object ids

    Some characters are not allowed to be used as part of an object id. If an object id is not hardcoded or even depending on user input you should ensure that such an object id does not contain an invalid character. Iobroker provides the constant adapter.FORBIDDEN_CHARS, i.e. by using the following snippet:

function name2id(pName) {
    return (pName || '').replace(adapter.FORBIDDEN_CHARS, '_');
}

I'm not sure where the ids of the directory structure are coming from. Please ensure, that no illegal characters are possible there (i.e. german Umlaute etc.)

  • Add timeout to axios calls

    All axios calls should have a timeout set. The default value for axios timeout is 0 which results in no timeout. So an unresponsive remote system could lead to an hanging adapter. Either set an appropiate timeout per axios call or set a default timeout globally for the axios instance.

  • adapt testing to supported node releases

    Tests for node 18 are mandatory.
    Tests for node 20 are mandatory as this is the recommended node version.
    Tests for node 22 are mandatory unless you already know incompatibilities which cannot be fixed immidiatly. In this case please create a issue stating the problem and fix as soon as possible.

    So the recommended testmatrix is [18.x, 20.x, 22.x] depending on engines requirments setting at package.json

    Tests must be performed at all supported platforms (linux, windows, mac) unless special hardware or software restrictions prohibit this.

Thanks for reading and evaluating this suggestions.
McM1957

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

@mcm1957 mcm1957 added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review and removed (RE-)REVIEW pending (mcm1957) Changes requested by review have been applied, re-review could be done. 17.8.2024 labels Sep 1, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Sep 1, 2024

reminder 15.9.2024

@mcm1957
Copy link
Collaborator

mcm1957 commented Sep 17, 2024

Do you need an help?
Or did you fix the issues noted and teh adapter is ready for a review?

reminder 28.9.2024

@mcm1957
Copy link
Collaborator

mcm1957 commented Oct 4, 2024

Do you need an help?
Or did you fix the issues noted and the adapter is ready for a review?
Please indicate

reminder 15.10.2024

@github-actions github-actions bot deleted a comment from mcm1957 Nov 1, 2024
Copy link

github-actions bot commented Nov 1, 2024

Automated adapter checker

ioBroker.paperless-ngx

Downloads Number of Installations (latest) - Test and Release
NPM

  • ❗ [E507] missing size attributes [xs,md,lg,xl] for number at admin/jsonConfig.json/items/mainTab/port
  • ❗ [E507] missing size attributes [xs,md,lg,xl] for text at admin/jsonConfig.json/items/mainTab/ipUrl
  • ❗ [E507] missing size attributes [xs,md,lg,xl] for text at admin/jsonConfig.json/items/mainTab/username
  • ❗ [E507] missing size attributes [xs,sm,md,lg,xl] for staticText at admin/jsonConfig.json/items/mainTab/_authenticationInformation
  • ❗ [E507] missing size attributes [xs,sm,md,lg,xl] for staticText at admin/jsonConfig.json/items/mainTab/_serverinformation
  • ❗ [E510] responsive check: maximum issues reached, please fix reported ones and recheck
  • 👀 [W401] Cannot find "paperless-ngx" in latest repository

Add comment "RE-CHECK!" to start check anew

@github-actions github-actions bot deleted a comment from mcm1957 Nov 1, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Nov 2, 2024

Review done at 2.11.2024

  • errors reported by adapter checker

    Please fix Issue reported by adapter checker.
    Information in respect to our responsive UI initiative can be found here: https://github.com/iobroker-community-adapters/responsive-design-initiative#
    If you need additional help for jsonCOnfig adjustments please contact @simatec

  • Readme.md is very short

    The README.md of this adapter is very minimalistic. Please add a short description about the functionality of the adapter, add links the the manufacturer site (if applicable) and add a description of the configuration of the adapter. If you provide an external documentation - which should be located at doc/xx directory - please add links to at least the english documentation.

  • invalid characters should be filtered from object ids

    Some characters are not allowed to be used as part of an object id. If an object id is not hardcoded or even depending on user input you should ensure that such an object id does not contain an invalid character. Iobroker provides the constant adapter.FORBIDDEN_CHARS, i.e. by using the following snippet:

function name2id(pName) {
    return (pName || '').replace(adapter.FORBIDDEN_CHARS, '_');
}

I'm not sure where the ids of the directory structure are coming from. Please ensure, that no illegal characters are possible there (i.e. german Umlaute etc.)

I still do not see any filtering of illegal characters. As elementName and startDirectory are no constants fixed within soure, the must be filter. The same applies to other external data used to create ids. Please advice whre this processing is done if it is already implemented.

  • Add timeout to axios calls

    All axios calls should have a timeout set. The default value for axios timeout is 0 which results in no timeout. So an unresponsive remote system could lead to an hanging adapter. Either set an appropiate timeout per axios call or set a default timeout globally for the axios instance.

    This looks like still missing too.

In general I do not see much improvments til Sommer. Please let me know if you do not have time / interest to fix the open issues within the next time. If you need any help, please let us know.

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

@mcm1957
Copy link
Collaborator

mcm1957 commented Nov 2, 2024

reminder 16.11.2024

@mcm1957
Copy link
Collaborator

mcm1957 commented Nov 24, 2024

@BenAhrdt

Did you have time to review / check the issues listed at 2.11.2024?
If you need any help, please let me / us know.
If you think the adapter is ready for a new (re-)review please drop a any comment.

@reminder 15.12.2024

@github-actions github-actions bot added 1.12.2024 remind after 1.12.2024 and removed 16.11.2024 labels Nov 24, 2024
@BenAhrdt
Copy link
Contributor Author

@mcm1957 at the Moment i have no time. Sorry

@github-actions github-actions bot added *📬 a new comment has been added 15.12.2024 remind after 15.12.2024 and removed 1.12.2024 remind after 1.12.2024 labels Nov 24, 2024
@mcm1957 mcm1957 added stale PR seems has no activity, will be closed after some time 1.12.2024 remind after 1.12.2024 and removed *📬 a new comment has been added 15.12.2024 remind after 15.12.2024 labels Nov 25, 2024
Copy link

ioBroker repository information about New at LATEST tagging

Thanks for spending your time and providing a new adapter for ioBroker.

Your adapter will get a manual review as soon as possible. Please stand by - this might last one or two weeks. Feel free to continue your work and create new releases. You do NOT need to close or update this PR in case of new releases.

In the meantime please check any feedback issues logged by automatic adapter checker and try to fix them. And please check the following information if not yet done:

You will find the results of the review and eventually issues / suggestions as a comment to this PR. So please keep this PR watched.

If you have any urgent questions feel free to ask.
mcm1957

@simatec Please take a look in respect to responsive design. Thanks

@github-actions github-actions bot added 15.12.2024 remind after 15.12.2024 and removed 1.12.2024 remind after 1.12.2024 labels Nov 25, 2024
@simatec
Copy link
Contributor

simatec commented Nov 25, 2024

The size specifications xs, md, lg and xl are missing in the jsonConfig

@github-actions github-actions bot added the *📬 a new comment has been added label Nov 25, 2024
@BenAhrdt
Copy link
Contributor Author

Ich habe die Spezifakationen und die Readme ergänzt und eine neue Version erzeugt: (1.0.4)
Sollte damit alles soweit in Ordnung sein?

@BenAhrdt
Copy link
Contributor Author

@ioBroker-Bot recreate

@mcm1957 mcm1957 added (RE-)REVIEW pending (mcm1957) Changes requested by review have been applied, re-review could be done. and removed stale PR seems has no activity, will be closed after some time labels Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
15.12.2024 remind after 15.12.2024 *📬 a new comment has been added auto-checked This PR was automatically checked for obvious criterias must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review New at LATEST (RE-)REVIEW pending (mcm1957) Changes requested by review have been applied, re-review could be done.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants