Merge pull request #12 from tbrowder/warning

Warning
tbrowder · Feb 24, 2024 · c733064 · c733064
2 parents 11a0144 + f2cde4b
commit c733064
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 6 deletions.
diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
@@ -25,6 +25,5 @@ jobs:
       - name: Install Dependencies
         run: |
           zef install --/test --deps-only .
-          zef install --/test App::Prove6
       - name: Run Tests
-        run: prove6 -l t
+        run: zef --debug install .
diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
@@ -25,6 +25,5 @@ jobs:
       - name: Install Dependencies
         run: |
           zef install --/test --deps-only .
-          zef install --/test App::Prove6
       - name: Run Tests
-        run: prove6 -l t
+        run: zef --debug install .
diff --git a/Changes b/Changes
@@ -1,6 +1,8 @@
 Revision history for Mi6-Helper
 
 {{$NEXT}}
+    - Add warning about issue #11
+    - Use @ugexe's recommended test run line for linux and macos
 
 0.11.1  2023-10-24T21:03:25-05:00
     - Major improvements:

diff --git a/README.md b/README.md
@@ -5,11 +5,15 @@ NAME
 
 **Mi6::Helper** - An aid for converting Raku modules to use **App::Mi6**
 
+WARNING 
+========
+
+There is a serious bug in the current version: it is unable to to correctly handle a desired module name with mixed '::' and hyphens ('-'). An issue has been filed, but, unless a user needs it soon, a fix will be delayed. A work-around is to manually make the necessary changes after the failure message. Please comment in the issue entry (#11) if a fix is important for your current project.
+
 SYNOPSIS
 ========
 
     use Mi6::Helper
-
     $ mi6-helper new=Foo::Bar  # uses the 'provides' text in hidden file 
                                # '.Foo-Bar' (recommended method)
 

diff --git a/docs/README.rakudoc b/docs/README.rakudoc
@@ -4,11 +4,19 @@
 
 B<Mi6::Helper> - An aid for converting Raku modules to use B<App::Mi6>
 
+=head1 WARNING 
+
+There is a serious bug in the current version: it is
+unable to to correctly handle a desired module name with 
+mixed '::' and hyphens ('-'). An issue has been filed, but, unless a
+user needs it soon, a fix will be delayed. A work-around is to manually
+make the necessary changes after the failure message. Please comment
+in the issue entry (#11) if a fix is important for your current project.
+
 =head1 SYNOPSIS
 
 =begin code
 use Mi6::Helper
-
 $ mi6-helper new=Foo::Bar  # uses the 'provides' text in hidden file 
                            # '.Foo-Bar' (recommended method)
 =end code