fix!: configuration improvements

[gentlementlegen]

Resolves #46

[gentlementlegen]

Breaking changes

The configuration has been changed to facilitate user's understanding of the values. The new possible values for the reward multipliers are as follow:

• PULL_AUTHOR
• ISSUE_AUTHOR
• PULL_SPECIFICATION
• ISSUE_SPECIFICATION
• ISSUE_CONTRIBUTOR
• ISSUE_COLLABORATOR
• PULL_CONTRIBUTOR
• PULL_COLLABORATOR
• PULL_ASSIGNEE
• ISSUE_ASSIGNEE

QA run with the new configuration

Meniole#6 (comment) (comments are not evaluated because I burst through the API limits of ChatGpt)

[rndquu]

@gentlementlegen Could you provide a full bot's config? Can't make it run with this one (some config validation errors).

[gentlementlegen]

@rndquu I think the main issue is that the yaml is invalid, it seems the items under with are too indented.

[rndquu]

@gentlementlegen Check this config and this CI run which outputs these errors:

Invalid incentives configuration detected, will revert to defaults.
{
  type: 46,
  schema: { type: 'object', properties: {}, [Symbol(TypeBox.Kind)]: 'Object' },
  path: '/incentives/contentEvaluator',
  value: null,
  message: 'Expected object'
}
{
  type: 46,
  schema: { type: 'object', properties: {}, [Symbol(TypeBox.Kind)]: 'Object' },
  path: '/incentives/dataPurge',
  value: null,
  message: 'Expected object'
}
{
  type: 46,
  schema: { type: 'object', properties: {}, [Symbol(TypeBox.Kind)]: 'Object' },
  path: '/incentives/permitGeneration',
  value: null,
  message: 'Expected object'
}

The config is from the readme file. Are those errors expected?

[gentlementlegen]

@rndquu No these errors are not expected. I provided a fix, that hopefully works because my GitHub Actions have been stuck for the past hour, so I cannot test in a real-world use case.

[rndquu]

@rndquu No these errors are not expected. I provided a fix, that hopefully works because my GitHub Actions have been stuck for the past hour, so I cannot test in a real-world use case.

The Invalid incentives configuration detected, will revert to defaults. error is gone. Check this CI run which outputs:

Invalid configuration detected for DataPurgeModule, disabling.
Invalid configuration detected for ContentEvaluatorModule, disabling.
Invalid configuration detected for PermitGenerationModule, disabling.

Is it expected for this config?

[gentlementlegen]

@rndquu Yes it is expected because these modules seem to be missing from the configuration, so they are disabled, which is in check with this comment. Maybe the message is misleading.

Edit: they seem to be present in the configuration so it is not expected. I think because they are empty they get de-serialized as undefined values when they should be treated as empty objects, will investigate.

[rndquu]

@rndquu Yes it is expected because these modules seem to be missing from the configuration, so they are disabled, which is in check with this comment. Maybe the message is misleading.

Edit: they seem to be present in the configuration so it is not expected. I think because they are empty they get de-serialized as undefined values when they should be treated as empty objects, will investigate.

I'm concerned about the above errors because they are caused by the default config provided in the readme file. It is somewhat expected that if you copy a config from the readme file then the plugin should run without any errors.

[rndquu]

Works fine

The errors mentioned here are actually present in the development branch so they are not caused by this PR. @gentlementlegen perhaps it makes sense to fix those errors in a separate PR.

[gentlementlegen]

@rndquu Thank you, opened a ticket for this here.