{"id":20313485,"url":"https://github.com/autogluon/autogluon-brokenlinks","last_synced_at":"2025-08-04T21:43:34.723Z","repository":{"id":185167344,"uuid":"673091084","full_name":"autogluon/autogluon-brokenlinks","owner":"autogluon","description":"Repo to hold data on broken links of AutoGluon websites for reference","archived":false,"fork":false,"pushed_at":"2025-03-01T08:10:28.000Z","size":361,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-02T03:48:02.104Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/autogluon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-31T21:14:29.000Z","updated_at":"2025-03-01T08:10:32.000Z","dependencies_parsed_at":"2023-09-27T13:52:54.175Z","dependency_job_id":"dad516cc-6ec9-439b-90fe-c807552219d0","html_url":"https://github.com/autogluon/autogluon-brokenlinks","commit_stats":null,"previous_names":["autogluon/autogluon-brokenlinks"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autogluon%2Fautogluon-brokenlinks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autogluon%2Fautogluon-brokenlinks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autogluon%2Fautogluon-brokenlinks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autogluon%2Fautogluon-brokenlinks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/autogluon","download_url":"https://codeload.github.com/autogluon/autogluon-brokenlinks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241812693,"owners_count":20024445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T18:11:16.509Z","updated_at":"2025-03-04T08:28:23.612Z","avatar_url":"https://github.com/autogluon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AutoGluon Link Checker\n\nAutoGluon Link Checker is a robust tool designed to crawl and identify broken links within AutoGluon's documentation. It operates seamlessly with GitHub Actions, providing daily reports for both stable and development documentation versions.\n\n## Features\n\n- **Crawling**: Checks links in doc.\n- **Edge Case Handling**: Manages common issues like bot detection and DNS problems.\n- **Reporting**: Generates comprehensive CSV reports highlighting broken links and their origins.\n- **Configurable Allowlist**: Easily manage known false positives to reduce noise in reports.\n\n## Installation\n\n1. **Clone the Repository**:\n   ```bash\n   git clone https://github.com/yourusername/autogluon-link-checker.git\n   cd autogluon-link-checker\n   ```\n\n2. **Install Dependencies**:\n   Ensure you have Python 3.9 installed. Then, install the required packages:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n## Usage\n\nRun the link checker script with the following command:\n\n```bash\npython get_broken_links.py\n```\n\n\nThis will generate CSV files with broken links for both stable and development documentation.\n\n## GitHub Actions Integration\n\nThe link checker is set up to run daily using GitHub Actions. The workflow is defined in `.github/workflows/broken_link_checker.yml`. It automatically commits and pushes CSV reports of broken links to the repository.\n\n## Configuration\n\n- **Allowed Domains**: Modify `ALLOWED_403_DOMAINS` in `get_broken_links.py` to add domains that are allowed to return 403 errors.\n- **Ignored URLs**: Update `IGNORE_STRINGS_IN_URL` to skip specific URLs during the check.\n\n## Contributing\n\nContributions are welcome! Please fork the repository and submit a pull request with your changes.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Contact\n\nFor questions or feedback, please open an issue on GitHub or contact the maintainers directly.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautogluon%2Fautogluon-brokenlinks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautogluon%2Fautogluon-brokenlinks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautogluon%2Fautogluon-brokenlinks/lists"}