compodoc / compodoc

:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
https://compodoc.app
MIT License
4k stars 407 forks source link

[BUG] Link of the changelog wrong when using with Bitbucket #1404

Open marcus-gomes-v opened 1 year ago

marcus-gomes-v commented 1 year ago
Overview of the issue

When using the compodoc under the bitbucket repo, the link of the commit in the changelog, is on singular and for bitbucket the commits are in the plural.

Operating System, Node.js, npm, compodoc version(s)

npm: 8.19.2 node: v18.12.1

Angular configuration, a package.json file in the root folder
{
  "name": "backend",
  "version": "1.2.0",
  "description": "Backend project, this project intends to create a backbone API.",
  "author": "Marcus Gomes",
  "private": true,
  "license": "proprietary",
  "node": "18.12.1",
  "scripts": {
    "docs": "npx @compodoc/compodoc -p tsconfig.json && mv documentation dist/app/",
    "docker": "docker-compose up -d --force-recreate",
    "release": "standard-version",
    "build": "nest build",
    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
    "start": "nest start",
    "start:dev": "nest start --watch",
    "start:debug": "nest start --debug 0.0.0.0 --watch",
    "start:prod": "node dist/main",
    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
    "lint:fix": "npm run lint -- --fix",
    "test": "jest",
    "test:watch": "jest --watch",
    "test:cov": "jest --coverage",
    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
    "test:e2e": "jest --config ./test/jest-e2e.json",
    "deploy": "npm run start:prod"
  },
  "dependencies": {
    "@nestjs/axios": "^1.0.1",
    "@nestjs/cache-manager": "^2.1.0",
    "@nestjs/common": "^9.2.1",
    "@nestjs/core": "^9.2.1",
    "@nestjs/jwt": "^10.0.1",
    "@nestjs/mongoose": "^9.2.1",
    "@nestjs/passport": "^9.0.0",
    "@nestjs/platform-express": "^9.0.0",
    "@nestjs/schedule": "^3.0.1",
    "@nestjs/serve-static": "^3.0.0",
    "@nestjs/swagger": "^6.1.4",
    "@nestjs/terminus": "^9.1.4",
    "@nestjs/typeorm": "^9.0.1",
    "@types/multer": "^1.4.7",
    "aws-sdk": "^2.1302.0",
    "bcryptjs": "^2.4.3",
    "cache-manager": "^5.2.4",
    "class-transformer": "^0.5.1",
    "class-validator": "^0.13.2",
    "crypto-js": "^4.1.1",
    "decimal.js": "^10.4.3",
    "dotenv": "^16.0.3",
    "firebase-admin": "^11.5.0",
    "handlebars": "^4.7.7",
    "jsonwebtoken": "^9.0.0",
    "moment": "^2.29.4",
    "mongoose": "^6.8.3",
    "nest-csv-parser": "^2.0.4",
    "nodemailer": "^6.9.1",
    "passport": "^0.6.0",
    "passport-jwt": "^4.0.1",
    "passport-local": "^1.0.0",
    "reflect-metadata": "^0.1.13",
    "rxjs": "^7.2.0",
    "swagger-themes": "^1.2.28",
    "typeorm": "^0.3.11"
  },
  "devDependencies": {
    "@compodoc/compodoc": "^1.1.19",
    "@nestjs/cli": "^9.0.0",
    "@nestjs/schematics": "^9.0.0",
    "@nestjs/testing": "^9.2.1",
    "@types/bcrypt": "^5.0.0",
    "@types/express": "^4.17.13",
    "@types/jest": "29.2.4",
    "@types/node": "18.11.18",
    "@types/nodemailer": "^6.4.7",
    "@types/passport-jwt": "^3.0.8",
    "@types/passport-local": "^1.0.35",
    "@types/supertest": "^2.0.11",
    "@typescript-eslint/eslint-plugin": "^5.0.0",
    "@typescript-eslint/parser": "^5.0.0",
    "eslint": "^8.0.1",
    "eslint-config-prettier": "^8.3.0",
    "eslint-plugin-prettier": "^4.0.0",
    "jest": "29.3.1",
    "prettier": "^2.3.2",
    "source-map-support": "^0.5.20",
    "standard-version": "^9.5.0",
    "supertest": "^6.1.3",
    "ts-jest": "29.0.3",
    "ts-loader": "^9.2.3",
    "ts-node": "^10.0.0",
    "tsconfig-paths": "4.1.1",
    "typescript": "^4.9.4"
  },
  "jest": {
    "moduleFileExtensions": [
      "js",
      "json",
      "ts"
    ],
    "rootDir": "src",
    "testRegex": ".*\\.spec\\.ts$",
    "transform": {
      "^.+\\.(t|j)s$": "ts-jest"
    },
    "collectCoverageFrom": [
      "**/*.(t|j)s"
    ],
    "coverageDirectory": "../coverage",
    "testEnvironment": "node"
  }
}
Compodoc installed globally or locally ?

Locally called.

Motivation for or Use Case

When used connected with the bitbucket the problem appears the diff between the commit link for Github and Bitbucket.

Reproduce the error

Just create a application and use the Bitbucket as repo, then when you use the release version to create automatic the compodoc, the links of the changelog that was automatic created when you use the standard commit, will be wrong

Eg automatic link generated: https://bitbucket.org/<team>/<repo>/commit/<commit-number>

Suggest a Fix

Simple change the

Automatic link generated from:

https://bitbucket.org/<team>/<repo>/commit/<commit-number>

to:

https://bitbucket.org/<team>/<repo>/commits/<commit-number>

vogloblinsky commented 1 year ago

Where is located the link ?

marcus-gomes-v commented 1 year ago

In the changelog: image

@vogloblinsky I would like to try to fix this as well, I reported to check if someone has some guides. Btw i Think maybe this is something to fix in the standard-version not here in the compodoc 🤔

vogloblinsky commented 1 year ago

Ok what is the raw text of the link in the changelog please ?