Skip to content

Conversation

@Parkerhiphop
Copy link
Contributor

@ParkerhiphopParkerhiphop commented Dec 13, 2025

Description

I replaced all broken links identified in the CI pipeline run 20103076261.

Specific changes:

  • docs/tutorials/github_actions.md: Removed the reference to the missing ./scripts/publish script. I updated the example to use poetry publish --build directly, matching the actual pythonpublish.yml workflow.
  • Updated various other broken links in README.md, faq.md, and writing_commits.md.

However, the Continuous delivery made easy (in Python) in docs/external_links.md is a member-only post, so it would be 403 Forbidden.

Should we remove it or keep it?

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'. 

Expected Behavior

The Summary of ci: add link checker should not have any errors.

Steps to Test This Pull Request

Run the ci: add link checker.

Additional Context

close#1721

@codecov
Copy link

codecovbot commented Dec 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.88%. Comparing base (120d514) to head (2ec6507).
⚠️ Report is 886 commits behind head on master.

Additional details and impacted files
@@ Coverage Diff @@## master #1727 +/- ## ========================================== + Coverage 97.33% 97.88% +0.55%  ========================================== Files 42 60 +18 Lines 2104 2605 +501 ========================================== + Hits 2048 2550 +502 + Misses 56 55 -1 
FlagCoverage Δ
unittests97.88% <ø> (+0.55%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bearomorphism
Copy link
Collaborator

Hi @Parkerhiphop , thanks for improving our documentation!

However, the Continuous delivery made easy (in Python) in docs/external_links.md is a member-only post, so it would be 403 Forbidden.

Should we remove it or keep it?

Let's keep it and I will add it to the whitelist in the pipeline.

@bearomorphismbearomorphism merged commit b64c6f6 into commitizen-tools:masterDec 14, 2025
21 checks passed
@bearomorphism
Copy link
Collaborator

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix broken links in docs

2 participants

@Parkerhiphop@bearomorphism