Git Product home page Git Product logo

freemius-deploy's Introduction

Freemius Deploy

This Github Action deploys your wordpress plugin on Freemius. It uses the Freemius PHP SDK and uses some of the functionality of CodeAtCode/freemius-suite

Arguments

Argument Required Function Default
file_name Yes File name of the to be uploaded wordpress plugin (zip extension). Note: the file has to be in the root folder of your repository
release_mode No pending, beta, or released. Set to beta to release the product to valid license holders that opted into the beta list. Set to released to release it to all valid license holders. When the product is released, it will be available for download right within the WP Admin dashboard. pending
version Yes This is used to check whether the release is already uploaded. Action will fail if the release has already been uploaded
sandbox No Whether to upload in sandbox mode false

Environment variables

Required:

  • PUBLIC_KEY
  • DEV_ID
  • SECRET_KEY
  • PLUGIN_SLUG
  • PLUGIN_ID

All these are found in your Freemius dashboard.

Tip: store these variables in your secrets

Action outputs (since v0.1.1)

The action downloads both the free and pro version and outputs their filenames as outputs:

  • free_version
  • pro_version

You can access these by setting an id to your workflow step. Consequently you can upload these as artifacts, or upload them to the wordpress svn repository, for example with yukihiko-shinoda/action-deploy-wordpress-plugin.

Example

- name: Deploy to Freemius
  uses: buttonizer/[email protected]
  with:
    file_name: my_wordpress_plugin.zip
    release_mode: pending
    version: 1.1.0
    sandbox: false
  env:
    PUBLIC_KEY: ${{ secrets.FREEMIUS_PUBLIC_KEY }}
    DEV_ID: 1234
    SECRET_KEY: ${{ secrets.FREEMIUS_SECRET_KEY }}
    PLUGIN_SLUG: my-wordpress-plugin
    PLUGIN_ID: 4321

freemius-deploy's People

Contributors

castorverhoog avatar

Stargazers

flowdee avatar Uriahs Victor avatar Aaron avatar Karolína Vyskočilová avatar Dario Curvino avatar Cadu de Castro Alves avatar Justin Vogt avatar Guillermo Figueroa Mesa avatar  avatar Dibyajyoti Panda avatar Durgesh Gupta avatar Andre Gagnon avatar Daryll Doyle avatar Vova Feldman avatar Paras Shah avatar Muhammad Usama Masood avatar Jasper Vriends avatar

Watchers

James Cloos avatar Jasper Vriends avatar  avatar

freemius-deploy's Issues

file_name or fileName

Hello,

In your example you use the argument file_name.

- name: Deploy to Freemius
uses: buttonizer/[email protected]
with:
file_name: my_wordpress_plugin.zip
release_mode: pending
version: 1.1.0
sandbox: false

But when I use that I get the warning below:
Unexpected input(s) 'file_name', valid inputs are ['entryPoint', 'args', 'sandbox', 'fileName', 'version', 'releaseMode']

But it works but later on I get the error (
[type] => InvalidArgument
[message] => Your module's readme.txt file is missing.
[code] => readme_missing
[http] => 400
[timestamp] => Sun, 06 Sep 2020 21:11:07 +0000
)

When I manually upload the zip to Freemius it is accepted. I know these are 2 seperated issues but maybe they are connected if it's not uploading anything.

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.