Skip to content

Commit

Permalink
Merge pull request #11 from KelvinTegelaar/main
Browse files Browse the repository at this point in the history
[pull] main from KelvinTegelaar:main
  • Loading branch information
pull[bot] authored Feb 11, 2025
2 parents 8f4df16 + 5bff1e0 commit 5d463d8
Show file tree
Hide file tree
Showing 5 changed files with 185 additions and 136 deletions.
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/CLA.yml

This file was deleted.

130 changes: 90 additions & 40 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,42 +1,92 @@
name: 🐞 Bug report
description: Report errors or unexpected behaviors for CIPP and CIPP-API
labels: [unconfirmed-by-user , bug]
name: "🐞 Bug report"
description: "Report errors or unexpected behaviors for CIPP and CIPP-API"
title: "[Bug]: "
labels:
- "unconfirmed-by-user"
- "bug"

body:
- type: markdown
attributes:
value: >
Thanks for reporting.
- Make sure you are able to reproduce this issue on the latest released version of CIPP & CIPP-API.
- Please search the existing issues to see if there has been a similar issue filed
- This is not the location for support. Issues that request support or are not a bug will be closed.
- type: textarea
attributes:
label: Description
description: >
Please describe the issue and expected result. You can include a screenshot by pasting it. Issues with a description that is too short or does not explain each step in detail will be closed.
Example:
1.) go to Settings
2.) Click on a tenant in access check
3.) Click on the green pixel in the bottom right corner
4.) A bug appears.
validations:
required: true
- type: textarea
attributes:
label: Environment data
description: >
Please let us know your environment information. This must follow this format or the ticket will be closed:
Sponsored / Non-sponsored instance
Front end version number:
Back end version number:
Tried Tenant Cache Clear: true/false
Tried Token Cache Clear: true/false
render: PowerShell
validations:
required: true
- type: markdown
attributes:
value: |
**Thank you for taking the time to report a potential bug for CIPP and CIPP-API!**
Please follow the instructions below and provide as much detail as possible to help us understand and reproduce the issue.
- type: checkboxes
id: confirmations
attributes:
label: "Required confirmations before submitting"
description: "Please check all boxes that apply."
options:
- label: "**I can reproduce this issue on the latest released versions** of both CIPP and CIPP-API."
required: true
- label: "**I have searched existing issues** (both open and closed) to avoid duplicates."
required: true
- label: "I am **not** requesting general support; this is an actual bug report."
required: true

# 3) Description / Steps to reproduce
- type: textarea
id: description
attributes:
label: "Issue Description"
description: |
**Describe the issue clearly and provide step-by-step instructions to reproduce it.**
Screenshots can be attached by pasting them here.
Example steps to reproduce:
1. Go to **Settings**
2. Click on a tenant in **Access Check**
3. Click on the green pixel in the bottom-right corner
4. Observe the unexpected behavior
validations:
required: true

# 4) Environment type (Sponsored vs. Non-sponsored)
- type: dropdown
id: environment_type
attributes:
label: "Environment Type"
description: "Select whether you are using currently a paying user of the product, or if you are utilizing the free version"
options:
- "Sponsored (paying) user"
- "Non-sponsored user"
validations:
required: true

# 5) Front End / Back End versions
- type: input
id: front_end_version
attributes:
label: "Front End Version"
description: "Please specify the front end version number (e.g., v1.2.3)."
validations:
required: true

- type: input
id: back_end_version
attributes:
label: "Back End Version"
description: "Please specify the back end version number (e.g., v1.2.3)."
validations:
required: true

# 7) Additional logs or trace (optional)
- type: textarea
id: logs
attributes:
label: "Relevant Logs / Stack Trace"
description: |
If available, please share any relevant logs or stack trace data.
Remove or redact any sensitive info before posting.
render: plaintext
validations:
required: false

# 8) Closing note
- type: markdown
attributes:
value: |
Thank you for your submission! A maintainer will review your report.
Please watch the issue for follow-up questions or status updates.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
blank_issues_enabled: false
contact_links:
- name: Security Reports
url: https://github.com/KelvinTegelaar/CIPP/security/advisories
about: Please report security vulnerabilities here.
- name: Community Discord
url: https://discord.gg/cyberdrain
about: Join our discord community here.

112 changes: 82 additions & 30 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,84 @@
name: ✨ Feature request
description: Suggest a new feature or improvement
title: '[Feature Request]: '
labels: [enhancement, no-priority]
name: "✨ Feature request"
description: "Suggest a new feature or improvement"
title: "[Feature Request]: "
labels:
- "enhancement"
- "no-priority"

