Skip to content

Commit 8acc345

Browse files
TGWolfTGWolf
committed
Repo refresh
1 parent 5f48543 commit 8acc345

32 files changed

+967
-167
lines changed

‎.github/CODE_OF_CONDUCT.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ appearance, race, religion, or sexual identity and orientation.
1111

1212
## Our Standards
1313

14-
Examples of behavior that contributes to creating a positive environment
14+
Examples of behaviour that contributes to creating a positive environment
1515
include:
1616

1717
* Using welcoming and inclusive language
@@ -20,7 +20,7 @@ include:
2020
* Focusing on what is best for the community
2121
* Showing empathy towards other community members
2222

23-
Examples of unacceptable behavior by participants include:
23+
Examples of unacceptable behaviour by participants include:
2424

2525
* The use of sexualized language or imagery and unwelcome sexual attention or
2626
advances
@@ -34,8 +34,8 @@ Examples of unacceptable behavior by participants include:
3434
## Our Responsibilities
3535

3636
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
37+
behaviour and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behaviour.
3939

4040
Project maintainers have the right and responsibility to remove, edit, or
4141
reject comments, commits, code, wiki edits, issues, and other contributions
@@ -54,7 +54,7 @@ further defined and clarified by project maintainers.
5454

5555
## Enforcement
5656

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
57+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
5858
reported by contacting the project team at . All
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
@@ -67,10 +67,9 @@ members of the project's leadership.
6767

6868
## Attribution
6969

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72-
73-
[homepage]: https://www.contributor-covenant.org
70+
This Code of Conduct is adapted from the
71+
[Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
72+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7473

7574
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
75+
<https://www.contributor-covenant.org/faq>

‎.github/CONTRIBUTING.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
# Contributing
22

3-
Please refer to the [contributing](https://github.com/WolfSoftware/contributing) documentation.
3+
Please refer to the
4+
[contributing](https://github.com/WolfSoftware/contributing)
5+
documentation.
46

57
## Important
68

7-
ALL commits must be signed to ensure the identity of the developer, any pull requests that are made with unsigned commits will be rejected as a matter of course.
9+
ALL commits must be signed to ensure the identity of the developer, any pull
10+
requests that are made with unsigned commits will be rejected as a matter of
11+
course.
812

9-
> This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting with this repository, organization, or community you agree to abide by its terms.
13+
> This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting
14+
with this repository, organization, or community you agree to abide by its terms.

‎.github/FUNDING.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Funding
22
# https://help.github.com/en/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository
33

4-
ko_fi: wolfsoftware
4+
github: [WolfSoftware,TGWolf]

‎.github/ISSUE_TEMPLATE/ask_question.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Ask a question
22
description: If you don't have a specific issue or bug to report you can still ask us questions and we will do our best to answer them
33
title: "[Question]: "
4-
labels: [question, triage]
4+
labels: ["type: question", "state: triage"]
55
assignees:
66
- tgwolf
77
body:
@@ -16,7 +16,7 @@ body:
1616
id: terms
1717
attributes:
1818
label: Code of Conduct
19-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
19+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/ini-file-parser/blob/master/.github/CODE_OF_CONDUCT.md)
2020
options:
2121
- label: I agree to follow this project's Code of Conduct
2222
required: true

‎.github/ISSUE_TEMPLATE/bug_report.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Report a bug
22
description: Found a bug? Let us knonw what the issue is and we will attempt to fix it
33
title: "[Bug]: "
4-
labels: [bug, triage]
4+
labels: ["type: bug", "state: triage"]
55
assignees:
66
- tgwolf
77
body:
@@ -52,7 +52,7 @@ body:
5252
id: terms
5353
attributes:
5454
label: Code of Conduct
55-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
55+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/ini-file-parser/blob/master/.github/CODE_OF_CONDUCT.md)
5656
options:
5757
- label: I agree to follow this project's Code of Conduct
5858
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Request a new feature
22
description: Got an idea for a new feature? Let us know what you want and we will see if we can add it
33
title: "[Feature Request]: "
4-
labels: [enhancement, triage]
4+
labels: ["type: feature", "state: triage"]
55
assignees:
66
- tgwolf
77
body:
@@ -37,7 +37,7 @@ body:
3737
id: terms
3838
attributes:
3939
label: Code of Conduct
40-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
40+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/ini-file-parser/blob/master/.github/CODE_OF_CONDUCT.md)
4141
options:
4242
- label: I agree to follow this project's Code of Conduct
4343
required: true

‎.github/PULL_REQUEST_TEMPLATE.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
1+
# Thank You
22

3-
**Summary**
3+
Thanks for submitting a pull request! Please provide enough information so that
4+
others can review your pull request:
5+
6+
## Summary
47

58
<!-- Summary of the PR -->
69

@@ -10,19 +13,24 @@ This PR fixes/implements the following **bugs/features**
1013
* [ ] Feature 1
1114
* [ ] Breaking changes
1215

13-
<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
16+
<!-- You can skip this if you're fixing a typo or adding an app to the
17+
Showcase. -->
1418

15-
Explain the **motivation** for making this change. What existing problem does the pull request solve?
19+
Explain the **motivation** for making this change. What existing problem does
20+
the pull request solve?
1621

17-
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
22+
<!-- Example: When "Adding a function to do X", explain why it is necessary
23+
to have a way to do X. -->
1824

19-
**Test plan (required)**
25+
## Test plan (required)
2026

21-
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots help greatly.
27+
Demonstrate the code is solid. Example: The exact commands you ran and their
28+
output, screenshots help greatly.
2229

2330
<!-- Make sure tests pass on both Travis. -->
2431

25-
**Closing issues**
32+
## Closing issues
2633

27-
<!-- Put `fixes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
34+
<!-- Put `fixes #NNN` in your comment to auto-close the issue that your PR
35+
fixes (if such). -->
2836
Fixes #

‎.github/SECURITY.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22

33
This document outlines security procedures and general policies for this project.
44

5-
* [Reporting a Bug](#reporting-a-bug)
6-
* [Disclosure Policy](#disclosure-policy)
7-
* [Comments on this Policy](#comments-on-this-policy)
5+
* [Reporting a Bug](#reporting-a-bug)
6+
* [Disclosure Policy](#disclosure-policy)
7+
* [Comments on this Policy](#comments-on-this-policy)
88

99
## Reporting a Bug
1010

1111
We take **ALL** security related bugs and issues very seriously.
1212

13-
If you think you have identified a security related issue, please [report it immediately](mailto:disclose@wolfsoftware.com)
14-
and include the word "SECURITY" in the subject line. If you are not sure, don’t worry.
13+
If you think you have identified a security related issue, please
14+
[report it immediately](mailto:disclose@wolfsoftware.com) and include
15+
the word "SECURITY" in the subject line. If you are not sure, don’t worry.
1516
Better safe than sorry – just send an email.
1617

1718
* Please provide as much information as you can.
@@ -25,13 +26,13 @@ the module.
2526

2627
When a security report is received, we will carry out the following steps:
2728

28-
* Confirm the problem and determine the affected versions.
29-
* Audit code to find any potential similar problems.
30-
* Prepare fixes for all releases still under maintenance. These fixes will be
31-
released as fast as possible.
29+
* Confirm the problem and determine the affected versions.
30+
* Audit code to find any potential similar problems.
31+
* Prepare fixes for all releases still under maintenance. These fixes will be
32+
released as fast as possible.
3233

33-
We will endeavor to keep you informed of the progress towards a fix
34-
and full announcement, and may ask for additional information or guidance.
34+
We will endeavour to keep you informed of the progress towards a fix and full
35+
announcement, and may ask for additional information or guidance.
3536

3637
## Comments on this Policy
3738

‎.github/dependabot.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
version: 2
2+
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
time: "04:00"
10+
open-pull-requests-limit: 10
11+
commit-message:
12+
prefix: "chore:"
13+
labels:
14+
- "dependabot: ecosystem : github actions"
15+
- "dependabot: dependencies"
16+
assignees:
17+
- "TGWolf"
18+

‎.github/scripts/check-jobs.sh

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#!/usr/bin/env bash
2+
3+
# This script receives a JSON string containing job results and checks for any failures.
4+
5+
# Check if jq is available
6+
if ! command -v jq &> /dev/null; then
7+
echo "jq could not be found, please install jq to run this script."
8+
exit 1
9+
fi
10+
11+
# Read the JSON string from the first script argument
12+
job_results_json=$1
13+
14+
# Check if the job results JSON is not empty
15+
if [[ -z "$job_results_json" ]]; then
16+
echo "No job results JSON provided."
17+
exit 1
18+
fi
19+
20+
# Set default state
21+
failed_jobs=false
22+
23+
# Use jq to parse the JSON and check each job's result
24+
while IFS= read -r line; do
25+
job_name=$(echo "$line" | awk '{print $1}')
26+
result=$(echo "$line" | awk '{print $3}')
27+
28+
if [ "$result" != "success" ]; then
29+
echo "$job_name failed."
30+
failed_jobs=true
31+
else
32+
echo "$job_name succeed."
33+
fi
34+
done <<< "$( echo "$job_results_json" | jq -r 'to_entries[] | "\(.key) result: \(.value.result)"' )"
35+
36+
if [ "$failed_jobs" = true ] ; then
37+
exit 1
38+
fi

‎.github/workflows/cicd.yml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: CI/CD Pipeline
2+
3+
on:
4+
push:
5+
branches-ignore:
6+
- 'dependabot/**'
7+
paths-ignore:
8+
- '**/*.md'
9+
- '**/*.cff'
10+
11+
pull_request:
12+
branches:
13+
- '**'
14+
paths-ignore:
15+
- '**/*.md'
16+
- '**/*.cff'
17+
18+
concurrency:
19+
group: ${{ github.workflow }}-${{ github.ref }}
20+
cancel-in-progress: true
21+
22+
permissions: read-all
23+
24+
jobs:
25+
shellcheck:
26+
name: ShellCheck
27+
runs-on: ubuntu-latest
28+
29+
steps:
30+
- name: Checkout the Repository
31+
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
32+
33+
- name: Perform ShellCheck Analysis
34+
run: bash <(curl -s https://raw.githubusercontent.com/CICDToolbox/shellcheck/master/pipeline.sh)
35+
36+
cicd-pipeline:
37+
if: always()
38+
name: CI/CD Pipeline
39+
needs:
40+
- shellcheck
41+
runs-on: ubuntu-latest
42+
43+
steps:
44+
- name: Checkout the Repository
45+
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
46+
47+
- name: Check Job Statuses
48+
run: .github/scripts/check-jobs.sh '${{ toJson(needs) }}'

0 commit comments

Comments
 (0)