kiwigrid / antora-maven-content-extension

Antora 3 extension to source documentation from maven repositories.
MIT License
9 stars 2 forks source link

feat: add alternative versioning schemes #23

Closed jekkel closed 2 years ago

jekkel commented 2 years ago

This adds a OSGI centric versioning scheme as well as a plain text versioning scheme with SemVer still being the recommended default.

feat: pass through given edit_url

fix: either pass through edit_url or suppress it

github-actions[bot] commented 2 years ago

Coverage after merging feature/versioning into main will be

50.41%▴ +7.55%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
lib
   content-source-factory.js7.14%0%0%12.50%13–15, 25–26, 31, 31, 35–36
   extension.js74.42%50%100%80.77%49–50, 50, 50–51, 62–64, 64, 64–65
   maven-client.js8.06%0%0%11.76%102–103, 103, 103–105, 108, 112, 112, 112–113, 115–119, 135, 141–143, 143, 143–144, 146, 154, 154, 161, 175, 183, 183, 191–194, 194, 194–195, 197, 20, 201–204, 208, 212–213, 213, 213–215, 217–219, 223–224, 224, 224–225, 227–228, 228, 228–229, 231, 237–238, 31–34, 34, 34–35, 37, 37, 37, 37, 37, 40, 44, 46, 50, 52, 64, 64, 64–65, 67, 84–91, 91, 91–93, 93, 93–94, 98–99
   maven-content-source.js4.55%0%0%6.38%101, 105–106, 106, 106–107, 107, 107–108, 113, 113, 113–114, 116, 116, 116–117, 119, 119, 119–120, 122, 126, 133–134, 21, 39–47, 49, 49, 49–50, 52, 56, 60, 70–73, 73, 73, 75, 77–79, 85–89, 95
   maven-files.js88.06%71.11%100%96.15%163, 167, 167–168, 168, 168, 170, 170, 170–171, 171, 171, 35, 37, 57–58
   maven-types.js10.71%0%20%16.28%111–113, 123, 125, 125, 125–126, 129, 131, 135–137, 156, 26, 26–31, 35–36, 36–37, 37, 59–69, 71–78, 78, 78–79, 81–86, 86, 86–87, 89, 93–94, 94–95, 95–96, 96–97, 97
   version-selector.js80.49%75%100%82.61%12–14, 17, 3, 3, 5–6
   versioning.js85.71%88.89%78.95%85.96%110–111, 113–114, 132, 26, 33, 76–77, 90, 95–96
github-actions[bot] commented 2 years ago

Coverage after merging feature/versioning into main will be

50.41%▴ +7.55%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
lib
   content-source-factory.js7.14%0%0%12.50%13–15, 25–26, 31, 31, 35–36
   extension.js74.42%50%100%80.77%49–50, 50, 50–51, 62–64, 64, 64–65
   maven-client.js8.06%0%0%11.76%102–103, 103, 103–105, 108, 112, 112, 112–113, 115–119, 135, 141–143, 143, 143–144, 146, 154, 154, 161, 175, 183, 183, 191–194, 194, 194–195, 197, 20, 201–204, 208, 212–213, 213, 213–215, 217–219, 223–224, 224, 224–225, 227–228, 228, 228–229, 231, 237–238, 31–34, 34, 34–35, 37, 37, 37, 37, 37, 40, 44, 46, 50, 52, 64, 64, 64–65, 67, 84–91, 91, 91–93, 93, 93–94, 98–99
   maven-content-source.js4.55%0%0%6.38%101, 105–106, 106, 106–107, 107, 107–108, 113, 113, 113–114, 116, 116, 116–117, 119, 119, 119–120, 122, 126, 133–134, 21, 39–47, 49, 49, 49–50, 52, 56, 60, 70–73, 73, 73, 75, 77–79, 85–89, 95
   maven-files.js88.06%71.11%100%96.15%163, 167, 167–168, 168, 168, 170, 170, 170–171, 171, 171, 35, 37, 57–58
   maven-types.js10.71%0%20%16.28%111–113, 123, 125, 125, 125–126, 129, 131, 135–137, 156, 26, 26–31, 35–36, 36–37, 37, 59–69, 71–78, 78, 78–79, 81–86, 86, 86–87, 89, 93–94, 94–95, 95–96, 96–97, 97
   version-selector.js80.49%75%100%82.61%12–14, 17, 3, 3, 5–6
   versioning.js85.71%88.89%78.95%85.96%110–111, 113–114, 132, 26, 33, 76–77, 90, 95–96
