Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add codespell: pre-commit, workflow (to just detect); make it fix found already present typos #4035

Draft
wants to merge 7 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changes/1.1.0.json
@@ -1,7 +1,7 @@
[
{
"category": "``EC2.Vpc.filter``",
"description": "Fix issue with clobbering of ``Filtering`` paramter. (`issue 154 <https://github.com/boto/boto3/pull/154>`__)",
"description": "Fix issue with clobbering of ``Filtering`` parameter. (`issue 154 <https://github.com/boto/boto3/pull/154>`__)",
"type": "bugfix"
}
]
2 changes: 1 addition & 1 deletion .changes/1.13.8.json
Expand Up @@ -12,6 +12,6 @@
{
"category": "Endpoints",
"description": "[``botocore``] Improved endpoint resolution for clients with unknown regions",
"type": "enchancement"
"type": "enhancement"
}
]
2 changes: 1 addition & 1 deletion .changes/1.18.18.json
Expand Up @@ -7,6 +7,6 @@
{
"category": "Client",
"description": "[``botocore``] Improve client performance by caching _alias_event_name on EventAliaser",
"type": "enchancement"
"type": "enhancement"
}
]
2 changes: 1 addition & 1 deletion .changes/1.18.64.json
Expand Up @@ -7,7 +7,7 @@
{
"category": "AWSCRT",
"description": "[``botocore``] Upgrade awscrt extra to 0.12.5",
"type": "enchancement"
"type": "enhancement"
},
{
"category": "``ivs``",
Expand Down
2 changes: 1 addition & 1 deletion .changes/1.19.5.json
Expand Up @@ -37,6 +37,6 @@
{
"category": "``s3``",
"description": "TransferConfig now supports the `max_bandwidth` argument.",
"type": "enchancement"
"type": "enhancement"
}
]
2 changes: 1 addition & 1 deletion .changes/1.20.53.json
Expand Up @@ -11,7 +11,7 @@
},
{
"category": "``pinpoint``",
"description": "[``botocore``] This SDK release adds a new paramater creation date for GetApp and GetApps Api call",
"description": "[``botocore``] This SDK release adds a new parameter creation date for GetApp and GetApps Api call",
"type": "api-change"
},
{
Expand Down
2 changes: 1 addition & 1 deletion .changes/1.26.1.json
Expand Up @@ -6,7 +6,7 @@
},
{
"category": "``s3control``",
"description": "[``botocore``] S3 on Outposts launches support for Lifecycle configuration for Outposts buckets. With S3 Lifecycle configuration, you can mange objects so they are stored cost effectively. You can manage objects using size-based rules and specify how many noncurrent versions bucket will retain.",
"description": "[``botocore``] S3 on Outposts launches support for Lifecycle configuration for Outposts buckets. With S3 Lifecycle configuration, you can manage objects so they are stored cost effectively. You can manage objects using size-based rules and specify how many noncurrent versions bucket will retain.",
"type": "api-change"
},
{
Expand Down
2 changes: 1 addition & 1 deletion .changes/1.26.10.json
Expand Up @@ -16,7 +16,7 @@
},
{
"category": "``greengrassv2``",
"description": "[``botocore``] Adds new parent target ARN paramater to CreateDeployment, GetDeployment, and ListDeployments APIs for the new subdeployments feature.",
"description": "[``botocore``] Adds new parent target ARN parameter to CreateDeployment, GetDeployment, and ListDeployments APIs for the new subdeployments feature.",
"type": "api-change"
},
{
Expand Down
2 changes: 1 addition & 1 deletion .changes/1.26.81.json
Expand Up @@ -36,7 +36,7 @@
},
{
"category": "``omics``",
"description": "[``botocore``] Minor model changes to accomodate batch imports feature",
"description": "[``botocore``] Minor model changes to accommodate batch imports feature",
"type": "api-change"
}
]
2 changes: 1 addition & 1 deletion .changes/1.28.64.json
Expand Up @@ -6,7 +6,7 @@
},
{
"category": "``drs``",
"description": "[``botocore``] Updated exsiting API to allow AWS Elastic Disaster Recovery support of launching recovery into existing EC2 instances.",
"description": "[``botocore``] Updated existing API to allow AWS Elastic Disaster Recovery support of launching recovery into existing EC2 instances.",
"type": "api-change"
},
{
Expand Down
2 changes: 1 addition & 1 deletion .changes/1.33.3.json
Expand Up @@ -16,7 +16,7 @@
},
{
"category": "``opensearch``",
"description": "[``botocore``] Launching Amazon OpenSearch Service support for new zero-ETL integration with Amazon S3. Customers can now manage their direct query data sources to Amazon S3 programatically",
"description": "[``botocore``] Launching Amazon OpenSearch Service support for new zero-ETL integration with Amazon S3. Customers can now manage their direct query data sources to Amazon S3 programmatically",
"type": "api-change"
},
{
Expand Down
2 changes: 1 addition & 1 deletion .changes/1.34.43.json
Expand Up @@ -36,7 +36,7 @@
},
{
"category": "``sagemaker``",
"description": "[``botocore``] This release adds a new API UpdateClusterSoftware for SageMaker HyperPod. This API allows users to patch HyperPod clusters with latest platform softwares.",
"description": "[``botocore``] This release adds a new API UpdateClusterSoftware for SageMaker HyperPod. This API allows users to patch HyperPod clusters with latest platform software.",
"type": "api-change"
},
{
Expand Down
2 changes: 1 addition & 1 deletion .changes/1.5.21.json
Expand Up @@ -32,6 +32,6 @@
{
"category": "Paginator",
"description": "[``botocore``] Added paginators for a number of services where the result key is unambiguous.",
"type": "enhancment"
"type": "enhancement"
}
]
2 changes: 1 addition & 1 deletion .changes/1.7.66.json
Expand Up @@ -32,7 +32,7 @@
{
"category": "Timestamp Serialization",
"description": "[``botocore``] Support explicit timestamp serialization per timestamp shape.",
"type": "enhancment"
"type": "enhancement"
},
{
"category": "``glacier``",
Expand Down
4 changes: 2 additions & 2 deletions .changes/1.9.0.json
Expand Up @@ -11,12 +11,12 @@
},
{
"category": "Events",
"description": "[``botocore``] This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://botocore.amazonaws.com/v1/documentation/api/latest/index.html#upgrade-notes>`_ to determine if you are impacted and how to proceed if you are.",
"description": "[``botocore``] This migrates the event system to using service ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://botocore.amazonaws.com/v1/documentation/api/latest/index.html#upgrade-notes>`_ to determine if you are impacted and how to proceed if you are.",
"type": "feature"
},
{
"category": "Events",
"description": "This migrates the event system to using sevice ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/upgrading.html>`_ to determine if you are impacted and how to proceed if you are.",
"description": "This migrates the event system to using service ids instead of either client name or endpoint prefix. This prevents issues that might arise when a service changes their endpoint prefix, also fixes a long-standing bug where you could not register an event to a particular service if it happened to share its endpoint prefix with another service (e.g. ``autoscaling`` and ``application-autoscaling`` both use the endpoint prefix ``autoscaling``). Please see the `upgrade notes <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/upgrading.html>`_ to determine if you are impacted and how to proceed if you are.",
"type": "feature"
}
]
23 changes: 23 additions & 0 deletions .github/workflows/codespell.yml
@@ -0,0 +1,23 @@
# Codespell configuration is within pyproject.toml
---
name: Codespell

on:
push:
branches: [develop]
pull_request:
branches: [develop]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Codespell
uses: codespell-project/actions-codespell@v2
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Expand Up @@ -24,3 +24,10 @@ repos:
rev: 6.1.0
hooks:
- id: flake8
- repo: https://github.com/codespell-project/codespell
# Configuration for codespell is in pyproject.toml
rev: v2.2.6
hooks:
- id: codespell
additional_dependencies:
- tomli