-
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
Jean-Cyril Drouhin
committed
Nov 13, 2024
1 parent
1d1760c
commit e8024ab
Showing
15 changed files
with
581 additions
and
1 deletion.
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,3 @@ | ||
# SPSUpdate - Contributing | ||
|
||
If you'd like to contribute to this project, please review the [Contribution Guidelines](https://github.com/PowerShell/DscResources/blob/master/CONTRIBUTING.md). |
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,63 @@ | ||
name: Bug Report | ||
description: File a bug report. | ||
title: "[Bug]: " | ||
labels: ["bug", "triage"] | ||
projects: ["SPSUpdate"] | ||
assignees: | ||
- luigilink | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details (Optional) | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Also tell us, what did you expect to happen? | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: version | ||
attributes: | ||
label: Version | ||
description: What version of our software are you running? | ||
options: | ||
- 1.0.2 | ||
- 1.0.1 | ||
default: 0 | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: What version of PowerShell are you running? | ||
multiple: true | ||
options: | ||
- 4.x | ||
- 5.x | ||
- 7.x | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: shell | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/luigilink/SPSUpdate/blob/main/CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
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,61 @@ | ||
name: Feature Request | ||
description: Suggest a new feature or improvement. | ||
title: "[Feature Request]: " | ||
labels: ["enhancement", "triage"] | ||
projects: ["SPSUpdate"] | ||
assignees: | ||
- luigilink | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for suggesting a feature or improvement! Please provide as much detail as possible. | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details (Optional) | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Describe the feature you'd like to see | ||
description: What do you want to achieve? What problem does it solve? | ||
placeholder: Describe the feature or improvement you're suggesting. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: potential-solutions | ||
attributes: | ||
label: Potential solutions or alternatives | ||
description: If you have any ideas on how to implement this feature, feel free to share! | ||
placeholder: Suggest how this could be implemented or any alternative ideas. | ||
validations: | ||
required: false | ||
|
||
- type: dropdown | ||
id: priority | ||
attributes: | ||
label: Priority | ||
description: How important is this feature to you? | ||
options: | ||
- Low | ||
- Medium | ||
- High | ||
default: Low | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/luigilink/SPSUpdate/blob/main/CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
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,39 @@ | ||
name: Documentation Request | ||
description: Suggest improvements or request missing documentation. | ||
title: "[Documentation]: " | ||
labels: ["documentation", "triage"] | ||
projects: ["SPSUpdate"] | ||
assignees: | ||
- luigilink | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for suggesting improvements to the documentation. Please be as detailed as possible. | ||
- type: textarea | ||
id: doc-area | ||
attributes: | ||
label: Area of Documentation | ||
description: Which part of the documentation needs to be improved or added? | ||
placeholder: e.g., API usage, installation guide, etc. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: details | ||
attributes: | ||
label: Details | ||
description: Describe the improvements or missing information. | ||
placeholder: Describe the changes you'd like to see. | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this request, you agree to follow our [Code of Conduct](https://github.com/luigilink/SPSUpdate/blob/main/CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
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,39 @@ | ||
name: Refactor/Improvement Request | ||
description: Request improvements or code refactoring. | ||
title: "[Improvement]: " | ||
labels: ["enhancement", "refactor", "triage"] | ||
projects: ["SPSUpdate"] | ||
assignees: | ||
- luigilink | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for suggesting a refactor or improvement to the codebase. Please provide details below. | ||
- type: textarea | ||
id: improvement-description | ||
attributes: | ||
label: What improvement would you like to see? | ||
description: Describe the refactor, optimization, or code improvement. | ||
placeholder: Explain the change you are suggesting. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: reasons | ||
attributes: | ||
label: Why is this improvement needed? | ||
description: Describe the benefits of this improvement. | ||
placeholder: Why does this matter? Will it improve performance, readability, etc.? | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this request, you agree to follow our [Code of Conduct](https://github.com/luigilink/SPSUpdate/blob/main/CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
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 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: "SPSUpdate Discussions" | ||
url: https://github.com/luigilink/SPSUpdate/discussions | ||
about: "To engage with the community and maintainers of SPSUpdate, please visit the discussions group. There, you can share feedback, ask questions, and collaborate with others working on SPSUpdate." |
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,51 @@ | ||
<!-- | ||
Thanks for submitting a Pull Request (PR) to this project. | ||
Your contribution to this project is greatly appreciated! | ||
Please prefix the PR title with the resource name, | ||
e.g. 'ResourceName: My short description'. | ||
If this is a breaking change, then also prefix the PR title | ||
with 'BREAKING CHANGE:', | ||
e.g. 'BREAKING CHANGE: ResourceName: My short description'. | ||
You may remove this comment block, and the other comment blocks, but please | ||
keep the headers and the task list. | ||
--> | ||
|
||
#### Pull Request (PR) description | ||
|
||
<!-- | ||
Replace this comment block with a description of your PR. | ||
Also, make sure you have updated the CHANGELOG.md, see the | ||
task list below. An entry in the CHANGELOG.md is mandatory | ||
for all PRs. | ||
--> | ||
|
||
#### This Pull Request (PR) fixes the following issues | ||
|
||
<!-- | ||
If this PR does not fix an open issue, replace this comment block with None. | ||
If this PR resolves one or more open issues, replace this comment block with | ||
a list of the issues using a GitHub closing keyword, e.g.: | ||
- Fixes #123 | ||
- Fixes #124 | ||
--> | ||
|
||
#### Task list | ||
|
||
<!-- | ||
To aid community reviewers in reviewing and merging your PR, please take | ||
the time to run through the below checklist and make sure your PR has | ||
everything updated as required. | ||
Change to [x] for each task in the task list that applies to your PR. | ||
For those task that don't apply to you PR, leave those unchecked. | ||
--> | ||
|
||
- [ ] Added an entry to the change log under the Unreleased section of the | ||
file CHANGELOG.md. Entry should say what was changed and how that | ||
affects users (if applicable), and reference the issue being resolved | ||
(if applicable). | ||
- [ ] Added/updated documentation and descriptions where appropriate? | ||
- [ ] New/changed code adheres to [Style Guidelines]? |
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 @@ | ||
# This is the SPSUpdate CI Release workflow to create release from tag push | ||
|
||
name: SPSUpdate CI Release | ||
|
||
on: | ||
push: | ||
# Sequence of patterns matched against refs/tags | ||
tags: | ||
- "v*" # Push events to matching v*, i.e. v1.0, v20.15.10 | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Checkout code | ||
- name: Checkout code | ||
id: checkout_code | ||
uses: actions/checkout@v4 | ||
# Create a ZIP file with project name and tag version | ||
- name: Create ZIP file of scripts | ||
run: | | ||
zip_name="SPSUpdate-${{ github.ref_name }}.zip" | ||
zip -r $zip_name scripts/ | ||
shell: bash | ||
# Create Release with tag version | ||
- name: Create GitHub Release | ||
id: create_release | ||
uses: softprops/action-gh-release@v2 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
draft: false | ||
prerelease: false | ||
body_path: RELEASE-NOTES.md | ||
files: | | ||
LICENSE | ||
SPSUpdate-${{ github.ref_name }}.zip |
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,43 @@ | ||
# This is the SPSUpdate CI Wiki workflow to udpate wiki documentation | ||
|
||
name: SPSUpdate CI Wiki | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: [wiki/**, .github/workflows/wiki.yml] | ||
|
||
concurrency: | ||
group: wiki | ||
cancel-in-progress: true | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
wiki: | ||
name: Publish to GitHub Wiki | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout Code | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: ${{github.repository}} | ||
path: ${{github.repository}} | ||
|
||
- name: Checkout Wiki | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: ${{github.repository}}.wiki | ||
path: ${{github.repository}}.wiki | ||
|
||
- name: Push to wiki | ||
run: | | ||
set -e | ||
cd $GITHUB_WORKSPACE/${{github.repository}}.wiki | ||
cp -r $GITHUB_WORKSPACE/${{github.repository}}/wiki/* . | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "GitHub Action" | ||
git add . | ||
git diff-index --quiet HEAD || git commit -m "action: wiki sync" && git push |
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 @@ | ||
**/.DS_Store |
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,31 @@ | ||
# Change log for SPSUpdate | ||
|
||
The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## [Unreleased] - 2023-11-12 | ||
|
||
### Changed | ||
|
||
- README.md | ||
- Add Requirement and Changelog sections | ||
- release.yml | ||
- Zip scripts folder and mane it with Tag version | ||
- PULL_REQUEST_TEMPLATE.md => Remove examples and unit test tasks | ||
|
||
### Added | ||
|
||
- README.md | ||
- Add code_of_conduct.md badge | ||
- Add CODE_OF_CONDUCT.md file | ||
- Add Issue Templates files: | ||
- 1_bug_report.yml | ||
- 2_feature_request.yml | ||
- 3_documentation_request.yml | ||
- 4_improvement_request.yml | ||
- config.yml | ||
- Add RELEASE-NOTES.md file | ||
- Add CHANGELOG.md file | ||
- Add CONTRIBUTING.md file | ||
- Add release.yml file | ||
- Add scripts folder with first version of SPSUpdate |
Oops, something went wrong.