Skip to content

Commit 2ec6507

Browse files
committed
docs: fix broken links in doc
1 parent c0da2e6 commit 2ec6507

File tree

5 files changed

+12
-11
lines changed

5 files changed

+12
-11
lines changed

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This standardization makes your commit history more readable and meaningful, whi
4545
- Intelligent [version bumping](https://commitizen-tools.github.io/commitizen/commands/bump/) using [Semantic Versioning][semver]
4646
- Automatic [keep a changelog][keepchangelog] generation
4747
- Built-in commit validation with pre-commit hooks
48-
- [Customizable](https://commitizen-tools.github.io/commitizen/customization/) commit rules and templates
48+
- [Customizable](https://commitizen-tools.github.io/commitizen/customization/config_file/) commit rules and templates
4949
- Multi-format version file support
5050
- Custom rules and plugins via pip
5151

@@ -174,7 +174,7 @@ You can customize:
174174

175175
- [Version files](https://commitizen-tools.github.io/commitizen/commands/bump/#version_files)
176176
- [Version scheme](https://commitizen-tools.github.io/commitizen/commands/bump/#version_scheme)
177-
- [Version provider](https://commitizen-tools.github.io/commitizen/config/#version-providers)
177+
- [Version provider](https://commitizen-tools.github.io/commitizen/config/version_provider/)
178178

179179
For all available options, see the [bump command documentation](https://commitizen-tools.github.io/commitizen/commands/bump/).
180180

@@ -249,7 +249,7 @@ Commitizen provides a comprehensive CLI with various commands. Here's the comple
249249
250250
- [Conventional Commits Specification][conventional_commits]
251251
- [Exit Codes Reference](https://commitizen-tools.github.io/commitizen/exit_codes/)
252-
- [Configuration Guide](https://commitizen-tools.github.io/commitizen/config/)
252+
- [Configuration Guide](https://commitizen-tools.github.io/commitizen/config/configuration_file/)
253253
- [Command Documentation](https://commitizen-tools.github.io/commitizen/commands/init/)
254254
255255
### Getting Help

docs/external_links.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
- [Python Table Manners - Commitizen: 規格化 commit message](https://blog.wei-lee.me/posts/tech/2020/03/python-table-manners-commitizen/) (Written in Traditional Mandarin)
1515
- [Automating semantic release with commitizen](https://woile.dev/posts/automating-semver-releases-with-commitizen/) (English)
1616
- [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)
17-
- [Continuous delivery made easy (in Python)](https://medium.com/dev-genius/continuous-delivery-made-easy-in-python-c085e9c82e69)
17+
- [Continuous delivery made easy (in Python)](https://blog.devgenius.io/continuous-delivery-made-easy-in-python-c085e9c82e69)
1818

1919
[automatizando]: https://youtu.be/t3aE2M8UPBo

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ If you would like to learn more about both schemes, there are plenty of good res
120120
- [API Versioning from Stripe](https://stripe.com/blog/api-versioning)
121121
- [Discussion about pip's use of CalVer](https://github.com/pypa/pip/issues/5645#issuecomment-407192448)
122122
- [Git Version Numbering](https://code.erpenbeck.io/git/2021/12/16/git-version-numbering/)
123-
- [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)
123+
- [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)
124124
- [Semver Will Not Save You](https://hynek.me/articles/semver-will-not-save-you/)
125125
- [Why I Don't Like SemVer](https://snarky.ca/why-i-dont-like-semver/)
126126

docs/tutorials/github_actions.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,14 @@ jobs:
113113
poetry install
114114
- name: Build and publish
115115
env:
116-
PYPI_USERNAME: __token__
117-
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
118-
run: |
119-
./scripts/publish
116+
POETRY_HTTP_BASIC_PYPI_USERNAME: __token__
117+
POETRY_HTTP_BASIC_PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
118+
run: poetry publish --build
120119
```
121120

122-
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)
121+
Notice that we are using poetry to publish the package.
122+
123+
123124
You can also use [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) to publish your package.
124125

125126
Push the changes and that's it.

docs/tutorials/writing_commits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ Emojis may be added as well (e.g., see [cz-emoji][cz_emoji]), which requires the
4646

4747
[customization]: ../customization/config_file.md
4848
[conventional_commits]: https://www.conventionalcommits.org
49-
[cz_emoji]: https://commitizen-tools.github.io/commitizen/third-party-commitizen/#cz-emoji
49+
[cz_emoji]: https://commitizen-tools.github.io/commitizen/third-party-plugins/cz-emoji/
5050
[configuration]: ../config/commit.md#encoding
5151
[breaking-change-config]: ../config/commit.md#breaking_change_exclamation_in_title

0 commit comments

Comments
 (0)