The document outlines the steps to upload a Perl module to CPAN, including creating accounts on PAUSE and GitHub, setting up a repository, and submitting a pull request. It emphasizes the importance of choosing a good module name, creating distributions using various tools, and engaging with the community for feedback and help. Additionally, it suggests ways to publicize the module and provides contact information for support.

1. Uploading Your
First Module
to CPAN
brian d foy!
The Perl Review!
August 2014, Chicago.pm

2. Tonight’s Goals
• Create a PAUSE account!
• Create a basic module!
• Set up a git repo!
• Create a Github account!
• Upload a module!
• Send a pull request!
• Merge a pull request

3. PAUSE

4. PAUSE
• You upload through PAUSE!
http://pause.perl.org!
• The Perl Authors Upload Server!
• This is a stepping stone to CPAN

5. Indexing
• PAUSE indexes and creates data files
for the CPAN clients!
• Only the latest distributions get into it!
• People have permissions for
namespaces

6. Get PAUSE Account
https://pause.perl.org/pause/query?ACTION=request_id

7. Choose a module name
https://pause.perl.org/pause/query?
ACTION=pause_namingmodules

8. Acme::MyFirstModule::PAUSEID

9. Permissions
• You can upload a namespace
someone else already uses!
• But PAUSE will ignore it!
• A good name goes a long way!
• We have general advice on names!
https://pause.perl.org/pause/query?
ACTION=pause_namingmodules

10. Create

11. Create the distro
• There are modules that can help you!
• Module::Starter!
• Distribution::Cooker!
• h2xs (comes with Perl)!
• many others

12. Module::Starter

13. 25,000 Examples
• Look at other distributions as examples!
• See how other people do it!
• Ask them questions

14. Git

15. Github

20. Upload

21. Upload early & often
• You don’t have to be perfect!
• … or even good!
• Other people can help as soon as possible!
• CPAN Testers can send you feedback

22. Upload
https://pause.perl.org/pause/authenquery?ACTION=add_uri

23. Now, break it
• Insert a mistake in your module!
• Ensure the tests pass!
• Bump the version number!
• Reupload!
• Push changes up to Github

24. Pull request

25. Fork a repo

26. Clone it

27. Send Pull Request

28. Check sites

29. CPAN Search

30. MetaCPAN

31. Lots more
• PAUSE lets you add co-maintainers!
• You can take over existing modules!
• You can help with other people’s
modules

32. Publicize your module
• Don’t be shy!
• Write something on blogs.perl.org!
• Tweet it, plus it, facebook it!
• Give a lightning talk

33. Getting help
• For help with PAUSE issues, write to
modules@perl.org!
• One of the PAUSE volunteer admins
can help you!
• For general module questions, you
might try module-authors@perl.org!
• For CPAN Search issues, try
cpansearch@perl.org