Skip to content

Commit

Permalink
Remove update_sha and use the latest commit for pkgs dependencies, up…
Browse files Browse the repository at this point in the history
…date README for code style check and unit test.
  • Loading branch information
zzhlogin committed Jan 5, 2024
1 parent ff6e1e2 commit ac81e4e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 70 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ name: AWS Distro Tests
on:
push:
pull_request:
env:
CORE_REPO_SHA: da48e0b131ff34ff382b7d1206f71b2e31929cab
CONTRIB_REPO_SHA: 7c12ad9844ac179e3f6a493491707a9bafd06f6b

jobs:
misc:
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,28 @@ This project provide AWS Distro base on [OpenTelemetry Python Contrib](https://g
preconfigured for use with AWS services. Please check out that project too to get a better
understanding of the underlying internals.

## Code Style Check

This package applys code style check automatically when created a push/pull request to the project repository. You can apply style check locally before submitting the PR by following:
1. Install related packages:
```sh
pip install isort pylint black flake8
```
2. Check code style errors:
```sh
python scripts/eachdist.py lint --check-only
```
3. Apply the fix for the errors automatically:
```sh
python scripts/eachdist.py lint
```

## Unit test
This package detects all the unit tests defined in folder with naming "tests"/"test" under the same directory as pyproject.toml file. Please make sure to add unit test everytime a new feature added.
The workflow will run the test tox environment automatically whenever there is a push/pull request. Please make sure you install the related package needed for the unit tests in `commands_pre`.

If you want to test a specific component/feature, please add a new environment in tox.ini file, and add related workflow as needed.

## License

This project is licensed under the Apache-2.0 License.
Expand Down
67 changes: 0 additions & 67 deletions scripts/update_sha.py

This file was deleted.

0 comments on commit ac81e4e

Please sign in to comment.