search

ArloSoftware / arlowp-plugin

Arlo for WordPress plugin
http://www.arlo.co
GNU General Public License v2.0
2 stars 3 forks source link

readme

Arlo for WordPress Plugin

This repository contains the source code for the Arlo for WordPress plugin. The plugin is maintained on GitHub and deployed to the WordPress plugin repository using GitHub Actions. This README serves as a guide for contributors to make changes and deploy the plugin.

Table of Contents

Prerequisites

Getting Started

  1. Fork the repository into your GitHub account.
  2. Clone your forked repository onto your local machine using git clone <repository_url>.
  3. Set up a new remote named upstream to track the original repository: git remote add upstream git@github.com:ArloSoftware/arlowp-plugin.git.
  4. Ensure your fork is up-to-date with the original repository by executing git pull upstream master before making any changes.

Making Changes

  1. Create a new feature branch based on the current master branch. Name your branch according to the task you're working on, e.g., git checkout -b feature/shortcode-extension master.
  2. Make your changes in the newly created branch.
  3. Commit your changes using descriptive commit messages.
  4. Push your branch to your forked repository: git push origin <branch_name>.
  5. Open a pull request on the original repository to merge your changes into the master branch. Make sure to provide a detailed description of your changes.

Deploying the Plugin

To deploy a new release of the plugin, follow these steps:

  1. Create a release branch from the current master branch, e.g., git checkout -b release/4.1.6 master.
  2. Update the version number in the readme.txt file and include the changes made in the release.
  3. Update the CHANGELOG.txt file to include the changes made in the new release.
  4. Update the version number in arlo-for-wordpress.php.
  5. Update the arlo-for-wordpress-settings.php file to include the changes made in the new release.
  6. Update the version number in the includes/arlo-version-handler.php file.
  7. Commit your changes with a descriptive commit message.
  8. Push the release branch to your forked repository: git push origin <branch_name>.
  9. Open a pull request on the original repository to merge the release branch into the master branch. Provide a detailed description of the release.
  10. Once the pull request is approved and merged, create a new release on GitHub by following these steps:
    • Go to the repository's "Releases" tab.
    • Click on "Draft a new release" or "Create a new release."
    • Enter the new version number as the tag, e.g., v4.1.6.
    • Select the appropriate target branch, usually master.
    • Write a title and release notes, including the changes made in the new release.
    • Click "Publish release."
  11. The GitHub Action will automatically deploy the plugin to the WordPress plugin repository upon creating the new release.
  12. To double check that the deployment has succeeded go to Arlo for WordPress Plugin Page and check the Version is updated, you may have to wait a few minutes and then do a hard refresh.

    Resources