From 2f2986e30cb5142fed3537545fe6d5898120a95e Mon Sep 17 00:00:00 2001 From: Ludovic Ortega Date: Fri, 6 Dec 2024 00:34:23 +0100 Subject: [PATCH 1/2] chore(docs): add repository documentation Signed-off-by: Ludovic Ortega --- .editorconfig | 16 ++++ .gitattributes | 1 + .github/CODE_OF_CONDUCT.md | 77 +++++++++++++++++++ .github/CONTRIBUTING.md | 43 +++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 21 +++++ .github/ISSUE_TEMPLATE/enhancement_request.md | 13 ++++ .github/SECURITY.md | 9 +++ .github/SUPPORT.md | 30 ++++++++ .github/pull_request_template.md | 23 ++++++ README.md | 31 ++++++++ charts/stirling-pdf/.helmignore | 25 ++++++ charts/stirling-pdf/README.md | 2 + charts/stirling-pdf/README.md.gotmpl | 2 + 13 files changed, 293 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement_request.md create mode 100644 .github/SECURITY.md create mode 100644 .github/SUPPORT.md create mode 100644 .github/pull_request_template.md create mode 100644 charts/stirling-pdf/.helmignore diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..cc939ff --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +# https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +charset = utf-8 +trim_trailing_whitespace = true +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true + +# YAML +[*.{yaml,yml}] +indent_size = 2 \ No newline at end of file diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..94f480d --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf \ No newline at end of file diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a73a889 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,77 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at contact@adminafk.fr. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..7788e79 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# How to contribute + +**First:** if you're unsure or afraid of _anything_, ask for help! You can +submit a work in progress (WIP) pull request, or file an issue with the parts +you know. We'll do our best to guide you in the right direction, and let you +know if there are guidelines we will need to follow. We want people to be able +to participate without fear of doing the wrong thing. + +## Commit message conventions + +We expect that all commit messages follow the +[Conventional Commits](https://www.conventionalcommits.org/) specification. +Please use the `feat`, `fix` or `chore` types for your commits. + +### Developer Certificate of Origin + +In order for a code change to be accepted, you'll also have to accept the +Developer Certificate of Origin (DCO). +It's very lightweight, and you can find it [here](https://developercertificate.org). +Accepting is accomplished by signing off on your commits, you can do this by +adding a `Signed-off-by` line to your commit message, like here: + +```commit +feat: add support for the XXXX operation + +Signed-off-by: Random Developer +``` + +Please use your real name and a valid email address. + +## Submitting changes + +### Updating `chart.yaml` + +Before creating a PR upgrade the `version` following [semver convention](https://semver.org/). +After that you can run the [`helm-docs`](https://github.com/norwoodj/helm-docs) command to regenerate the `README.md` (don't edit it manually). + +Now you can create a new PR against the `main` branch which must be based on the +project's [pull request template](.github/PULL_REQUEST_TEMPLATE.md). + +We usually squash all PRs commits on merge, and use the PR title as the commit +message. Therefore, the PR title should follow the +[Conventional Commits](https://www.conventionalcommits.org/) specification as well. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..7754e40 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,21 @@ +--- +name: '🐛 Bug report' +about: Report a bug encountered while operating +title: '' +labels: '🐛 bug' +assignees: '' +--- + + + +**What happened**: + +**What you expected to happen**: + +**How to reproduce it (as minimally and precisely as possible)**: + +**Anything else we need to know?**: + +**Environment and application version**: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md new file mode 100644 index 0000000..fcbc3a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -0,0 +1,13 @@ +--- +name: '🚀 Enhancement Request' +about: Suggest an enhancement to external-dns +title: '' +labels: '🚀 enhancement' +assignees: '' +--- + + + +**What would you like to be added**: + +**Why is this needed**: \ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..7383849 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,9 @@ +# Reporting Security Issues + +Maintainers and community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. + +To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/Stirling-Tools/Stirling-PDF-chart/security/advisories/new) tab. + +We will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. + +Report security bugs in third-party modules to the person or team maintaining the module. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..8cead7b --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,30 @@ +# 🙋‍♂️ Support + +This document explains where and how to get help with most of my projects. +Please ensure you read through it thoroughly. + +> 👉 **Note**: before participating in the community, please read our +> [Code of Conduct](.github/CODE_OF_CONDUCT). +> By interacting with this repository, organization, or community you agree to +> abide by its terms. + +## ❔ Asking quality questions + +Help me help you! Spend time framing questions and add links and resources. +Spending the extra time up front can help save everyone time in the long run. +Here are some tips: + +* Don't fall for the [XY problem](https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378). +* Search to find out if a similar question has been asked or if a similar + issue/bug has been reported. +* Try to define what you need help with: + * Is there something in particular you want to do? + * What problem are you encountering and what steps have you taken to try + and fix it? + * Is there a concept you don't understand? +* Provide sample code, such as a a simple snippet, if + possible. +* Screenshots can help, but if there's important text such as code or error + messages in them, please also provide those. +* The more time you put into asking your question, the better I and others + can help you. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..62e0642 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ + + +**Description** + + + +# Linked issue(s) + +Fixes #0000 | Relates #0000 + +**Checklist** + +- [ ] Unit tests updated +- [ ] End user documentation updated + +### Community Note + +- Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original pull request comment to help the community and maintainers prioritize this request +- Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request + \ No newline at end of file diff --git a/README.md b/README.md index 45a4699..d552e78 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # Stirling-PDF-chart + Helm charts for Stirling-PDF + +## 🪐 Usage + +Add the following repo to use the chart: + +```console +helm repo add stirling-pdf https://stirling-tools.github.io/Stirling-PDF-chart +``` + +## 🙋‍♂️ Support & Assistance + +* Take a look at the [support](.github/SUPPORT.md) document on + guidelines for tips on how to ask the right questions. +* For all questions/features/bugs/issues [head over here](/../../issues/new/choose). + +## 🤝 Contributing + +* Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines + on ensuring everyone has the best experience interacting with the community. +* We welcome and encourage contributions to this project ! + Please review the [contributing](.github/CONTRIBUTING.md) doc for submitting + issues/a guide on submitting pull requests and helping out. + +## 🛡️ Security + +See [security](.github/SECURITY.md) file for details. + +## ⚖️ License + +See [here](LICENSE). diff --git a/charts/stirling-pdf/.helmignore b/charts/stirling-pdf/.helmignore new file mode 100644 index 0000000..5ef3811 --- /dev/null +++ b/charts/stirling-pdf/.helmignore @@ -0,0 +1,25 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# Go template +*.gotmpl diff --git a/charts/stirling-pdf/README.md b/charts/stirling-pdf/README.md index a808427..e6b7e03 100644 --- a/charts/stirling-pdf/README.md +++ b/charts/stirling-pdf/README.md @@ -18,6 +18,8 @@ locally hosted web application that allows you to perform various operations on ## Chart Repo +### Helm repository + Add the following repo to use the chart: ```console diff --git a/charts/stirling-pdf/README.md.gotmpl b/charts/stirling-pdf/README.md.gotmpl index c68cdb2..b58a424 100644 --- a/charts/stirling-pdf/README.md.gotmpl +++ b/charts/stirling-pdf/README.md.gotmpl @@ -16,6 +16,8 @@ ## Chart Repo +### Helm repository + Add the following repo to use the chart: ```console From cbffaed398a924cca2a9c4b5572f70db6e6c266d Mon Sep 17 00:00:00 2001 From: Ludovic Ortega Date: Fri, 6 Dec 2024 00:36:50 +0100 Subject: [PATCH 2/2] fix: bump version for .helmignore Signed-off-by: Ludovic Ortega --- charts/stirling-pdf/Chart.yaml | 2 +- charts/stirling-pdf/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/stirling-pdf/Chart.yaml b/charts/stirling-pdf/Chart.yaml index 98177f6..aaba9a0 100644 --- a/charts/stirling-pdf/Chart.yaml +++ b/charts/stirling-pdf/Chart.yaml @@ -13,4 +13,4 @@ maintainers: name: stirling-pdf-chart sources: - https://github.com/Stirling-Tools/Stirling-PDF-chart -version: 1.3.0 +version: 1.3.1 diff --git a/charts/stirling-pdf/README.md b/charts/stirling-pdf/README.md index e6b7e03..20556aa 100644 --- a/charts/stirling-pdf/README.md +++ b/charts/stirling-pdf/README.md @@ -1,6 +1,6 @@ # stirling-pdf-chart -![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![AppVersion: 0.36.0](https://img.shields.io/badge/AppVersion-0.36.0-informational?style=flat-square) +![Version: 1.3.1](https://img.shields.io/badge/Version-1.3.1-informational?style=flat-square) ![AppVersion: 0.36.0](https://img.shields.io/badge/AppVersion-0.36.0-informational?style=flat-square) locally hosted web application that allows you to perform various operations on PDF files