Skip to content

Commit 3872eed

Browse files
committed
fix(docs): Update workflows and documentation for improved CI/CD processes and feature clarity.
1 parent ddc195a commit 3872eed

File tree

65 files changed

+618
-326
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+618
-326
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,34 @@ respect all community members.
99

1010
Examples of behavior that contributes to a positive environment for our community include:
1111

12-
* Demonstrating empathy and kindness toward other people
13-
* Being respectful of differing opinions, viewpoints, and experiences
14-
* Giving and gracefully accepting constructive feedback
15-
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
16-
* Focusing on what is best not just for us as individuals, but for the overall community
12+
- Demonstrating empathy and kindness toward other people
13+
- Being respectful of differing opinions, viewpoints, and experiences
14+
- Giving and gracefully accepting constructive feedback
15+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
16+
- Focusing on what is best not just for us as individuals, but for the overall community
1717

1818
Examples of unacceptable behavior by participants include:
1919

20-
* The use of sexualized language or imagery, and sexual attention or advances of any kind
21-
* Trolling, insulting or derogatory comments, and personal or political attacks
22-
* Public or private harassment
23-
* Publishing others' private information, such as a physical or email address, without their explicit permission
24-
* Other conduct which could reasonably be considered inappropriate in a professional setting
20+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
21+
- Trolling, insulting or derogatory comments, and personal or political attacks
22+
- Public or private harassment
23+
- Publishing others' private information, such as a physical or email address, without their explicit permission
24+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2525

2626
## Enforcement Responsibilities
2727

28-
Core team members are responsible for clarifying and enforcing our standards of acceptable behavior and will take
28+
Core team members are responsible for clarifying and enforcing our standards of acceptable behavior and will take
2929
appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
3030
or harmful.
3131

3232
Core team members have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
33-
issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
33+
issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
3434
moderation decisions when appropriate.
3535

3636
## Scope
3737

3838
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing
39-
the community in public spaces. Examples of representing a project or community include using an official e-mail
39+
the community in public spaces. Examples of representing a project or community include using an official email
4040
address, posting via an official social media account, within project GitHub, official forum or acting as an appointed
4141
representative at an online or offline event.
4242

@@ -54,7 +54,7 @@ deem in violation of this Code of Conduct:
5454

5555
### 1. Correction
5656

57-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in
57+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in
5858
the community.
5959

6060
**Consequence**: A private, written warning from core team members, providing clarity around the nature of the violation
@@ -66,7 +66,7 @@ and an explanation of why the behavior was inappropriate. A public apology may b
6666

6767
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including
6868
unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding
69-
interactions in community spaces as well as external channels like social media. Violating these terms may lead to
69+
interactions in community spaces as well as external channels like social media. Violating these terms may lead to
7070
a temporary or permanent ban.
7171

7272
### 3. Temporary Ban

.github/FUNDING.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
# These are supported funding model platforms
2-
1+
---
32
github: [terabytesoftw]

.github/ISSUE_TEMPLATE.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
### What steps will reproduce the problem?
1+
# Issue Report
22

3-
### What is the expected result?
3+
## What steps will reproduce the problem?
44

5-
### What do you get instead?
5+
## What is the expected result?
66

7+
## What do you get instead?
78

8-
### Additional info
9+
## Additional info
910

10-
| Q | A
11-
| ---------------- | ---
12-
| Version | 1.0.?
13-
| PHP version |
14-
| Operating system |
11+
| Q | A |
12+
| ---------------- | ----- |
13+
| Version | 1.0.? |
14+
| PHP version | |
15+
| Operating system | |

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
| Q | A
2-
| ------------- | ---
3-
| Is bugfix? | ✔️/❌
4-
| New feature? | ✔️/❌
5-
| Breaks BC? | ✔️/❌
6-
| Fixed issues | <!-- comma-separated list of tickets # fixed by the PR, if any -->
1+
# Pull Request
2+
3+
| Q | A |
4+
| ------------ | ------------------------------------------------------------------ |
5+
| Is bugfix? | ✔️/❌ |
6+
| New feature? | ✔️/❌ |
7+
| Breaks BC? | ✔️/❌ |
8+
| Fixed issues | <!-- comma-separated list of tickets # fixed by the PR, if any --> |

.github/dependabot.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
version: 2
23
updates:
34
# Maintain dependencies for GitHub Actions

.github/linters/actionlint.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
paths:
3+
.github/workflows/**/*.yml:
4+
ignore:
5+
- '"pull_request" section is alias node but mapping node is expected'
6+
- '"push" section is alias node but mapping node is expected'
7+
- "section is alias node but mapping node is expected"

.github/workflows/build.yml

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
1+
---
12
on:
2-
pull_request:
3+
pull_request: &ignore-paths
34
paths-ignore:
4-
- 'docs/**'
5-
- 'README.md'
6-
- 'CHANGELOG.md'
7-
- '.gitignore'
8-
- '.gitattributes'
5+
- ".gitattributes"
6+
- ".gitignore"
7+
- "CHANGELOG.md"
8+
- "docs/**"
9+
- "README.md"
910

10-
push:
11-
paths-ignore:
12-
- 'docs/**'
13-
- 'README.md'
14-
- 'CHANGELOG.md'
15-
- '.gitignore'
16-
- '.gitattributes'
11+
push: *ignore-paths
1712

1813
name: build
1914

15+
permissions:
16+
contents: read
17+
2018
jobs:
2119
phpunit:
22-
uses: php-forge/actions/.github/workflows/phpunit.yml@v1
20+
uses: yii2-framework/actions/.github/workflows/phpunit.yml@v1
2321
secrets:
2422
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
2523
with:
2624
composer-command: |
2725
composer require yiisoft/yii2:22.0.x-dev --prefer-dist --no-progress --no-interaction --no-scripts --ansi
2826
concurrency-group: phpunit-${{ github.workflow }}-${{ github.ref }}
2927
phpunit-compatibility:
30-
uses: php-forge/actions/.github/workflows/phpunit.yml@v1
28+
uses: yii2-framework/actions/.github/workflows/phpunit.yml@v1
3129
secrets:
3230
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
3331
with:
Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1+
---
12
on:
2-
pull_request:
3+
pull_request: &ignore-paths
34
paths-ignore:
4-
- 'docs/**'
5-
- 'README.md'
6-
- 'CHANGELOG.md'
7-
- '.gitignore'
8-
- '.gitattributes'
5+
- ".gitattributes"
6+
- ".gitignore"
7+
- "CHANGELOG.md"
8+
- "docs/**"
9+
- "README.md"
910

10-
push:
11-
paths-ignore:
12-
- 'docs/**'
13-
- 'README.md'
14-
- 'CHANGELOG.md'
15-
- '.gitignore'
16-
- '.gitattributes'
11+
push: *ignore-paths
1712

1813
name: Composer require checker
1914

15+
permissions:
16+
contents: read
17+
pull-requests: write
18+
2019
jobs:
2120
composer-require-checker:
22-
uses: php-forge/actions/.github/workflows/composer-require-checker.yml@v1
21+
uses: yii2-framework/actions/.github/workflows/composer-require-checker.yml@v1

.github/workflows/ecs.yml

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1+
---
12
on:
2-
pull_request:
3+
pull_request: &ignore-paths
34
paths-ignore:
4-
- 'docs/**'
5-
- 'README.md'
6-
- 'CHANGELOG.md'
7-
- '.gitignore'
8-
- '.gitattributes'
5+
- ".gitattributes"
6+
- ".gitignore"
7+
- "CHANGELOG.md"
8+
- "docs/**"
9+
- "README.md"
910

10-
push:
11-
paths-ignore:
12-
- 'docs/**'
13-
- 'README.md'
14-
- 'CHANGELOG.md'
15-
- '.gitignore'
16-
- '.gitattributes'
11+
push: *ignore-paths
1712

1813
name: ecs
1914

15+
permissions:
16+
contents: read
17+
pull-requests: write
18+
2019
jobs:
2120
easy-coding-standard:
22-
uses: php-forge/actions/.github/workflows/ecs.yml@v1
21+
uses: yii2-framework/actions/.github/workflows/ecs.yml@v1

.github/workflows/linter.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
on:
3+
- pull_request
4+
- push
5+
6+
name: linter
7+
8+
permissions:
9+
checks: write
10+
contents: read
11+
statuses: write
12+
13+
jobs:
14+
linter:
15+
uses: yii2-framework/actions/.github/workflows/super-linter.yml@v1
16+
secrets:
17+
AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)