Development v5

.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/node:10.5
+      - image: circleci/node:14
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -37,7 +37,7 @@ jobs:
       # run tests
       - run:
           name: Testing
-          command: npm run all
+          command: npm run ci
       # lint
       - run:
           name: lint

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:10
-RUN npm i -D tap-junit@4.0.0
+FROM node:14
+RUN npm i -D tap-junit@5.0.0
 WORKDIR /io
 ENTRYPOINT [ "sh", "/node_modules/.bin/tap-junit" ]

README.md

@@ -47,6 +47,8 @@ The above will create a file called `tape.xuni` in the `output/tests` directory
 
 ## Output
 
+Tap-Junit currently follows [this spec](https://github.com/junit-team/junit5/blob/main/platform-tests/src/test/resources/jenkins-junit.xsd) on junit syntax/layout
+
 ```xml
 <testsuites tests="4" name="Tap-Junit" failures="2">
   <testsuite tests="4" failures="2" skipped="1">
@@ -59,3 +61,11 @@ The above will create a file called `tape.xuni` in the `output/tests` directory
   </testsuite>
 </testsuites>
 ```
+
+## Comments
+
+So Tap Junit takes a [tape]() style assumption when it comes to comments. That being, when a comment appears before a test (because that's how tape labels its tap output) it will be registered as a comment for that test, but the issue here is that you may lose placed comments in your tap files.
+
+At the moment, I'm still trying to figure out a decent way to handle comments and record them. Keep this in mind that only a single comment before each test will currently be recorded for a system-out tag.
+
+If you have ideas on how to better handle this, don't hesitate to reach out!

changelog.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v5.0.0
+
+Please report any issues or serliazation that does not follow the below spec for output! Thanks!
+
+### BREAKING CHANGES
+
+- Changed the output generation of tap-junit to follow [this spec](https://github.com/junit-team/junit5/blob/main/platform-tests/src/test/resources/jenkins-junit.xsd) more closely
+  - This means no more floating comments, they are now either in the `system-out` tag or the `message` attribute
+- Changed how handling tap comments works, please see the [Comments](https://github.com/dhershman1/tap-junit#comments) section in the Readme
+
+### Improved
+
+- Bit of re organization of the tool
+- Bumped Docker node and tap versions
+
+### Fixed
+
+- Broken comments on some tap outputs
+
+
 ## v4.2.0
 
 ### Improved