MeltanoLabs / MeltanoLabs/tap-gitlab
Readme can have different formats
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 12
- Forks
- 29
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 1
Description
The Readme stream assumes that we are fetching an .md file but it is not always the case.
Eg. README.rst for flake8-docstrings which leads to a 404 file not found in the tap.
{'type': 'timer', 'metric': 'http_request_duration', 'value': 0.164145, 'tags': {'endpoint': '/projects/{project_id}/repository/files/README%2Emd/raw', 'http_status_code': 404, 'status': 'failed', 'url': '/api/v4/projects/140322/repository/files/README.md/raw', 'context': {'project_id': 140322, 'project_path': 'pycqa/flake8-docstrings'}}}
We could:
- use the
readme_urlavailable in the project object - try different exetnsion, probably .md and .rst would cover 99.9% of cases
But at the very least we should add error handling around missing readmes :)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Readme stream and trace how the GitLab project object is used to fetch README.md. Check the available readme_url and missing-file response handling; done means repositories using README.rst or another supported format can be read without a 404 failure, while absent READMEs are handled safely.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- gitlab, python
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100