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

Rename to Draupnir in Appropriate Places #591

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

FSG-Cat
Copy link
Member

@FSG-Cat FSG-Cat commented Oct 3, 2024

This PR aims to make it so its harder to find places where the bot calls it self Mjolnir without it affecting code in ways that i cant begin to predict.

src/appservice/cli.ts Show resolved Hide resolved
@@ -21,5 +21,5 @@ ENV NODE_ENV=production
ENV NODE_CONFIG_DIR=/data/config

CMD ["bot"]
ENTRYPOINT ["./mjolnir-entrypoint.sh"]
ENTRYPOINT ["./draupnir-entrypoint.sh"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to be conservative about changing this, just in case someone else has built their own image based on our own.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You do make a fair point about this. But i also do think that we should break this at some point as we should remove all references to mjolnir from the codebase that are not historical references.

As in if we refer to mjolnir it should be like for example refering to a Mjolnir issue or that this file integrates work from mjolnir.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But i also do think that we should break this at some point as we should remove all references to mjolnir from the codebase that are not historical references.

Why?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it gives a certain vibe to some people that we refer to our selfs as mjolnir all over the place. This PR should hopefully reduce the chances of end users seeing us call our selfs mjolnir in logs or via command errors.

@Gnuxie Gnuxie requested a review from MTRNord October 3, 2024 22:06
@Gnuxie
Copy link
Member

Gnuxie commented Oct 3, 2024

Willing to give this the all clear, @MTRNord, do you have any thoughts before we merge this?

Copy link
Collaborator

@MTRNord MTRNord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me

.gitignore Show resolved Hide resolved
@FSG-Cat FSG-Cat force-pushed the FSG-Cat/Draupnir-Rename branch from 5bb9b82 to 8516743 Compare October 4, 2024 12:51
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased] - 2024-10-04
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FSG-Cat you didn't write anything

CHANGELOG.md Outdated
Comment on lines 18 to 20
Entrypoint was renamed from `mjolnir-entrypoint.sh` to `draupnir-entrypoint.sh`

`mjolnir-registration.yaml` was renamed to `draupnir-registration.yaml` this change should not have any end user impact.
Copy link
Member

@Gnuxie Gnuxie Oct 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should have wrote this in the unreleased part and follow the convention that is laid out in https://keepachangelog.com/en/1.1.0/

CHANGELOG.md Outdated
Comment on lines 14 to 22
## [Unreleased] - 2024-10-04

### Versions v2.0.0-beta.7 and prior

Entrypoint was renamed from `mjolnir-entrypoint.sh` to `draupnir-entrypoint.sh`

`mjolnir-registration.yaml` was renamed to `draupnir-registration.yaml` this change should not have any end user impact.

Please see [Releases](https://github.com/the-draupnir-project/Draupnir/releases) for more information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## [Unreleased] - 2024-10-04
### Versions v2.0.0-beta.7 and prior
Entrypoint was renamed from `mjolnir-entrypoint.sh` to `draupnir-entrypoint.sh`
`mjolnir-registration.yaml` was renamed to `draupnir-registration.yaml` this change should not have any end user impact.
Please see [Releases](https://github.com/the-draupnir-project/Draupnir/releases) for more information.
## [Unreleased] - 2024-10-04
### Changed
* `Dockerfile`: entry-point was renamed from `mjolnir-entrypoint.sh` to `draupnir-entrypoint.sh`. If you have built a Dockerfile based on ours, you may need to make some changes.
* `Dockerfile`: source code was moved from `/mjolnir` to `/draupnir`. If you have built a custom docker image based on our Dockerfile based on ours, you may need to make some changes.
* The appservice registration file generator no longer emits `mjolnir-registration.yaml` as it has been renamed to `draupnir-registration.yaml`. This is only a concern if you have automated tooling that generates a registration file.
## Versions v2.0.0-beta.7 and prior
Please see https://github.com/the-draupnir-project/Draupnir/releases for more information.

@Gnuxie Gnuxie self-requested a review October 4, 2024 18:11
@FSG-Cat FSG-Cat merged commit 9cc6407 into the-draupnir-project:main Oct 4, 2024
6 checks passed
@FSG-Cat FSG-Cat deleted the FSG-Cat/Draupnir-Rename branch October 4, 2024 18:32
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.

3 participants