Skip to content

Commit 92f86ae

Browse files
committed
Merge branch 'develop'
2 parents e121f7d + 2ab9b0c commit 92f86ae

18 files changed

+266
-205
lines changed

.github/workflows/codequality.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515

1616
strategy:
1717
matrix:
18-
php: [7.3.9]
18+
php: [7.3.25, 7.4.13]
1919

2020
name: PHP-${{ matrix.php }}
2121

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
## WP2Static 7.1.3
1+
## WP2Static 7.1.5
22

3-
- TBD
3+
- fix PHP version check to 7.3>=
4+
- fix errors during sitemap detection (thanks @fromcouch)
5+
- fix errors during cache table initialisation
6+
- fix pagination URLs not using correct schema
7+
- fix CLI command registration issue
48

59
## WP2Static 7.1.2
610

README.md

Lines changed: 84 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
A WordPress plugin for static site generation and deployment.
44

5-
Official homepage/docs: [https://wp2static.com](https://wp2static.com)
5+
![codequality](https://github.com/leonstafford/wp2static/workflows/codequality/badge.svg?branch=master)
6+
[![Packagist](https://img.shields.io/packagist/v/leonstafford/wp2static.svg?color=239922&style=popout)](https://packagist.org/packages/leonstafford/wp2static)
7+
[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-239922)](https://github.com/phpstan/phpstan)
68

7-
__Looking for the older style plugin? It's been renamed and improved as [Static HTML Output](https://github.com/WP2Static/static-html-output-plugin).__
89

9-
`develop` (bleeding edge): ![codequality](https://github.com/wp2static/wp2static/workflows/codequality/badge.svg?branch=develop)
10+
__Looking for the older style plugin? It's been renamed and improved as [Static HTML Output](https://github.com/WP2Static/static-html-output-plugin).__
1011

11-
`master` (stable): ![codequality](https://github.com/wp2static/wp2static/workflows/codequality/badge.svg?branch=master)
1212

1313
## Open Source over profits
1414

@@ -22,3 +22,83 @@ WP2Static is an open source project, maintained by many generous developers over
2222

2323
Read about WP2Static's [developers, contributors, supporters](https://wp2static.com/contributors).
2424

25+
## Versioning & branches
26+
27+
`develop` branch is considered unstable with latest code changes (current build status: ![codequality](https://github.com/leonstafford/wp2static/workflows/codequality/badge.svg?branch=develop)). `develop` branch should always have a `-dev` WordPress plugin version, ie `7.1.1-dev`.
28+
29+
`master` branch should always reflect a stable release, such as `7.1.1`, which should have a matching tag.
30+
31+
## Beginner-friendly contributing
32+
33+
Please don't be intimidated to contribute code to this project. I welcome code
34+
in any way you're comfortable to contribute it (email, forum, diff). If you're
35+
new to GitHub and this kind of thing, the below guide may help you.
36+
37+
1. Fork project with button in top of WP2static github [home page](https://github.com/leonstafford/wp2static)
38+
2. Clone your project to your development computer (please, change <your-account> by your account name):
39+
<br/>``git clone https://github.com/<your-account>/wp2static.git``
40+
3. Make your new branch from **develop** naming with:
41+
1. If you want add new feature: feature-\<name of your feature>
42+
2. If you want to fix a bug: bug-\<name of bug>
43+
<br/>
44+
``git checkout -b feature-myfeature``
45+
4. Do your commits
46+
5. Push to your repository<br/>
47+
``git push origin feature-myfeature``
48+
6. Then go to your https://github.com/<your-account>/wp2static site and create a pull request:<br/>
49+
In base repository choose _leonstafford/wp2static_ and choose _development_ branch.
50+
7. After Pull Request is approved you need to sync repositories.
51+
8. In your local development add **upstream** branch:<br/>
52+
``git remote add upstream https://github.com/leonstafford/wp2static``
53+
9. Fetch **upstream**<br/>
54+
``git fetch upstream``
55+
10. Checkout your local branch:
56+
``git checkout develop``
57+
11. Merge **upstream** with your local:
58+
``git merge upstream/develop``
59+
12. You can now make new branches.
60+
61+
### Working example
62+
63+
#### Preparing Repository
64+
65+
Fork project WP2static [home page](https://github.com/leonstafford/wp2static)
66+
67+
``git clone https://github.com/ebavs/wp2static.git #clone repository (please,change ebavs by yours, this is only an example)``
68+
69+
Then add WP2Static remote
70+
71+
``git remote add upstream https://github.com/leonstafford/wp2static #add remote``
72+
73+
#### Working and Commiting
74+
75+
``git checkout -b feature-newdocumentation #create new branch to do changes``
76+
77+
``git commit -am "my new commits #send new changes``
78+
79+
``git push origin feature-myfeature #push to your repository``
80+
81+
Then **Pull Request** in WP2Static
82+
83+
#### Sync Repository
84+
85+
``git fetch upstream #download commits from wp2static repo``
86+
87+
``git checkout develop #change to local develop branch``
88+
89+
``git merge upstream/develop #merge with wpstatic develop branch``
90+
91+
### Publishing a new release
92+
93+
This is currently done by @leonstafford and involves these steps:
94+
95+
- test code in `develop` branch
96+
- set a new dev version if needed, ie `7.1.1-dev`
97+
- merge `develop` branch to `master`
98+
- adjust `wp2static.php` version to non-dev, ie `7.1.1`
99+
- update `CHANGELOG.md`
100+
- create new git tag with matching version
101+
- push `master` branch and tag to GitHub
102+
- create new Release in GitHub with same notes as CHANGELOG
103+
- build zip installer and publish to wp2static.com with MD5 hash
104+

composer.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"require": {
2121
"php": ">=7.3",
2222
"wa72/url": "^0.7.1",
23-
"vipnytt/sitemapparser": "^1.0"
23+
"vipnytt/sitemapparser": "^1.1.3"
2424
},
2525
"require-dev": {
2626
"phpstan/phpstan": "*",
@@ -47,9 +47,6 @@
4747
}
4848
},
4949
"config": {
50-
"platform": {
51-
"php": "7.3"
52-
},
5350
"preferred-install": {
5451
"*": "dist"
5552
},
@@ -59,15 +56,17 @@
5956
"phpstan": "php -d memory_limit=-1 ./vendor/bin/phpstan analyse",
6057
"phpcbf": "vendor/bin/phpcbf --standard=./tools/phpcs.xml --ignore=*/js/*,*/tests/phpstan/*,*/admin/*,*/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
6158
"phpcs": "vendor/bin/phpcs -s --standard=./tools/phpcs.xml --ignore=*/tests/phpstan/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
62-
"phpcompat": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 7.3 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
59+
"php73": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 7.3 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
60+
"php74": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 7.4 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
6361
"phpunit": "vendor/bin/phpunit ./tests/unit/",
6462
"coverage": "vendor/bin/phpunit tests/unit --coverage-html coverage --whitelist src/",
6563
"lint": "vendor/bin/parallel-lint --exclude vendor .",
6664
"test": [
6765
"composer validate --strict",
6866
"@lint",
6967
"@phpcs",
70-
"@phpcompat",
68+
"@php73",
69+
"@php74",
7170
"@phpstan",
7271
"@phpunit"
7372
],

0 commit comments

Comments
 (0)