Skip to main content

Shifter Github Plugin/Theme Installer: Working with development plugins or themes for Shifter

Shifter Github Plugin/Theme Installer plugin enables you to install/update plugins or themes with GitHub Actions or TravisCI.

Tomohyco Tsunoda avatar
Written by Tomohyco Tsunoda
Updated over 2 years ago

How to update your plugin/theme

To release a new version, please do as follows:

Tag and push to GitHub, then upload the package using one of the following ways:

$ git tag 1.1.0
$ git push origin 1.1.0

  • 1.1.0 is a version number, it has to be the same version number as in your WordPress plugin.

  • You have to commit the vendor directory in your plugin.

 

A. Manually release the new version.

  1. Please visit "releases" in your GitHub repository.

  2. Choose a tag.

  3. Fill out the release note and title.

  4. Upload your plugin which can be compressed as a zip file. (Optional)

  5. Press "Publish release".

 

B. Automatically release the new version with GitHub Actions.

You can upload the package automatically with GitHub Actions.

As for now, the GitHub Actions service is in beta, so you have to sign up for the Beta here.

When the service is ready you will find the Actions tab on the top page of your repository, then follow the steps below:

  1. Copy the .github directory in the URL below to the root directory of your local repository. getshifter/shifter-github-hosting-plugin-sample

  2. It must look like this: /path_to_your_repository/.github/workflows/release.yml 

  3. Open the release.yml  file with your favorite editor and change some lines:

    1. You MUST change the PACKAGE_NAME to your package name.

      1. Also, if you need:

        1. change FILES_TO_ARCIVE

        2. comment out the composer install section

        3. uncomment npm install section

  4. After changing some lines, commit and push it to your GitHub repository.

Now when you push your tag to GitHub, the release package will be created automatically.

Example Projects

Please install an old version of the following projects, then you can see the update notice:

These projects deploy new releases automatically with GitHub Actions.
Please check .github/workflows/release.yml

 

C. Automatically release the new version with Travis.

You can also use Automatic release with Travis.
The following is an example of .travis.yml used to make an automated release:
​https://github.com/miya0001/miya-gallery/blob/master/.travis.yml

You can generate deploy: section by The Travis Client like the following:

$ travis setup releases
Did this answer your question?