body:
- type: markdown
attributes:
value: >
Thanks for suggesting a feature!
- Please search the existing feature request to see if there has been a similar issue filed.
- If a feature has been filed before, but not followed up by a contributor, you can develop the feature yourself by checking the development documentation [here](https://docs.cipp.app/dev-documentation/cipp-dev-guide/setting-up-for-local-development).
- Repeat feature requests are allowed if the previous request has been closed for more than 30 days
- drive-by feature requests without effort will be closed.
- A feature request has 14 days to be fullfilled before automatically being closed. if you want to work on the feature yourself use the phrase "I'd like to work on this please!"
- Feature requests that are detrimental to security will also be closed without notice.
- type: textarea
attributes:
label: Description of the new feature - must be an in-depth explanation of the feature you want, reasoning why, and the added benefits for MSPs as a whole.
validations:
required: true
- type: textarea
attributes:
label: PowerShell commands you would normally use to achieve above request
validations:
required: false
# Introductory Markdown
- type: markdown
attributes:
value: |
**Thank you for suggesting a new feature or improvement for CIPP**
Before creating a request, please:
1. Check that you have an active sponsorship, only users that are sponsoring CIPP at the $99,- sponsorship level can create feature requests.
1. Search existing **open and closed** feature requests to avoid duplicates.
2. Note that **repeat feature requests** are permitted if a previous request was closed more than 30 days ago.
3. Consider implementing the feature yourself by reviewing the [development documentation](https://docs.cipp.app/dev-documentation/cipp-dev-guide/setting-up-for-local-development).
4. Feature requests that lack sufficient detail or feasibility may be closed at any time.
5. **This request will auto-close in 14 days** if no meaningful progress or collaboration occurs.
6. If you would like to work on this feature, comment `"I'd like to work on this please!"`
7. Any request that is detrimental to security or the product’s stability will be closed without notice.
# Checkboxes for Confirmations
- type: checkboxes
id: confirmations
attributes:
label: "Please confirm:"
description: "Check all boxes that apply."
options:
- label: "**I have searched existing feature requests** (open and closed) and found no duplicates."
required: true
- label: "**me or my organization is currently an active sponsor of the product at the $99,- level."
required: true

- type: textarea
id: problem-statement
attributes:
label: "Problem Statement"
description: |
**What problem does this feature solve or what gap does it fill?**
Provide a concise explanation. For example:
- "When I need to enable MFA for all users, it takes a lot of time to do it per user. I'd like to enable this for all users in button press"
- "To update a user property for exchange I need to go through 5 portals and 2 systems to be able to make a change."
validations:
required: true

# Field 2: Benefits for MSPs
- type: textarea
id: msp-benefits
attributes:
label: "Benefits for MSPs"
description: |
**How would this feature help MSPs in their day-to-day tasks or overall operations?**
- Does it reduce manual work?
- Does it improve security or scalability?
- Does it offer clarity or automation to commonly repeated tasks?
validations:
required: true

# Field 3: Value or Importance
- type: textarea
id: feature-value
attributes:
label: "Value or Importance"
description: |
**Why is this feature particularly valuable or important to add?**
- If it's critical, explain why.
- If it's optional or nice-to-have, describe how it still adds notable value.
validations:
required: true

# Optional field for PowerShell commands
- type: textarea
id: powershell-commands
attributes:
label: "PowerShell Commands (Optional)"
description: |
If you currently achieve this functionality or a similar workaround using PowerShell, please share your scripts or snippets here.
This information helps contributors understand the existing workflow and aids in development.
validations:
required: false
16 changes: 4 additions & 12 deletions .github/workflows/Comment_on_Issues.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,7 @@ jobs:
with:
issue-number: ${{ github.event.issue.number }}
body: |
Thank you for creating a bug. Please make sure your bug is indeed a unique case by checking current and past issues, and reading the complete documentation at https://docs.cipp.app/
If your bug is a known documentation issue, it will be closed without notice by a contributor. To confirm that this is not a bug found in the documentation, please copy and paste the following comment: "I confirm that I have checked the documentation thoroughly and believe this to be an actual bug."
Without confirming, your report will be closed in 24 hours. If you'd like this bug to be assigned to you, please comment "I would like to work on this please!".
add-comment_fr:
if: github.repository_owner == 'KelvinTegelaar' && github.event.label.name == 'enhancement'
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- name: Add Comment
uses: peter-evans/create-or-update@v3
Thank you for reporting a potential bug. If you would like to work on this bug, please comment:
> I would like to work on this please!
Thank you for helping us maintain the project!

0 comments on commit 5d463d8

Please sign in to comment.