github-actions[bot] commented 2 years ago

Coverage after merging feature/versioning into main will be

50.41%▴ +7.55%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
lib
   content-source-factory.js7.14%0%0%12.50%13–15, 25–26, 31, 31, 35–36
   extension.js74.42%50%100%80.77%49–50, 50, 50–51, 62–64, 64, 64–65
   maven-client.js8.06%0%0%11.76%102–103, 103, 103–105, 108, 112, 112, 112–113, 115–119, 135, 141–143, 143, 143–144, 146, 154, 154, 161, 175, 183, 183, 191–194, 194, 194–195, 197, 20, 201–204, 208, 212–213, 213, 213–215, 217–219, 223–224, 224, 224–225, 227–228, 228, 228–229, 231, 237–238, 31–34, 34, 34–35, 37, 37, 37, 37, 37, 40, 44, 46, 50, 52, 64, 64, 64–65, 67, 84–91, 91, 91–93, 93, 93–94, 98–99
   maven-content-source.js4.55%0%0%6.38%101, 105–106, 106, 106–107, 107, 107–108, 113, 113, 113–114, 116, 116, 116–117, 119, 119, 119–120, 122, 126, 133–134, 21, 39–47, 49, 49, 49–50, 52, 56, 60, 70–73, 73, 73, 75, 77–79, 85–89, 95
   maven-files.js88.06%71.11%100%96.15%163, 167, 167–168, 168, 168, 170, 170, 170–171, 171, 171, 35, 37, 57–58
   maven-types.js10.71%0%20%16.28%111–113, 123, 125, 125, 125–126, 129, 131, 135–137, 156, 26, 26–31, 35–36, 36–37, 37, 59–69, 71–78, 78, 78–79, 81–86, 86, 86–87, 89, 93–94, 94–95, 95–96, 96–97, 97
   version-selector.js80.49%75%100%82.61%12–14, 17, 3, 3, 5–6
   versioning.js85.71%88.89%78.95%85.96%110–111, 113–114, 132, 26, 33, 76–77, 90, 95–96
github-actions[bot] commented 2 years ago

Coverage after merging feature/versioning into main will be

50.41%▴ +7.55%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
lib
   content-source-factory.js7.14%0%0%12.50%13–15, 25–26, 31, 31, 35–36
   extension.js74.42%50%100%80.77%49–50, 50, 50–51, 62–64, 64, 64–65
   maven-client.js8.06%0%0%11.76%102–103, 103, 103–105, 108, 112, 112, 112–113, 115–119, 135, 141–143, 143, 143–144, 146, 154, 154, 161, 175, 183, 183, 191–194, 194, 194–195, 197, 20, 201–204, 208, 212–213, 213, 213–215, 217–219, 223–224, 224, 224–225, 227–228, 228, 228–229, 231, 237–238, 31–34, 34, 34–35, 37, 37, 37, 37, 37, 40, 44, 46, 50, 52, 64, 64, 64–65, 67, 84–91, 91, 91–93, 93, 93–94, 98–99
   maven-content-source.js4.55%0%0%6.38%101, 105–106, 106, 106–107, 107, 107–108, 113, 113, 113–114, 116, 116, 116–117, 119, 119, 119–120, 122, 126, 133–134, 21, 39–47, 49, 49, 49–50, 52, 56, 60, 70–73, 73, 73, 75, 77–79, 85–89, 95
   maven-files.js88.06%71.11%100%96.15%163, 167, 167–168, 168, 168, 170, 170, 170–171, 171, 171, 35, 37, 57–58
   maven-types.js10.71%0%20%16.28%111–113, 123, 125, 125, 125–126, 129, 131, 135–137, 156, 26, 26–31, 35–36, 36–37, 37, 59–69, 71–78, 78, 78–79, 81–86, 86, 86–87, 89, 93–94, 94–95, 95–96, 96–97, 97
   version-selector.js80.49%75%100%82.61%12–14, 17, 3, 3, 5–6
   versioning.js85.71%88.89%78.95%85.96%110–111, 113–114, 132, 26, 33, 76–77, 90, 95–96
github-actions[bot] commented 2 years ago

