From 2ec6507650cfa1179bc84876733a681c9f18722b Mon Sep 17 00:00:00 2001 From: Parker Date: Sat, 13 Dec 2025 23:13:19 +0900 Subject: [PATCH] docs: fix broken links in doc --- docs/README.md | 6 +++--- docs/external_links.md | 2 +- docs/faq.md | 2 +- docs/tutorials/github_actions.md | 11 ++++++----- docs/tutorials/writing_commits.md | 2 +- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/README.md b/docs/README.md index fa3fab223..3b8fd7fb6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -45,7 +45,7 @@ This standardization makes your commit history more readable and meaningful, whi - Intelligent [version bumping](https://commitizen-tools.github.io/commitizen/commands/bump/) using [Semantic Versioning][semver] - Automatic [keep a changelog][keepchangelog] generation - Built-in commit validation with pre-commit hooks -- [Customizable](https://commitizen-tools.github.io/commitizen/customization/) commit rules and templates +- [Customizable](https://commitizen-tools.github.io/commitizen/customization/config_file/) commit rules and templates - Multi-format version file support - Custom rules and plugins via pip @@ -174,7 +174,7 @@ You can customize: - [Version files](https://commitizen-tools.github.io/commitizen/commands/bump/#version_files) - [Version scheme](https://commitizen-tools.github.io/commitizen/commands/bump/#version_scheme) -- [Version provider](https://commitizen-tools.github.io/commitizen/config/#version-providers) +- [Version provider](https://commitizen-tools.github.io/commitizen/config/version_provider/) For all available options, see the [bump command documentation](https://commitizen-tools.github.io/commitizen/commands/bump/). @@ -249,7 +249,7 @@ Commitizen provides a comprehensive CLI with various commands. Here's the comple - [Conventional Commits Specification][conventional_commits] - [Exit Codes Reference](https://commitizen-tools.github.io/commitizen/exit_codes/) -- [Configuration Guide](https://commitizen-tools.github.io/commitizen/config/) +- [Configuration Guide](https://commitizen-tools.github.io/commitizen/config/configuration_file/) - [Command Documentation](https://commitizen-tools.github.io/commitizen/commands/init/) ### Getting Help diff --git a/docs/external_links.md b/docs/external_links.md index 1b5efb05d..9c3075877 100644 --- a/docs/external_links.md +++ b/docs/external_links.md @@ -14,6 +14,6 @@ - [Python Table Manners - Commitizen: 規格化 commit message](https://blog.wei-lee.me/posts/tech/2020/03/python-table-manners-commitizen/) (Written in Traditional Mandarin) - [Automating semantic release with commitizen](https://woile.dev/posts/automating-semver-releases-with-commitizen/) (English) - [How to Write Better Git Commit Messages – A Step-By-Step Guide](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/?utm_source=tldrnewsletter) (English) -- [Continuous delivery made easy (in Python)](https://medium.com/dev-genius/continuous-delivery-made-easy-in-python-c085e9c82e69) +- [Continuous delivery made easy (in Python)](https://blog.devgenius.io/continuous-delivery-made-easy-in-python-c085e9c82e69) [automatizando]: https://youtu.be/t3aE2M8UPBo diff --git a/docs/faq.md b/docs/faq.md index 9de0c43e4..fba72325b 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -120,7 +120,7 @@ If you would like to learn more about both schemes, there are plenty of good res - [API Versioning from Stripe](https://stripe.com/blog/api-versioning) - [Discussion about pip's use of CalVer](https://github.com/pypa/pip/issues/5645#issuecomment-407192448) - [Git Version Numbering](https://code.erpenbeck.io/git/2021/12/16/git-version-numbering/) -- [SemVer vs. CalVer and Why I Use Both](https://mikestaszel.com/2021/04/03/semver-vs-calver-and-why-i-use-both/) (but not at the same time) +- [SemVer vs. CalVer and Why I Use Both](https://mikestaszel.com/post/semver-vs-calver-and-why-i-use-both/) (but not at the same time) - [Semver Will Not Save You](https://hynek.me/articles/semver-will-not-save-you/) - [Why I Don't Like SemVer](https://snarky.ca/why-i-dont-like-semver/) diff --git a/docs/tutorials/github_actions.md b/docs/tutorials/github_actions.md index 2cb58cfee..f15b62fba 100644 --- a/docs/tutorials/github_actions.md +++ b/docs/tutorials/github_actions.md @@ -113,13 +113,14 @@ jobs: poetry install - name: Build and publish env: - PYPI_USERNAME: __token__ - PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }} - run: | - ./scripts/publish + POETRY_HTTP_BASIC_PYPI_USERNAME: __token__ + POETRY_HTTP_BASIC_PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }} + run: poetry publish --build ``` -Notice that we are using poetry, and we are calling a bash script in `./scripts/publish`. You should configure the action, and publish with your tools (twine, poetry, etc.). Check [Commitizen example](https://github.com/commitizen-tools/commitizen/blob/master/scripts/publish) +Notice that we are using poetry to publish the package. + + You can also use [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) to publish your package. Push the changes and that's it. diff --git a/docs/tutorials/writing_commits.md b/docs/tutorials/writing_commits.md index a56d6494d..a3cf778dc 100644 --- a/docs/tutorials/writing_commits.md +++ b/docs/tutorials/writing_commits.md @@ -46,6 +46,6 @@ Emojis may be added as well (e.g., see [cz-emoji][cz_emoji]), which requires the [customization]: ../customization/config_file.md [conventional_commits]: https://www.conventionalcommits.org -[cz_emoji]: https://commitizen-tools.github.io/commitizen/third-party-commitizen/#cz-emoji +[cz_emoji]: https://commitizen-tools.github.io/commitizen/third-party-plugins/cz-emoji/ [configuration]: ../config/commit.md#encoding [breaking-change-config]: ../config/commit.md#breaking_change_exclamation_in_title