Skip to content

Commit eeae4da

Browse files
committed
Add section on the 'api' field
1 parent 7df95b2 commit eeae4da

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/Language/modules.pod6

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,7 @@ lib
537537
{
538538
"perl" : "6.c",
539539
"name" : "Vortex::TotalPerspective",
540+
"api" : "1",
540541
"version" : "0.0.1",
541542
"description" : "Wonderful simulation to get some perspective.",
542543
"authors" : [ "R<Your Name>" ],
@@ -567,6 +568,16 @@ lib
567568
568569
Set C<perl> version to the minimum perl version your module works with.
569570
571+
Optionally, you can set an C<api> field. Incrementing this indicates that
572+
the interface provided by your module is not backwards compatible with a
573+
previous version.
574+
575+
If you want to adhere to L<Semantic Versioning | https://semver.org>, you
576+
can use the C<api> field. Simply keep the C<api> field to the same value as
577+
your major version number. A dependency can then depend on your module by
578+
including a C<:api> part, which will ensure backwards incompatible releases
579+
will not be pulled in.
580+
570581
The C<resources> section is optional, but, if present, should contain a
571582
list of the files in your C<resources> directory that you wish to be
572583
installed, these will be installed with hashed names alongside your

0 commit comments

Comments
 (0)