ci(github-actions): bump action versions (checkout@v6, cache@v5, upload-artifact@v6) #25
Conversation
…resh docs - Add cspell custom dictionary and extend cspell.config.yaml (ignorePaths, dictionaryDefinitions, and words) to cover project-specific terms. - Introduce markdownlint config (.mdlrc, .mdl_style.rb) for consistent MD style. - Update .pre-commit-config.yaml: add check-merge-conflict, check-json, pretty-format-json, mixed-line-ending; scope/tune check-yaml; add requirements-txt-fixer and no-commit-to-branch. - Normalize and reword documentation across docs/* and README.md (ordered lists, headings, examples, and terminology). - Adjust docs/requirements.txt dependency pinning for mkdocs-material. Rationale: improve docs quality and consistency; enforce formatting and spelling in CI/pre-commit; reduce noise from false positives.
- Deduplicate `mixed-line-ending` entry in `.pre-commit-config.yaml`. - Prevents the hook from running twice and reduces noise in commit output. - No code changes; configuration-only update.
- Deduplicate `mixed-line-ending` entry in `.pre-commit-config.yaml`. - Prevents the hook from running twice and reduces noise in commit output. - No code changes; configuration-only update.
…ad-artifact@v6) - Update actions/cache to v5 in: - .github/lint.yml - .github/workflows/pre-commit.yml - .github/workflows/security.yml - .github/workflows/test.yml - Update actions/checkout to v6 in .github/workflows/go.yml - Update actions/upload-artifact to v6 in .github/workflows/test.yml Rationale: keep CI dependencies current and secure; align with latest maintained releases; no workflow behavior changes intended.
There was a problem hiding this comment.
Pull request overview
This PR updates GitHub Actions dependencies to their latest versions (actions/cache@v5, actions/checkout@v6, actions/upload-artifact@v6) and makes extensive documentation formatting changes. However, the documentation changes appear to be unintentional side effects rather than deliberate improvements, as the PR title and description focus solely on CI dependency updates.
Key Changes
- Updated GitHub Actions cache from v4 to v5 in workflow files
- Updated actions/checkout from v4 to v6 in go.yml workflow
- Updated actions/upload-artifact from v5 to v6 in test.yml workflow
- Modified markdown list numbering throughout documentation files from sequential numbering to all items numbered as "1"
- Added markdown linting configuration files (.mdlrc and .mdl_style.rb)
- Expanded cspell configuration with additional ignore paths and dictionary words
- Reorganized VS Code settings and pre-commit hooks
Reviewed changes
Copilot reviewed 24 out of 25 changed files in this pull request and generated 37 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/test.yml | Updated actions/cache to v5 and actions/upload-artifact to v6 |
| .github/workflows/security.yml | Updated actions/cache to v5 |
| .github/workflows/pre-commit.yml | Updated actions/cache to v5 |
| .github/workflows/go.yml | Updated actions/checkout to v6 |
| .github/lint.yml | Updated actions/cache to v5 |
| docs/docs/index.md | Changed list numbering from sequential to all "1" and removed question mark from section title |
| docs/docs/getting-started/quickstart.md | Changed list numbering from sequential to all "1" |
| docs/docs/features/stack-traces.md | Changed list numbering from sequential to all "1" |
| docs/docs/features/observability.md | Changed list numbering from sequential to all "1" |
| docs/docs/features/error-groups.md | Changed list numbering from sequential to all "1" |
| docs/docs/features/error-creation.md | Changed list numbering from sequential to all "1" |
| docs/docs/features/circuit-breaker.md | Changed list numbering from sequential to all "1" |
| docs/docs/api/overview.md | Changed list numbering from sequential to all "1" |
| docs/docs/advanced/performance.md | Changed list numbering from sequential to all "1" |
| docs/docs/advanced/error-types.md | Changed list numbering from sequential to all "1" |
| docs/docs/advanced/error-strategies.md | Changed list numbering from sequential to all "1" |
| README.md | Changed list numbering from sequential to all "1" |
| docs/requirements.txt | Reordered dependencies alphabetically |
| cspell.config.yaml | Added extensive ignore paths and expanded dictionary |
| .vscode/settings.json | Removed cSpell words configuration |
| .vscode/extensions.json | Reformatted JSON structure |
| .pre-commit-config.yaml | Added new hooks and reordered existing ones |
| .mdlrc | Added markdown linting configuration reference |
| .mdl_style.rb | Added markdown linting style rules with syntax error |
| .cspell/custom-dictionary.txt | Created custom dictionary file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. Explore [Logging Integration](../features/logging.md) | ||
| 1. Study [Advanced Usage](../advanced/performance.md) | ||
| 1. Check out complete [Examples](../examples/basic.md) |
There was a problem hiding this comment.
The numbered list has been changed from sequential numbering (1, 2, 3, 4) to all items numbered as "1". Sequential numbering improves source code readability and should be preserved.
| ``` | ||
|
|
||
| 3. **Reuse Pools**: | ||
| 1. **Reuse Pools**: |
There was a problem hiding this comment.
The item numbering has been changed from "3" to "1", breaking the sequential numbering of the parent list. This item should maintain its original numbering (3) to preserve the logical sequence.
| 1. **Reuse Pools**: | |
| 3. **Reuse Pools**: |
| 1. **Performance**: Error handling shouldn't become a bottleneck in your application | ||
| 1. **Developer Experience**: Clear, consistent patterns that make error handling both powerful and approachable | ||
| 1. **Flexibility**: Easy integration with existing systems and adaptable to different needs | ||
| 1. **Production Readiness**: Built-in support for logging, monitoring, and debugging |
There was a problem hiding this comment.
The numbered list has been changed from sequential numbering (1, 2, 3, 4, 5) to all items numbered as "1". Sequential numbering improves source code readability and should be preserved.
| 1. **Performance**: Error handling shouldn't become a bottleneck in your application | |
| 1. **Developer Experience**: Clear, consistent patterns that make error handling both powerful and approachable | |
| 1. **Flexibility**: Easy integration with existing systems and adaptable to different needs | |
| 1. **Production Readiness**: Built-in support for logging, monitoring, and debugging | |
| 2. **Performance**: Error handling shouldn't become a bottleneck in your application | |
| 3. **Developer Experience**: Clear, consistent patterns that make error handling both powerful and approachable | |
| 4. **Flexibility**: Easy integration with existing systems and adaptable to different needs | |
| 5. **Production Readiness**: Built-in support for logging, monitoring, and debugging |
| ``` | ||
|
|
||
| 2. **Retry Patterns**: | ||
| 1. **Retry Patterns**: |
There was a problem hiding this comment.
The item numbering has been changed from "2" to "1", breaking the sequential numbering of the parent list. This item should maintain its original numbering (2) to preserve the logical sequence.
| 1. **Retry Patterns**: | |
| 2. **Retry Patterns**: |
| 1. Install [**GitVersion**](https://github.com/GitTools/GitVersion). | ||
| 1. Install [**Make**](https://www.gnu.org/software/make/), follow the procedure for your OS. | ||
| 1. **Set up the toolchain:** | ||
|
|
||
| ```bash | ||
| make prepare-toolchain | ||
| ``` | ||
|
|
||
| 5. Initialize `pre-commit` (strongly recommended to create a virtual env, using for instance [PyEnv](https://github.com/pyenv/pyenv)) and its hooks: | ||
| 1. Initialize `pre-commit` (strongly recommended to create a virtual env, using for instance [PyEnv](https://github.com/pyenv/pyenv)) and its hooks: |
There was a problem hiding this comment.
The numbered list has been changed from sequential numbering (1, 2, 3, 4, 5) to all items numbered as "1". Sequential numbering improves source code readability and should be preserved.
| ``` | ||
|
|
||
| 5. **Handle Circuit Breaking**: Protect your system from cascading failures: | ||
| 1. **Handle Circuit Breaking**: Protect your system from cascading failures: |
There was a problem hiding this comment.
The item numbering has been changed from "5" to "1", breaking the sequential numbering of the parent list. This item should maintain its original numbering (5) to preserve the logical sequence.
| 1. **Handle Circuit Breaking**: Protect your system from cascading failures: | |
| 5. **Handle Circuit Breaking**: Protect your system from cascading failures: |
| # default in next version, remove then | ||
| rule 'MD007', :indent => 3 | ||
|
|
||
| rule "MD029", style => "one" |
There was a problem hiding this comment.
The Ruby hash syntax is incorrect. The parameter name should be prefixed with a colon. The correct syntax should be ':style => "one"' or 'style: "one"' (modern Ruby syntax).
| rule "MD029", style => "one" | |
| rule "MD029", :style => "one" |
| 1. **Performance Overhead**: Many error handling libraries introduce significant memory and CPU overhead | ||
| 1. **Memory Management**: Poor memory management in error handling leads to increased GC pressure | ||
| 1. **Inconsistent Logging**: Different parts of applications handle error logging differently | ||
| 1. **Missing Stack Traces**: Getting meaningful, filterable stack traces is challenging | ||
| 1. **Circuit Breaking**: Protecting systems from cascading failures requires complex implementation |
There was a problem hiding this comment.
The numbered list has been changed from sequential numbering (1, 2, 3, 4, 5, 6) to all items numbered as "1". While Markdown renderers typically handle this automatically, using sequential numbers improves source code readability and makes it clearer that these are distinct, ordered items. The original sequential numbering should be preserved.
| 1. **Observability Gaps**: Missing built-in support for metrics and tracing in error handling | ||
| 1. **Recovery Guidance**: Errors without actionable remediation suggestions | ||
| 1. **Type Safety**: Metadata handling without compile-time guarantees | ||
| 1. **Standard Library Integration**: Poor integration with `errors.Join` and modern error patterns | ||
| 1. **Serialization Complexity**: Difficulty in structured error export for monitoring systems |
There was a problem hiding this comment.
Similar to the previous list, this numbered list has been changed from sequential numbering (1, 2, 3, 4, 5, 6) to all items numbered as "1". Sequential numbering should be preserved for better source code readability.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Pull request was closed
Rationale: keep CI dependencies current and secure; align with latest maintained releases; no workflow behavior changes intended.