Coverage after merging feature/versioning into main will be

51.21%▴ +8.35%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
lib
   content-source-factory.js7.14%0%0%12.50%13–15, 25–26, 31, 31, 35–36
   extension.js74.42%50%100%80.77%49–50, 50, 50–51, 62–64, 64, 64–65
   maven-client.js8.06%0%0%11.76%102–103, 103, 103–105, 108, 112, 112, 112–113, 115–119, 135, 141–143, 143, 143–144, 146, 154, 154, 161, 175, 183, 183, 191–194, 194, 194–195, 197, 20, 201–204, 208, 212–213, 213, 213–215, 217–219, 223–224, 224, 224–225, 227–228, 228, 228–229, 231, 237–238, 31–34, 34, 34–35, 37, 37, 37, 37, 37, 40, 44, 46, 50, 52, 64, 64, 64–65, 67, 84–91, 91, 91–93, 93, 93–94, 98–99
   maven-content-source.js4.55%0%0%6.38%101, 105–106, 106, 106–107, 107, 107–108, 113, 113, 113–114, 116, 116, 116–117, 119, 119, 119–120, 122, 126, 133–134, 21, 39–47, 49, 49, 49–50, 52, 56, 60, 70–73, 73, 73, 75, 77–79, 85–89, 95
   maven-files.js88.06%71.11%100%96.15%163, 167, 167–168, 168, 168, 170, 170, 170–171, 171, 171, 35, 37, 57–58
   maven-types.js10.71%0%20%16.28%111–113, 123, 125, 125, 125–126, 129, 131, 135–137, 156, 26, 26–31, 35–36, 36–37, 37, 59–69, 71–78, 78, 78–79, 81–86, 86, 86–87, 89, 93–94, 94–95, 95–96, 96–97, 97
   version-selector.js80.49%75%100%82.61%30, 30, 32–33, 4–6, 9
   versioning.js86.67%89.19%80%87.30%105, 110–111, 121–122, 124–125, 143, 28, 35, 84–85
jekkel commented 2 years ago

It would be good to clarify the comment about the warning in the readme file, the other comments are just about style or "nice to have".

I didn't go deeply into the OSGi versioning semantics – I trust your tests there slightly_smiling_face

Thanks, but it's pretty simple. Nowhere near SemVer ranges...

github-actions[bot] commented 2 years ago

Coverage after merging feature/versioning into main will be

51.21%▴ +8.35%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
lib
   content-source-factory.js7.14%0%0%12.50%13–15, 25–26, 31, 31, 35–36
   extension.js74.42%50%100%80.77%49–50, 50, 50–51, 62–64, 64, 64–65
   maven-client.js8.06%0%0%11.76%102–103, 103, 103–105, 108, 112, 112, 112–113, 115–119, 135, 141–143, 143, 143–144, 146, 154, 154, 161, 175, 183, 183, 191–194, 194, 194–195, 197, 20, 201–204, 208, 212–213, 213, 213–215, 217–219, 223–224, 224, 224–225, 227–228, 228, 228–229, 231, 237–238, 31–34, 34, 34–35, 37, 37, 37, 37, 37, 40, 44, 46, 50, 52, 64, 64, 64–65, 67, 84–91, 91, 91–93, 93, 93–94, 98–99
   maven-content-source.js4.55%0%0%6.38%101, 105–106, 106, 106–107, 107, 107–108, 113, 113, 113–114, 116, 116, 116–117, 119, 119, 119–120, 122, 126, 133–134, 21, 39–47, 49, 49, 49–50, 52, 56, 60, 70–73, 73, 73, 75, 77–79, 85–89, 95
   maven-files.js88.06%71.11%100%96.15%163, 167, 167–168, 168, 168, 170, 170, 170–171, 171, 171, 35, 37, 57–58
   maven-types.js10.71%0%20%16.28%106–108, 118, 120, 120, 120–121, 124, 126, 130–132, 151, 26, 26–31, 35–36, 36–37, 37, 59–69, 71–78, 78, 78–79, 81–86, 86, 86–87, 89, 93, 93, 93, 93, 93, 93, 93, 93, 93
   version-selector.js80.49%75%100%82.61%30, 30, 32–33, 4–6, 9
   versioning.js86.67%89.19%80%87.30%105, 110–111, 121–122, 124–125, 143, 28, 35, 84–85