Git Product home page Git Product logo

wp2static's Introduction

WP2Static

A WordPress plugin for static site generation and deployment.

codequality Packagist PHPStan

Looking for the older style plugin? It's been renamed and improved as Static HTML Output.

Open Source over profits

WP2Static is an open source project, maintained by many generous developers over the years, including, but not limited to these contributors on GitHub. Source code for this core repository and all addons shall always remain publicly available.

Read about WP2Static's developers, contributors, supporters.

Versioning & branches

develop branch is considered unstable with latest code changes (current build status: codequality). 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
  2. Clone your project to your development computer (please, change by your account name):
    git clone https://github.com/<your-account>/wp2static.git
  3. Fork 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>
      git checkout -b feature-myfeature
  4. Do your commits
  5. Push to your repository
    git push origin feature-myfeature
  6. Then go to your https://github.com//wp2static site and create a pull request:
    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:
    git remote add upstream https://github.com/leonstafford/wp2static
  9. Fetch upstream
    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

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

wp2static's People

Contributors

leonstafford avatar flynsarmy avatar szepeviktor avatar john-shaffer avatar bookwyrm avatar fromcouch avatar sgerlach avatar semonxue avatar fransallen avatar janicak avatar jts-fin avatar patrickdk77 avatar hikarine3 avatar limmlingg avatar cameronvetter avatar dirtyf avatar chiriboga avatar rotzbua avatar ibes avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.