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

chore(scripts): Migrate module name from script to scripts #334

Closed
wants to merge 3 commits into from

Conversation

fiftydinar
Copy link
Collaborator

@fiftydinar fiftydinar commented Sep 19, 2024

Placeholder script.sh is used, so custom images with old script module name will still work.
Added the caution card which informs users about this.

Some website parts should also be updated to reflect the new module name.
Maybe some CLI changes are needed as well.

blue-build/website#66
blue-build/cli#229

modules/scripts/scripts.sh Show resolved Hide resolved
modules/scripts/scripts.sh Show resolved Hide resolved
@xynydev
Copy link
Member

xynydev commented Sep 19, 2024

I'm not sure if this is worth it to be honest... It requires us to manually make sure that the files are in sync, which adds extra work. It could be possible to make a special script thingy somewhere in the build I guess, but then that would need to be explained and maintained. And the website needs a redirect. And then we have confusing information available from different social sources online (say, AnswerOverflow) that call the module something else than is on the website, and nobody can be really sure whether the script and scripts modules are actually the same.

All for one letter? IMO the name is just fine, works either way, and the semantics are more like the containerfile module than the files or fonts module anyways, since this module runs something at build time instead of adding something to the final image.

If I come around on the renaming, though, we should make that special script thingy. Manually keeping them in sync is brittle.

@gmpinder
Copy link
Member

How about updating the old script to just call and pass the params to the new script?

@xynydev
Copy link
Member

xynydev commented Sep 19, 2024

That wouldn't work with the solution I planned for module versioning, since the old script would be in a different container image.

My fix would be an alias system where one folder could be published under different names.

@fiftydinar
Copy link
Collaborator Author

Reading the @xynydev's response, I think this all is not worth it. I forgot about answer overflow point, that's correct.

I'll close this PR, along with child PRs.

But it would be maybe good to make a new issue about how to make a robust system for module name migrations (for example, if rpm-ostree switches to dnf in Fedora Atomic)

@fiftydinar fiftydinar closed this Sep 19, 2024
@fiftydinar fiftydinar deleted the script-to-scripts branch September 19, 2024 13:21
@xynydev
Copy link
Member

xynydev commented Sep 19, 2024

But it would be maybe good to make a new issue about how to make a robust system for module name migrations (for example, if rpm-ostree switches to dnf in Fedora Atomic)

That wouldn't be a name change IMO, but a new module entirely and the migration to that. But we can discuss that when it is timely.

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