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

Add instructions to create a new module #853

Merged
merged 1 commit into from
Oct 9, 2023

Conversation

ekohl
Copy link
Member

@ekohl ekohl commented Oct 6, 2023

No description provided.

README.md Outdated

It is possible to create a new module using msync.
First add it to `managed_modules.yml`.
If it's not in the voxpupuli namespace, be use to include yours.
Copy link
Member

Choose a reason for hiding this comment

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

be use? Is that a correct phrase?

Copy link

Choose a reason for hiding this comment

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

As someone who's never used modulesync_config before, the line, "First add it to 'managed_modules.yml'" isn't clear. The yml file has pre-loaded modules such as 'puppet-conntrackd'. If I'm trying to create a new module (from scratch?) then is it necessary to remove all of the pre-loaded entries in manage_modules.yml? Since my module is not in the Puppet forge, what is the correct format to enter? Is it the path to 'git clone' the module?

Copy link
Member

Choose a reason for hiding this comment

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

I think it's supposed to be

Suggested change
If it's not in the voxpupuli namespace, be use to include yours.
If it's not in the voxpupuli namespace, be sure to include yours.

But it could be clearer, like @bschonec said.

What I did was create a branch in my fork that changes the namespace setting, but not sure how maintainable that is: master...kenyon:modulesync_config:kenyon

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 can add kenyon/puppet-powerwall_dashboard instead, removing the need to override the namespace in the config.

While writing this I also considered changing modulesync to remove the global setting and simply use full qualified names everywhere.

Copy link
Member Author

Choose a reason for hiding this comment

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

The yml file has pre-loaded modules such as 'puppet-conntrackd'. If I'm trying to create a new module (from scratch?) then is it necessary to remove all of the pre-loaded entries in manage_modules.yml?

No, I used "add" so that implies you don't need to remove other entries.

Since my module is not in the Puppet forge, what is the correct format to enter? Is it the path to 'git clone' the module?

I've added an example format.

@ekohl ekohl force-pushed the add-instructions-for-new-module branch from d9152d8 to d5b76eb Compare October 7, 2023 12:20
git status
git reset --hard
git clean -dfx
git checkout master
git pull --prune
git checkout "$(basename "$(git symbolic-ref refs/remotes/origin/HEAD)")"
Copy link
Member

Choose a reason for hiding this comment

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

lol, nice hack 'abusing' basename!

@ekohl ekohl merged commit a2ab07e into voxpupuli:master Oct 9, 2023
3 checks passed
@ekohl ekohl deleted the add-instructions-for-new-module branch October 9, 2023 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants