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

Update README.md #55

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Thanhphan1147
Copy link
Collaborator

@Thanhphan1147 Thanhphan1147 commented Dec 20, 2024

Update README to follow the template defined at : https://github.com/canonical/is-charms-template-repo

Checklist

@Thanhphan1147 Thanhphan1147 requested a review from a team as a code owner December 20, 2024 14:42
@Thanhphan1147 Thanhphan1147 added documentation Improvements or additions to documentation trivial This is a trivial PR labels Dec 20, 2024
Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the README!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Thanhphan1147 and others added 3 commits December 20, 2024 16:35
README.md Outdated Show resolved Hide resolved
Co-authored-by: Erin Conley <[email protected]>
erinecon
erinecon previously approved these changes Jan 6, 2025
Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the README!

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

license-eye has checked 62 files.

Valid Invalid Ignored Fixed
0 21 41 0
Click to see the invalid file list
  • charmcraft.yaml
  • generate-src-docs.sh
  • pyproject.toml
  • src/agent_observer.py
  • src/charm.py
  • src/charm_state.py
  • src/service.py
  • templates/jenkins_agent.sh
  • tests/init.py
  • tests/conftest.py
  • tests/integration/init.py
  • tests/integration/conftest.py
  • tests/integration/pre_run_script.sh
  • tests/integration/test_agent.py
  • tests/unit/init.py
  • tests/unit/conftest.py
  • tests/unit/test_agent.py
  • tests/unit/test_charm.py
  • tests/unit/test_service.py
  • tests/unit/test_state.py
  • tox.ini
Use this command to fix any missing license headers
```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

Copy link
Contributor

Test coverage for c75e8dd

Name                    Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------
src/agent_observer.py      41      0      4      0   100%
src/charm.py               61      0     10      0   100%
src/charm_state.py         58      4      4      1    92%   114, 172-174
src/service.py             93      5      8      4    91%   95-97, 128, 159, 196->200, 198->196
-------------------------------------------------------------------
TOTAL                     253      9     26      5    95%

Static code analysis report

Run started:2025-01-17 16:21:55.369053

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 1133
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Libraries: Out of sync trivial This is a trivial PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants