Charm promulgation is the process of making your charm available on the charm store and visible in searches as the recommended charm. This is a manual process and requires a review from a member of the ~charmers Launchpad group.
Before you request promulgation
You should spend some time verifying your charm is in good shape before you request promulgation. If you are requesting promulgation over an existing charm, ensure your charm uses the same configuration variables and has the same or greater feature set or be able to explain why your charm should replace the existing one. Use the following checklist to ensure you are ready for promulgation
- [ ] Verify charm proof doesn’t have any errors.
- [ ] Ensure the charm source is available and in a public repository
- [ ] Make sure the charm has bugs-url and homepage set via
charm set bugs-url="https://example.com/issues"
charm set homepage="https://example.com"
Request promulgation
The current method of requesting promulgation is to go to the Juju discourse page and make a new topic with the Charming tag requesting promulgation. Once you submit your request simply wait for someone to respond to the topic with either questions or status.
To promulgate a Juju charm a member of the ~charmers Launchpad group will:
- Download the proposed charm (
charm pull). - Perform static analysis on the charm (
charm proof). - Ensure the charm has a bugs-url and homepage (
charm set). - If steps 2 or 3 fails, the charm author will be asked to make changes.
- Promulgate the charm (
charm promulgate). - Grant write access to the promulgated charm (
charm grant).