Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
leonstafford committed Dec 4, 2020
2 parents e121f7d + 2ab9b0c commit 92f86ae
Show file tree
Hide file tree
Showing 18 changed files with 266 additions and 205 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/codequality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

strategy:
matrix:
php: [7.3.9]
php: [7.3.25, 7.4.13]

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

Expand Down
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
## WP2Static 7.1.3
## WP2Static 7.1.5

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

## WP2Static 7.1.2

Expand Down
88 changes: 84 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

A WordPress plugin for static site generation and deployment.

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

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

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

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

## Open Source over profits

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

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

## Versioning & branches

`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`.

`master` branch should always reflect a stable release, such as `7.1.1`, which should have a matching tag.

## Beginner-friendly contributing

Please don't be intimidated to contribute code to this project. I welcome code
in any way you're comfortable to contribute it (email, forum, diff). If you're
new to GitHub and this kind of thing, the below guide may help you.

1. Fork project with button in top of WP2static github [home page](https://github.com/leonstafford/wp2static)
2. Clone your project to your development computer (please, change <your-account> by your account name):
<br/>``git clone https://github.com/<your-account>/wp2static.git``
3. Make your new branch from **develop** naming with:
1. If you want add new feature: feature-\<name of your feature>
2. If you want to fix a bug: bug-\<name of bug>
<br/>
``git checkout -b feature-myfeature``
4. Do your commits
5. Push to your repository<br/>
``git push origin feature-myfeature``
6. Then go to your https://github.com/<your-account>/wp2static site and create a pull request:<br/>
In base repository choose _leonstafford/wp2static_ and choose _development_ branch.
7. After Pull Request is approved you need to sync repositories.
8. In your local development add **upstream** branch:<br/>
``git remote add upstream https://github.com/leonstafford/wp2static``
9. Fetch **upstream**<br/>
``git fetch upstream``
10. Checkout your local branch:
``git checkout develop``
11. Merge **upstream** with your local:
``git merge upstream/develop``
12. You can now make new branches.

### Working example

#### Preparing Repository

Fork project WP2static [home page](https://github.com/leonstafford/wp2static)

``git clone https://github.com/ebavs/wp2static.git #clone repository (please,change ebavs by yours, this is only an example)``

Then add WP2Static remote

``git remote add upstream https://github.com/leonstafford/wp2static #add remote``

#### Working and Commiting

``git checkout -b feature-newdocumentation #create new branch to do changes``

``git commit -am "my new commits #send new changes``

``git push origin feature-myfeature #push to your repository``

Then **Pull Request** in WP2Static

#### Sync Repository

``git fetch upstream #download commits from wp2static repo``

``git checkout develop #change to local develop branch``

``git merge upstream/develop #merge with wpstatic develop branch``

### Publishing a new release

This is currently done by @leonstafford and involves these steps:

- test code in `develop` branch
- set a new dev version if needed, ie `7.1.1-dev`
- merge `develop` branch to `master`
- adjust `wp2static.php` version to non-dev, ie `7.1.1`
- update `CHANGELOG.md`
- create new git tag with matching version
- push `master` branch and tag to GitHub
- create new Release in GitHub with same notes as CHANGELOG
- build zip installer and publish to wp2static.com with MD5 hash

11 changes: 5 additions & 6 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"require": {
"php": ">=7.3",
"wa72/url": "^0.7.1",
"vipnytt/sitemapparser": "^1.0"
"vipnytt/sitemapparser": "^1.1.3"
},
"require-dev": {
"phpstan/phpstan": "*",
Expand All @@ -47,9 +47,6 @@
}
},
"config": {
"platform": {
"php": "7.3"
},
"preferred-install": {
"*": "dist"
},
Expand All @@ -59,15 +56,17 @@
"phpstan": "php -d memory_limit=-1 ./vendor/bin/phpstan analyse",
"phpcbf": "vendor/bin/phpcbf --standard=./tools/phpcs.xml --ignore=*/js/*,*/tests/phpstan/*,*/admin/*,*/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
"phpcs": "vendor/bin/phpcs -s --standard=./tools/phpcs.xml --ignore=*/tests/phpstan/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
"phpcompat": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 7.3 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
"php73": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 7.3 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
"php74": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 7.4 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/views/*.php ./",
"phpunit": "vendor/bin/phpunit ./tests/unit/",
"coverage": "vendor/bin/phpunit tests/unit --coverage-html coverage --whitelist src/",
"lint": "vendor/bin/parallel-lint --exclude vendor .",
"test": [
"composer validate --strict",
"@lint",
"@phpcs",
"@phpcompat",
"@php73",
"@php74",
"@phpstan",
"@phpunit"
],
Expand Down
Loading

0 comments on commit 92f86ae

Please sign in to comment.