You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Also added "If everything was fine with your dist, you should see your module tar
file in your C<Perl6> directory along with both a meta and a readme file named
after your module filename." to the "Upload your module to CPAN" section.
Currently there are two different module ecosystems (module distribution
535
538
networks) available:
@@ -669,12 +672,16 @@ Make your X<C<META6.json>|META6.json> file look something like this:
669
672
=endcode
670
673
671
674
For choosing a version numbering scheme, try and use
672
-
"major.minor.patch" (see L<the spec on versioning | https://design.perl6.org/S11.html#Versioning> for further
673
-
details). This will go into the C<version> key of C<META6.json>.
675
+
"major.minor.patch"
676
+
(see L<the spec on versioning | https://design.perl6.org/S11.html#Versioning>
677
+
for further details). This will go into the C<version> key of C<META6.json>.
674
678
675
-
The C<name> key is compulsory, and C<zef> will fail if you do not include it. Even if you have created a META6.json file just to express the dependencies for a series of scripts, this section must be included.
679
+
The C<name> key is compulsory, and C<zef> will fail if you do not include it.
680
+
Even if you have created a META6.json file just to express the dependencies
681
+
for a series of scripts, this section must be included.
676
682
677
-
The C<auth> section identifies the author in GitHub or other repository hosting site, such as Bitbucket.
683
+
The C<auth> section identifies the author in GitHub or other repository
684
+
hosting site, such as Bitbucket.
678
685
679
686
The C<authors> section includes a list of all the module authors. In
680
687
the case there is only one author, a single element list must be
@@ -689,28 +696,35 @@ Set C<perl> version to the minimum perl version your module works with.
689
696
690
697
Optionally, you can set an C<api> field. Incrementing this indicates that
691
698
the interface provided by your module is not backwards compatible with a
692
-
previous version. You can use it if you want to adhere to L<Semantic Versioning | https://semver.org>. Simply keep the C<api> field to the same value as
693
-
your major version number. A dependency can then depend on your module by
694
-
including a C<:api> part, which will ensure backwards incompatible releases
695
-
will not be pulled in.
696
-
697
-
The C<resources> section is optional, but, if present, should contain a
698
-
list of the files in your C<resources> directory that you wish to be
699
-
installed. These will be installed with hashed names alongside your
700
-
library files and their installed location can be determined through the
701
-
C<%?RESOURCES>C<Hash> indexed on the name provided. C<tags> is also optional, but is used to describe the module in the Perl 6 ecosystem.
702
-
703
-
C<depends>, C<build-depends> and C<test-depends> include different modules that are used in those phases of the of installation. The last two are optional, but convenient.
704
-
705
-
Finally, C<source-url> indicates the URL of the repository where the module is developed.
699
+
previous version. You can use it if you want to adhere to
700
+
L<Semantic Versioning | https://semver.org>. Simply keep the C<api> field to
701
+
the same value as your major version number. A dependency can then depend on
702
+
your module by including a C<:api> part, which will ensure backwards
703
+
incompatible releases will not be pulled in.
704
+
705
+
The C<resources> section is optional, but, if present, should contain a list
706
+
of the files in your C<resources> directory that you wish to be installed.
707
+
These will be installed with hashed names alongside your library files and
708
+
their installed location can be determined through the C<%?RESOURCES>C<Hash>
709
+
indexed on the name provided. C<tags> is also optional, but is used to describe
710
+
the module in the Perl 6 ecosystem.
711
+
712
+
C<depends>, C<build-depends> and C<test-depends> include different modules that
713
+
are used in those phases of the of installation. The last two are optional, but
714
+
convenient.
715
+
716
+
Finally, C<source-url> indicates the URL of the repository where the module is
717
+
developed.
706
718
707
719
The L<Test::META module | https://github.com/jonathanstowe/Test-META/>
708
720
can help you check the correctness of the META6.json file.
709
721
710
-
There are more fields described in the L<META design documents |https://design.perl6.org/S22.html#META6.json>, but not all of these are
711
-
implemented by existing package managers. Hence you should stick to the
712
-
fields described in the above example block to ensure compatibility with
713
-
existing package managers. You can also check L<Moritz Lenz's repository of all modules for examples|https://github.com/moritz/perl6-all-modules/search?l=JSON&q=META6.json&type=>.
722
+
There are more fields described in the
723
+
L<META design documents |https://design.perl6.org/S22.html#META6.json>, but not
724
+
all of these are implemented by existing package managers. Hence you should
725
+
stick to the fields described in the above example block to ensure compatibility
726
+
with existing package managers. You can also check
727
+
L<Moritz Lenz's repository of all modules for examples|https://github.com/moritz/perl6-all-modules/search?l=JSON&q=META6.json&type=>.
714
728
715
729
=enditem
716
730
@@ -758,11 +772,13 @@ L<Upload a file to CPAN|https://pause.perl.org/pause/authenquery?ACTION=add_uri>
758
772
759
773
=itemMake sure you select C<Perl6> as the I<Target Directory>. For
760
774
your first upload, you have to enter the string C<Perl6> in the text field.
761
-
On subsequent uploads, you can select the C<Perl6> directory from select
762
-
box above the input field.
775
+
On subsequent uploads, you can select the C<Perl6> directory from the
776
+
selection box right below the input field.
763
777
764
778
=beginitem
765
-
Select your file and click I<Upload>!
779
+
Select your file and click I<Upload>! If everything was fine with your
780
+
dist, you should see your module tar file in your C<Perl6> directory along
781
+
with both a meta and a readme file named after your module filename.
766
782
767
783
I<Make sure you have a META6.json file in your dist and that the dist
768
784
version you're uploading is higher than the currently uploaded version.
0 commit comments