Techdocs: Unable to generate docs on Gitlab hosts locally

Expected Behavior

Gitlab projects cloned inside /tmp/backstage-xxxx

Current Behavior

Gitlab projects are currently being cloned inside a subfolder /tmp/backstage-xxxx/repository-name-xxxx When generating the doc, mkdocs can’t find the mkdocs.yml file because the mkdocs is not inside /tmp/backstage-xxxx but inside /tmp/backstage-xxxx/repository-name-xxxx

Steps to Reproduce

1. Create a Gitlab repository with documentation inside it (I had the issue on Gitlab enterprise)
2. Have a backstage project linked to it
3. Run your backstage backend
4. Run your backstage frontend
5. Go to the documentation page
6. The error should be displayed on the backend console

Context

On my dev env, I was trying to display the documentation of a project hosted on Gitlab I don’t have backstage running in a container, I directly used yarn start on my host machine from a clone of backstage. Techdocs is configured like this:

techdocs:
  requestUrl: http://localhost:7000/api/techdocs
  storageUrl: http://localhost:7000/api/techdocs/static/docs
  builder: 'local'
  generators:
    techdocs: 'docker'
  publisher:
    type: 'local' 

Here is a stack trace:

2021-02-11T14:30:04.980Z techdocs warn Could not read file /tmp/backstage-r2ayTr/mkdocs.yml before running the generator. ENOENT: no such file or directory, open '/tmp/backstage-r2ayTr/mkdocs.yml' type=plugin
2021-02-11T14:30:07.585Z backstage error Failed to generate docs from /tmp/backstage-r2ayTr into /tmp/techdocs-tmp-cBtwQo with error Docker container returned a non-zero exit code (1) type=errorHandler stack=Error: Failed to generate docs from /tmp/backstage-r2ayTr into /tmp/techdocs-tmp-cBtwQo with error Docker container returned a non-zero exit code (1)
    at TechdocsGenerator.run (webpack-internal:///../techdocs-common/src/stages/generate/techdocs.ts:120:13)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async DocsBuilder.build (webpack-internal:///../../plugins/techdocs-backend/src/DocsBuilder/builder.ts:94:5)
    at async eval (webpack-internal:///../../plugins/techdocs-backend/src/service/router.ts:143:13)

Your Environment

• NodeJS Version (v14.15.4):
• Ubuntu 20.04
• backend-common (v0.4.3)

[yorickgirard]

@OrkoHunter after updating the dependencies it works properly, I think the issue can be closed

Thanks

[yorickgirard]

Here is the project

I’ll update my dependencies right now thanks

project-sample-backstage-master.zip