Skip to content

Commit bac564b

Browse files
apoclypsapoclyps
authored
ci: ensures typos are caught during CI (#257)
* ci: ensure that typos are handles during CI * docs: adds a pull request template * ci: adds typos to lint workflow * docs: adds issue templates
1 parent 5e69223 commit bac564b

15 files changed

Lines changed: 157 additions & 9 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: "[BUG] "
5+
labels: bug
6+
---
7+
8+
## Description
9+
10+
<!-- A clear and concise description of what the bug is -->
11+
12+
## Steps to Reproduce
13+
14+
1.
15+
2.
16+
3.
17+
18+
## Expected Behavior
19+
20+
<!-- What you expected to happen -->
21+
22+
## Actual Behavior
23+
24+
<!-- What actually happened -->
25+
26+
## Environment
27+
28+
- **OS**: <!-- e.g., macOS 14.0, Ubuntu 22.04, Windows 11 -->
29+
- **Python Version**: <!-- e.g., 3.9.7 -->
30+
- **Cloudsmith CLI Version**: <!-- Run `cloudsmith --version` -->
31+
32+
## Logs/Output
33+
34+
<!-- If applicable, add logs or command output -->
35+
36+
```
37+
paste logs here
38+
```
39+
40+
## Additional Context
41+
42+
<!-- Add any other context about the problem here -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Cloudsmith Documentation
4+
url: https://help.cloudsmith.io/docs/cloudsmith-cli
5+
about: Check the official Cloudsmith CLI documentation
6+
- name: Cloudsmith Support
7+
url: https://cloudsmith.io/support/
8+
about: Contact Cloudsmith support for account-specific issues

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
---
7+
8+
## Summary
9+
10+
<!-- A clear and concise description of the feature you'd like -->
11+
12+
## Problem Statement
13+
14+
<!-- What problem does this feature solve? -->
15+
16+
## Proposed Solution
17+
18+
<!-- Describe how you'd like this feature to work -->
19+
20+
## Alternatives Considered
21+
22+
<!-- Any alternative solutions or features you've considered -->
23+
24+
## Use Case
25+
26+
<!-- Describe your use case for this feature -->
27+
28+
## Additional Context
29+
30+
<!-- Add any other context, mockups, or screenshots about the feature request -->

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Question
3+
about: Ask a question about using the Cloudsmith CLI
4+
title: "[QUESTION] "
5+
labels: question
6+
---
7+
8+
## Question
9+
10+
<!-- Your question here -->
11+
12+
## Context
13+
14+
<!-- Any relevant context that might help answer your question -->
15+
16+
## What I've Tried
17+
18+
<!-- What have you already tried or researched? -->
19+
20+
## Environment (if relevant)
21+
22+
- **OS**:
23+
- **Python Version**:
24+
- **Cloudsmith CLI Version**:

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Breaking change
10+
- [ ] Documentation update
11+
- [ ] Refactoring
12+
- [ ] Other (please describe)
13+
14+
## Additional Notes
15+
16+
<!-- Any additional context or screenshots -->

‎.github/workflows/lint.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,14 @@ jobs:
126126
127127
- name: Run pylint
128128
run: pylint --rcfile=.pylintrc cloudsmith_cli
129+
130+
typos:
131+
name: Check for typos (typos)
132+
runs-on: ubuntu-latest
133+
steps:
134+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
135+
with:
136+
persist-credentials: false
137+
138+
- name: Run typos
139+
uses: crate-ci/typos@65120634e79d8374d1aa2f27e54baa0c364fff5a # v1.42.1

‎.pre-commit-config.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Pre-Commit hooks
22
# See: https://pre-commit.com/hooks.html
33
repos:
4+
45
- repo: https://github.com/pre-commit/pre-commit-hooks
56
rev: v5.0.0
67
hooks:
@@ -80,3 +81,8 @@ repos:
8081
"-sn", # Don't display the score
8182
"--rcfile=.pylintrc", # Link to your config file
8283
]
84+
85+
- repo: https://github.com/crate-ci/typos
86+
rev: v1.42.1
87+
hooks:
88+
- id: typos

‎.typos.toml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[default.extend-identifiers]
2+
# Proper names - do not correct
3+
Mno-hime = "Mno-hime"
4+
5+
[default.extend-words]
6+
# Proper names - do not correct
7+
hime = "hime"
8+
McClory = "McClory"
9+
mcclory = "mcclory"
10+
Clory = "Clory"
11+
repositor = "repositor"

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
114114
### Added
115115

116116
- Added `--force` parameter to the Auth command to be used in conjunction with `--token` to refresh tokens without interactive prompts i.e automatic.
117-
- Added `--force` parameter to the Tokens refresh command to automaticlly refresh without an interactive prompt.
117+
- Added `--force` parameter to the Tokens refresh command to automatically refresh without an interactive prompt.
118118

119119
## [1.8.5] - 2025-10-16
120120

‎cloudsmith_cli/cli/commands/metrics/entitlements.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def _print_metrics_table(opts, data):
7575
type=str,
7676
required=False,
7777
help=(
78-
"A comma seperated list of entitlement token identifiers (i.e. slug_perm) or "
78+
"A comma separated list of entitlement token identifiers (i.e. slug_perm) or "
7979
"token secrets. If a list is not specified then all entitlement tokens will "
8080
"be included for a given namespace or repository."
8181
),

0 commit comments

Comments
 (0)