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

Update selfbuld docs to explicitly provide config and not rely on implicit behavior from previous version. #429

Merged
merged 1 commit into from
Nov 22, 2022

Conversation

Gnuxie
Copy link
Contributor

@Gnuxie Gnuxie commented Nov 21, 2022

The package we used to load config in the past, node-config, would default to development.
https://github.com/node-config/node-config/blob/f54b41990095c2b340ae129dfd8f623da1dfa20d/lib/config.js#L561 #347

@Gnuxie Gnuxie requested a review from Yoric November 21, 2022 12:23
@Gnuxie Gnuxie changed the title Update selfbuld docs to no longer require on old behaviour. Update selfbuld docs to explicitly provide config and not rely on implicit behavior from previous version. Nov 21, 2022
@Gnuxie Gnuxie merged commit 85cb0f0 into main Nov 22, 2022
Gnuxie added a commit that referenced this pull request Nov 22, 2022
This is what was used prior to #347.
It was a nice idea motivated to drop a dependency that was confusing.
It was just never followed through and was underestimated how much disruption it would cause.
It was also believed that the library would mean there could only ever be one global copy of the config,
It was followed up by:
#369
#357
#429
https://github.com/matrix-org/mjolnir/pull/397/files
#365

For simplicity sake I am reinstating the library.
The practice of loading default.yaml by default is also dangerous
and has led to issues multiple times in #mjolnir:matrix.org.
It is a sample and not a default.

In a following commit I will be adding the ability to specify the
config to use from the cli.
@Gnuxie Gnuxie mentioned this pull request Nov 22, 2022
Gnuxie added a commit that referenced this pull request Nov 23, 2022
* Use the npm package `config` to load the config.

This is what was used prior to #347.
It was a nice idea motivated to drop a dependency that was confusing.
It was just never followed through and was underestimated how much disruption it would cause.
It was also believed that the library would mean there could only ever be one global copy of the config,
It was followed up by:
#369
#357
#429
https://github.com/matrix-org/mjolnir/pull/397/files
#365

For simplicity sake I am reinstating the library.
The practice of loading default.yaml by default is also dangerous
and has led to issues multiple times in #mjolnir:matrix.org.
It is a sample and not a default.

In a following commit I will be adding the ability to specify the
config to use from the cli.

* Allow config to be specified with an explicit cli argument.

* Update doc to transition away from old config handling
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants