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 #204

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

Update README.md #204

wants to merge 3 commits into 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 15:12
@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.

Thank you for updating the README!

## Project and community
## Get started

To begin, refer to the [Getting Started](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started) tutorial for step-by-step instructions.
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
To begin, refer to the [Getting Started](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started) tutorial for step-by-step instructions.
To begin, refer to the [tutorial](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started) for step-by-step instructions.

README.md Outdated Show resolved Hide resolved
## Learn more

- [Read more](https://charmhub.io/jenkins-k8s/docs)

Copy link
Contributor

Choose a reason for hiding this comment

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

  • Is there an official website for Jenkins that is worth listing here?
  • Similarly, are there any developer docs for Jenkins?
  • Finally, could you add an item [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) to this list?


Run the following command:
* [Issues](https://github.com/canonical/jenkins-k8s-operator/issues) <!--Link to GitHub issues (if applicable)-->
* [Contributing](https://charmhub.io/jenkins-k8s#contributing-to-this-documentation) <!--Link to any contribution guides-->
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Test coverage for cd30bb2

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/actions.py         29      0      4      0   100%
src/agent.py          119      0     20      0   100%
src/auth_proxy.py      52      0      8      0   100%
src/charm.py           89      0     10      0   100%
src/cos.py             20      0      0      0   100%
src/ingress.py         16      0      4      0   100%
src/jenkins.py        377      0     50      0   100%
src/pebble.py          25      0      0      0   100%
src/state.py          109      0     16      0   100%
src/timerange.py       30      0      4      0   100%
---------------------------------------------------------------
TOTAL                 866      0    116      0   100%

Static code analysis report

Run started:2025-01-17 16:36:36.466385

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 7614
  Total lines skipped (#nosec): 6
  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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants