Clarifies instance number variable, fixes #373

dkastl commented 3 months ago

Proposed changes

This PR clarifies, that variable NODE_RED_INSTANCE_NUMBER= must be between 2 and 20 or left empty in order to apply the default value of 1.

This makes it be inline with the error message: https://github.com/lets-fiware/FIWARE-Big-Bang/blob/main/lets-fiware.sh#L372-L389

This fixes #373 .

Types of changes

What types of changes does your code introduce to the project: Put an x in the boxes that apply

[x] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Update docker image version of FIWARE GE.
[x] Update only documentation, not any source code.

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[x] I have read the CONTRIBUTING doc
[x] I have signed the CLA
[ ] I have updated the change log (CHANGELOG.md)
[x] I send this pull request to the v0.37.0-next branch.
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)
[ ] Any dependent changes have been merged and published in downstream modules

Further comments

This is probably the easiest "fix" to prevent users to specify 1 and get an error.

dkastl commented 3 months ago

Sorry, I don't understand the linting rule, which makes adding this extra comment line fail. This is just one line that tries to be similar to other comments.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (dc59187) to head (87a8472). Report is 34 commits behind head on v0.37.0-next.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## v0.37.0-next #374 +/- ## =============================================== Coverage 100.00% 100.00% =============================================== Files 2 1 -1 Lines 1927 1781 -146 =============================================== - Hits 1927 1781 -146 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

fisuda commented 3 months ago

The reason for the lint error is a mismatch between the config.sh file to the .config.sh file.

*** lint shellcheck ***
*** lint yamllint ***
*** config.sh ***
315d314
< # Must be between 2 and 20 when specified
Error: Process completed with exit code 1.

The config.sh file has been updated by PR #372 and #377, so update your working branch dkastl:fixes-nodered-instance-number-comment.

Update the minimum value of NODE_RED_INSTANCE_NUMBER to 1 in the config.sh file as shown:

# Must be between 1 and 20 when specified

With the fix by the PR #375, The NODE_RED_INSTANCE_NUMBER option can be set to a value between 1 and 20.

To fix a lint error, copy the config.sh file to the .config.sh file.
Add the title of this PR into the CHANGELOG.md file.
Run git push command again.

Thanks.

fisuda commented 3 months ago

Fixed by the PR #385.

lets-fiware / FIWARE-Big-Bang