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

Release 0.2.0 beta #1

Merged
merged 18 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# EditorConfig is awesome: https://EditorConfig.org

# Top-most EditorConfig file
root = true

[*]
charset = utf-8-bom
indent_size = 4
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true
44 changes: 44 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making 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 both within project spaces and in public spaces when an individual is representing the project or its community. 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 <[email protected]>. 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](https://www.contributor-covenant.org), version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
50 changes: 50 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contributing

Thanks for your interest in contributing to PSAppDeployToolkit

Whether it's a bug report, new feature, correction, or additional documentation, your feedback and contributions are appreciated.

Please read through this document before submitting any issues or pull requests to ensure all the necessary information is provided to effectively respond to your bug report or contribution.

Please note there is a code of conduct, please follow it in all your interactions with the project.

## Reporting Bugs / Submitting Feature Requests

When filing an issue, please check [existing open](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues), or [recently closed](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
* The version of PSADT that is being used (found in the AppDeployToolkitMain.ps1)
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment

## Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending a pull request, please ensure that:

1. You are working against the latest source on the *develop* branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - I'd hate for your time to be wasted.

To send a pull request, please:

1. Fork the repository.
2. Checkout the *develop* branch
3. Modify the source; please focus on the specific change you are contributing. Please refrain from code styling changes, it will be harder to focus on your change.
4. Ensure local tests pass.
5. Commit to your fork using clear commit messages.
6. Send a pull request, answering any default questions in the pull request interface.

GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

## Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues is a great place to start.

## Code of Conduct

This project has a [Code of Conduct](CODE_OF_CONDUCT.md).

## Licensing

See the [LICENSE](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/blob/main/COPYING.Lesser) file for our project's licensing.
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: "🕷️ Bug report"
description: Report errors or unexpected behavior
labels: [ bug, needs-triage ]
title: "[Bug] "


body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: Ensure you write a short, descriptive title after [Bug] above.
required: true
- label: Make sure to [search for any existing issues](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues) before filing a new one.
required: true
- label: Verify you are able to reproduce the issue with the [latest released version](https://www.github.com/psappdeploytoolkit/psappdeploytoolkit.tools/releases/latest)
required: true

- type: input
id: psadttools-version
attributes:
label: PSAppDeployToolkit.Tools version
placeholder: 0.0.1
description: The version of PSAppDeployToolkit you are using
validations:
required: true

- type: input
id: psadt-version
attributes:
label: PSAppDeployToolkit version
placeholder: 4.0.0
description: The version of PSAppDeployToolkit you are using
validations:
required: false

- type: textarea
id: description
attributes:
label: Describe the bug
description: Please enter a detailed description of the bug you are seeing. Include any error messages, screenshots, or other relevant information. If a PSADT log file was created, please also attach it below.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: Please provide any required setup and steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
value: |
1.
2.
3.
validations:
required: true

- type: textarea
id: environment-data
attributes:
label: Environment data
description: |
The following script will gather environment details that will help with triage and investigation of the issue.
Please run the script in the PowerShell session where you ran into the issue, and paste the verbatim output below.
```powershell
Get-ComputerInfo -Property @('OsName','OSDisplayVersion','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsProductName','WindowsBuildLabEx','OsLanguage','OsMuiLanguages','KeyboardLayout','TimeZone','HyperVisorPresent','CsPartOfDomain','CsPCSystemType'); dotnet --info
```
render: console
placeholder: |
OsName ...
OSDisplayVersion ...
OsOperatingSystemSKU ...
OsArchitecture ...
WindowsVersion ....
WindowsProductName ...
WindowsBuildLabEx ...
validations:
required: true
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: Chat with the community
url: https://discord.com/channels/618712310185197588/627204361545842688
about: PSAppDeployToolkit channel on Discord (WinAdmins)
- name: Join in the discussion
url: https://discourse.psappdeploytoolkit.com
about: PSAppDeployToolkit Discourse Forums
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: 🚀 Feature Request
description: Suggest a new feature or improvement (this does not mean you have to implement it)
labels: ["feature-request", "needs-triage"]
title: "[Feature] "

body:
- type: textarea
attributes:
label: Summary of the new feature / enhancement
description: >
A clear and concise description of what the problem is that the new feature would solve. Try formulating it in a user story style (if applicable).
placeholder: "'As a user I want X so that Y...' with X being the being the action and Y being the value of the action."
validations:
required: true

- type: textarea
attributes:
label: Proposed technical implementation details (optional)
placeholder: >
A clear and concise description of what you want to happen. Consider providing an example PowerShell experience with expected result.
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/adr_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# [ADR] - Architectural Decision Record

Please include a summary of any changes. Please also include relevant motivation and context.

## Status

What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.?

## Context

What is the issue that we're seeing that is motivating this decision or change?

## Decision

What is the change that we're proposing and/or doing?

## Consequences

What becomes easier or more difficult to do because of this change?

## Notes

Any additional notes?
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Pull Request

## Description

Please include a summary of any changes. Please also include relevant motivation and context.

Fixes: #12345

Fixes: <https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues/12345>

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] General code cleanup (non-breaking change which improves readability)

## Checklist

- [ ] I am pulling to the **develop** branch
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have tested my changes to prove my fix is effective
- [ ] I have tested that the module can build following my changes
- [ ] I have made sure that any script file-encoding is set to UTF8 with BOM, i.e. unchanged.

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
45 changes: 45 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Responsible Security Disclosure

## Introduction

Thank you for your interest in PSAppDeployToolkit. We take the security of our software seriously and appreciate the efforts of security researchers in identifying and responsibly disclosing vulnerabilities. This document outlines our responsible disclosure policy and provides guidelines for reporting security vulnerabilities.

## Reporting a Vulnerability

If you believe you have discovered a security vulnerability in PSAppDeployToolkit, we encourage you to report it to us as soon as possible. To report a vulnerability, please follow these steps:

1. Send an email to [[email protected]](mailto:[email protected]) with a detailed description of the vulnerability.
2. Include any relevant information, such as the affected version(s) of the software, steps to reproduce the vulnerability, and any proof-of-concept code or screenshots.
3. Provide your contact information (name, email address) so that we can acknowledge your report and keep you updated on the progress of the fix.

## Responsible Disclosure Guidelines

To ensure the safety and privacy of our users, we kindly request that you adhere to the following guidelines when reporting a vulnerability:

- Do not exploit the vulnerability beyond what is necessary to demonstrate the security issue.
- Do not disclose the vulnerability to others until it has been resolved by the project maintainers.
- Do not perform any actions that could negatively impact the availability or integrity of the software or its users' data.

## Our Commitment

Upon receiving a vulnerability report, we will:

- Acknowledge the receipt of your report within 3 business days.
- Investigate and validate the reported vulnerability.
- Work towards addressing the vulnerability in a timely manner.
- Keep you informed of the progress and resolution of the vulnerability.

## Recognition

We value the contributions of security researchers and may recognize their efforts, subject to their consent and our discretion. If you would like to be acknowledged for your responsible disclosure, please let us know in your initial report.

## Legal Considerations

We will not take any legal action against security researchers who act in good faith and adhere to this responsible disclosure policy. We request that you do not violate any laws or breach any agreements in your research activities.

## Conclusion

By following these guidelines, you are helping us ensure the security and privacy of our software and its users. We appreciate your cooperation and responsible approach to vulnerability disclosure.

Thank you,
The PSAppDeployToolkit Team
7 changes: 7 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# PSAppDeployToolkit Support

If you have any problems, please consult the [PSAppDeployToolkit GitHub Issues](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues) page.

If you do not see your problem captured, please file a [new issue](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/issues/new/choose) and follow the provided template.

If you know how to fix the issue, feel free to send a pull request our way. (The [Contribution Guide](https://github.com/psappdeploytoolkit/psappdeploytoolkit.tools/tree/main/.github/CONTRIBUTING.md) apply to that pull request, you may want to give it a read!)
61 changes: 61 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Configuration for Release Drafter: https://github.com/toolmantim/release-drafter
name-template: $NEXT_PATCH_VERSION
tag-template: $NEXT_PATCH_VERSION

# Emoji reference: https://gitmoji.carloscuesta.me/
categories:
- title: 💥 Breaking changes
labels:
- breaking
- title: 🚀 New Features and enhancements
labels:
- feature
- title: 🐛 Bug fixes
labels:
- bug
- title: 📦 Dependencies
labels:
- dependencies
collapse-after: 15
- title: 📝 Documentation
labels:
- documentation
- title: 🌐 Localization
labels:
- localization
- title: 👻 Maintenance
labels:
- chore
- maintenance
- title: 🚦 Tests
labels:
- test
- title: ✍ Other changes

exclude-labels:
- skip-changelog
- invalid

autolabeler:
- label: "documentation"
files:
- "*.md"
branch:
- '/docs{0,1}\/.+/'
- label: "bug"
title:
- '/bug\/.+/'
branch:
- '/fix\/.+/'
- label: "feature"
title:
- '/feature\/.+/'
branch:
- '/feature\/.+/'

template: |
## What's Changed

<!-- Optional: add a release summary here -->

$CHANGES
Loading