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

ISD-2551 update README for jenkins-agent-k8s #52

Open
wants to merge 8 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:56
@Thanhphan1147 Thanhphan1147 added the documentation Improvements or additions to documentation label 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 this 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
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

Lint checks failed for 838d908

```

tests/integration/conftest.py:138: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:138: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:191: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:191: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
Found 4 errors in 1 file (checked 20 source files)

Copy link
Contributor

Test coverage for 838d908

Name              Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------
src/agent.py         60      0     12      0   100%
src/charm.py         57      0     10      0   100%
src/metadata.py       8      0      0      0   100%
src/pebble.py        23      0      0      0   100%
src/server.py        50      0     12      0   100%
src/state.py         66      1     10      1    97%   99
-------------------------------------------------------------
TOTAL               264      1     44      1    99%

Static code analysis report

Run started:2024-12-20 15:38:37.770850

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 1669
  Total lines skipped (#nosec): 1
  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):

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.

One more nitpick and then should be good to go!

[see the charm's detailed documentation](https://charmhub.io/jenkins-agent-k8s).
* [Issues](https://github.com/canonical/jenkins-agent-k8s-operator/issues) <!--Link to GitHub issues (if applicable)-->
* [Contributing](https://charmhub.io/jenkins-agent-k8s/docs/how-to-contribute) <!--Link to any contribution guides-->
- [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)

The rendering looks a little strange with the -

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants