Skip to content

Commit 011e431

Browse files
neilimeneilime
committed
ci: improving workflows
1 parent b885caf commit 011e431

File tree

4 files changed

+163
-36
lines changed

4 files changed

+163
-36
lines changed

‎.github/dependabot.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ updates:
55
schedule:
66
interval: weekly
77
day: friday
8+
time: "04:00"
89
versioning-strategy: increase
910
- package-ecosystem: github-actions
1011
directory: "/"
1112
schedule:
1213
interval: weekly
1314
day: friday
15+
time: "04:00"

‎.github/workflows/continuous-integration.yml‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,60 @@ name: Continuous integration
33
on:
44
push:
55
branches:
6-
- master
7-
paths-ignore:
8-
- "**.md"
6+
- main
97
pull_request:
10-
paths-ignore:
11-
- "**.md"
8+
branches:
9+
- main
1210

1311
jobs:
1412
build:
1513
strategy:
1614
matrix:
17-
operating-system: [ubuntu-latest]
18-
php-versions: ["7.4", "8.0"]
19-
runs-on: ${{ matrix.operating-system }}
15+
include:
16+
- php-versions: "7.4"
17+
- php-versions: "8.0"
18+
- php-versions: "8.1"
19+
stable: true
20+
21+
runs-on: ubuntu-latest
2022
steps:
2123
- name: Checkout
2224
uses: actions/checkout@v3
2325

2426
- name: Setup PHP, with composer and extensions
25-
uses: shivammathur/setup-php@master #https://github.com/shivammathur/setup-php
27+
uses: shivammathur/setup-php@v2
2628
with:
2729
php-version: ${{ matrix.php-versions }}
2830
extensions: mbstring
2931
coverage: pcov
3032

31-
- name: Get composer cache directory
33+
- name: ♻️ Get composer cache directory
3234
id: composer-cache
3335
run: echo "::set-output name=dir::$(composer config cache-files-dir)"
3436

35-
- name: Cache composer dependencies
37+
- name: ♻️ Cache composer dependencies
3638
uses: actions/cache@v3
3739
with:
3840
path: ${{ steps.composer-cache.outputs.dir }}
3941
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
4042
restore-keys: ${{ runner.os }}-composer-
4143

42-
- name: Cache PHPUnit cache
44+
- name: ⚙️ Install dependencies
45+
run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
46+
47+
- name: ♻️ Test cache
4348
uses: actions/cache@v3
4449
with:
4550
path: tests/.phpunit.result.cache
46-
key: ${{ runner.os }}-phpunit-${{ github.sha }}
47-
restore-keys: ${{ runner.os }}-phpunit-
48-
49-
- name: Install dependencies
50-
run: |
51-
composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
51+
key: ${{ runner.os }}-test-${{ github.sha }}
52+
restore-keys: |
53+
${{ runner.os }}-test-
5254
53-
- name: Run tests
54-
run: |
55-
composer test:ci
55+
- name: 🧪 Test
56+
run: composer test:ci
5657

57-
- name: Upload coverage results to Coveralls
58-
if: github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.php-versions == '8.0'
59-
uses: codecov/codecov-action@master
58+
- name: 📊 Upload coverage results to Coveralls
59+
if: matrix.stable
60+
uses: codecov/codecov-action@v3
6061
with:
6162
file: ./build/logs/clover.xml

‎.github/workflows/publish.yml‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ on:
44
push:
55
tags: [v*]
66
workflow_dispatch:
7-
branches:
8-
- main
97

108
jobs:
119
site:
@@ -39,28 +37,26 @@ jobs:
3937

4038
steps:
4139
- uses: actions/checkout@v3
40+
4241
- name: Setup PHP, with composer and extensions
43-
uses: shivammathur/setup-php@master # https://github.com/shivammathur/setup-php
42+
uses: shivammathur/setup-php@v2
4443
with:
45-
php-version: 8.0
44+
php-version: 8.1
4645
extensions: json
47-
coverage: pcov
4846

49-
- name: Get composer cache directory
47+
- name: ♻️ Get composer cache directory
5048
id: composer-cache
5149
run: echo "::set-output name=dir::$(composer config cache-files-dir)"
5250

53-
- name: Cache composer dependencies
51+
- name: ♻️ Cache composer dependencies
5452
uses: actions/cache@v3
5553
with:
5654
path: ${{ steps.composer-cache.outputs.dir }}
5755
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
5856
restore-keys: ${{ runner.os }}-composer-
5957

60-
- name: Install dependencies
61-
run: |
62-
composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
63-
composer require clean/phpdoc-md --dev;
58+
- name: ⚙️ Install dependencies
59+
run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
6460

6561
- name: Configure phpdoc-md
6662
run: |
@@ -81,7 +77,7 @@ jobs:
8177
');
8278
";
8379
84-
- name: Execute phpdoc-md
80+
- name: 📃 Execute phpdoc-md
8581
run: |
8682
vendor/bin/phpdoc-md -v
8783
mv ./artifact/site/phpdoc/README.md ./artifact/site/phpdoc/index.md

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)