-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
29 changed files
with
498 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @fabasoad |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
custom: ["https://en.cryptobadges.io/donate/145HwyQAcv4vrzUumJhu7nWGAVBysX9jJH"] | ||
github: ["fabasoad"] | ||
ko_fi: fabasoad | ||
liberapay: fabasoad |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "" | ||
labels: bug | ||
assignees: fabasoad | ||
--- | ||
|
||
## Describe the bug | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
## Steps to Reproduce | ||
|
||
1. Run '...' | ||
2. See error | ||
|
||
## Expected behavior | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
## Actual behavior | ||
|
||
A clear and concise description of what is happening now. | ||
|
||
## Screenshots | ||
|
||
If applicable, add screenshots to help explain your problem. | ||
|
||
## Technical information (please complete the following information) | ||
|
||
- OS: [e.g. Windows 10 Enterprise v.1909 (OS Build 18363.720)] | ||
- `sh-logging` version [e.g. 0.1.0] | ||
|
||
## Additional context | ||
|
||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: "" | ||
labels: enhancement | ||
assignees: fabasoad | ||
--- | ||
|
||
## Is your feature request related to a problem? Please describe | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated | ||
when [...] | ||
|
||
## Describe the solution you'd like | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
## Describe alternatives you've considered | ||
|
||
A clear and concise description of any alternative solutions or features you've | ||
considered. | ||
|
||
## Additional context | ||
|
||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "monthly" | ||
reviewers: | ||
- "fabasoad" | ||
labels: | ||
- "dependencies" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
<!-- markdownlint-disable-file MD041 --> | ||
|
||
## Pull request checklist | ||
|
||
Please check if your PR fulfills the following requirements: | ||
|
||
- [ ] I have read the [CONTRIBUTING](https://github.com/fabasoad/sh-logging/blob/main/CONTRIBUTING.md) | ||
doc. | ||
- [ ] Tests for the changes have been added (for bug fixes / features). | ||
- [ ] Docs have been reviewed and added / updated if needed (for bug fixes / features). | ||
|
||
## Pull request type | ||
|
||
<!-- Please do not submit updates to dependencies unless it fixes an issue. --> | ||
|
||
<!-- Please try to limit your pull request to one type, submit multiple pull | ||
requests if needed. --> | ||
|
||
Please check the type of change your PR introduces: | ||
|
||
- [ ] Bugfix | ||
- [ ] Feature | ||
- [ ] Code style update (formatting, renaming) | ||
- [ ] Refactoring (no functional changes, no api changes) | ||
- [ ] Build related changes | ||
- [ ] Documentation content changes | ||
- [ ] Other (please describe): | ||
|
||
## What is the current behavior | ||
|
||
<!-- Please describe the current behavior that you are modifying, or link to a | ||
relevant issue. --> | ||
|
||
## What is the new behavior | ||
|
||
<!-- Please describe the behavior or changes that are being added by this PR. --> | ||
|
||
- | ||
- | ||
- | ||
|
||
## Does this introduce a breaking change | ||
|
||
- [ ] Yes | ||
- [ ] No | ||
|
||
<!-- If this introduces a breaking change, please describe the impact and | ||
migration path for existing applications below. --> | ||
|
||
## Other information | ||
|
||
<!-- Any other information that is important to this PR such as screenshots of | ||
how the component looks before and after the change. --> | ||
<!-- This document was adapted from the open-source [appium/appium](https://github.com/appium/appium/blob/master/.github/PULL_REQUEST_TEMPLATE.md) | ||
repository. --> | ||
|
||
--- | ||
|
||
Closes #{IssueNumber} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
name: Linting | ||
|
||
on: # yamllint disable-line rule:truthy | ||
pull_request: {} | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
pre-commit: | ||
name: Pre-commit | ||
uses: fabasoad/reusable-workflows/.github/workflows/wf-pre-commit.yml@main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: Release | ||
|
||
on: # yamllint disable-line rule:truthy | ||
push: | ||
tags: | ||
- "v*.*.*" | ||
|
||
jobs: | ||
github: | ||
name: GitHub | ||
uses: fabasoad/reusable-workflows/.github/workflows/wf-github-release.yml@main | ||
with: | ||
bump-tags: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Security | ||
|
||
on: # yamllint disable-line rule:truthy | ||
pull_request: {} | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
sast: | ||
name: SAST | ||
permissions: | ||
contents: read | ||
security-events: write | ||
uses: fabasoad/reusable-workflows/.github/workflows/wf-security-sast.yml@main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
name: Labels | ||
|
||
on: # yamllint disable-line rule:truthy | ||
push: | ||
branches: | ||
- main | ||
workflow_dispatch: {} | ||
|
||
jobs: | ||
maintenance: | ||
name: Maintenance | ||
uses: fabasoad/reusable-workflows/.github/workflows/wf-sync-labels.yml@main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
name: License | ||
|
||
on: # yamllint disable-line rule:truthy | ||
schedule: | ||
- cron: "0 5 1 1 *" | ||
|
||
jobs: | ||
maintenance: | ||
name: Maintenance | ||
uses: fabasoad/reusable-workflows/.github/workflows/wf-update-license.yml@main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
default: true | ||
MD013: | ||
code_blocks: false | ||
tables: false | ||
MD041: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
default_install_hook_types: ["pre-commit", "pre-push"] | ||
default_stages: ["commit", "push"] | ||
minimum_pre_commit_version: 2.18.0 | ||
repos: | ||
# Security | ||
- repo: https://github.com/Yelp/detect-secrets | ||
rev: v1.5.0 | ||
hooks: | ||
- id: detect-secrets | ||
- repo: https://github.com/gitleaks/gitleaks | ||
rev: v8.18.4 | ||
hooks: | ||
- id: gitleaks | ||
- repo: https://github.com/fabasoad/pre-commit-grype | ||
rev: v0.3.2 | ||
hooks: | ||
- id: grype-dir | ||
args: | ||
- --grype-args=--by-cve --fail-on=low | ||
- --hook-args=--log-level debug | ||
stages: ["push"] | ||
# Markdown | ||
- repo: https://github.com/igorshubovych/markdownlint-cli | ||
rev: v0.41.0 | ||
hooks: | ||
- id: markdownlint-fix | ||
stages: ["commit"] | ||
# Shell | ||
- repo: https://github.com/openstack/bashate | ||
rev: 2.1.1 | ||
hooks: | ||
- id: bashate | ||
args: ["-i", "E003,E006"] | ||
stages: ["commit"] | ||
# Yaml | ||
- repo: https://github.com/adrienverge/yamllint | ||
rev: v1.35.1 | ||
hooks: | ||
- id: yamllint | ||
stages: ["push"] | ||
# GitHub Actions | ||
- repo: https://github.com/rhysd/actionlint | ||
rev: v1.7.1 | ||
hooks: | ||
- id: actionlint | ||
args: ["-pyflakes="] | ||
stages: ["commit"] | ||
# Other | ||
- repo: https://github.com/pre-commit/mirrors-prettier | ||
rev: v3.1.0 | ||
hooks: | ||
- id: prettier | ||
stages: ["commit"] | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v4.6.0 | ||
hooks: | ||
- id: check-executables-have-shebangs | ||
- id: check-shebang-scripts-are-executable | ||
- id: check-merge-conflict | ||
- id: check-json | ||
stages: ["push"] | ||
- id: detect-private-key | ||
- id: end-of-file-fixer | ||
- id: mixed-line-ending | ||
args: ["--fix=lf"] | ||
- id: no-commit-to-branch | ||
stages: ["commit"] | ||
- id: trailing-whitespace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
extends: default | ||
|
||
rules: | ||
comments: | ||
min-spaces-from-content: 1 | ||
line-length: | ||
max: 170 | ||
level: error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Contributing guidance | ||
|
||
We love your input! We want to make contributing to this project as easy and | ||
transparent as possible, whether it's: | ||
|
||
- Reporting a bug | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
- Proposing new features | ||
- Becoming a maintainer | ||
|
||
## We develop with GitHub | ||
|
||
We use GitHub to host code, to track issues and feature requests, as well as | ||
accept pull requests. | ||
|
||
## We use GitHub flow, so all code changes happen through pull requests | ||
|
||
Pull requests are the best way to propose changes to the codebase (we use | ||
[GitHub flow](https://guides.github.com/introduction/flow/index.html)). We | ||
actively welcome your pull requests: | ||
|
||
1. Fork the repo and create your branch from `main`. | ||
2. If you've added code that should be tested, add tests. | ||
3. If you've changed APIs, update the documentation. | ||
4. Ensure the test suite passes. | ||
5. Make sure your code lints. | ||
6. Issue that pull request! | ||
|
||
## Any contributions you make will be under the MIT Software License | ||
|
||
In short, when you submit code changes, your submissions are understood to be | ||
under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers | ||
the project. Feel free to contact the maintainers if that's a concern. | ||
|
||
## Report bugs using [GitHub Issues](https://github.com/fabasoad/pre-commit-grype/issues) | ||
|
||
We use GitHub issues to track public bugs. Report a bug by opening a new issue. | ||
It's that easy! | ||
|
||
## Create issue using provided GitHub issue templates | ||
|
||
This repository has issue templates for bug report and feature request. Please | ||
use them to create an issue and fill all required fields. | ||
|
||
## Use a consistent coding style | ||
|
||
Please follow all the rules from [this](https://google.github.io/styleguide/shellguide.html) | ||
great guide provided by Google for coding style. | ||
|
||
## License | ||
|
||
By contributing, you agree that your contributions will be licensed under its | ||
MIT License. | ||
|
||
## References | ||
|
||
This document was adapted from the open-source contribution guidelines provided | ||
by [briandk](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Yevhen Fabizhevskyi | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.