Git Product home page Git Product logo

currentsee's Introduction

Current See plugin for Craft CMS 3.x

Plugin to generate externally accessible feed of versions

Screenshot

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project
    
  2. Then tell Composer to load the plugin:

     composer require ournameismud/current-see
    
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Current See.

Current See Overview

This plugin is designed to scan your Craft build to see what updates are needed and generate an XML feed for those that are out of date. This can ideally be used with services like IFTTT eg to post to Slack or send email notifications.

Configuring Current See

Before using you will need to generate an Api Key for use by the plugin.
Go to Plugin > Settings and save an Api Key. One will automatically be generated for you or add your own.

Using Current See

There are two controller actions currently employed by the plugin. One to scan the Craft installation and the other to provide the feed.

Scan Craft

Because checking Craft versions requires several curl requests to the Craftnet API this service is set to run as background tasks.

The best way to trigger this controller action would be to set a CRON job to call it periodically. This is done by hitting the following action: http://[domain.com]/actions/current-see/default/check?key=[XXX]. Obviously you want to replace [domain.com] with your domain name and [XXX] with the API key saved in your plugin settings. If there is a discrepancy with the local plugin version and that reported by the Craftnet API then a record of this will be saved locally.

Feed Output

You can monitor the output of the feed by using the following controller action: http://[domain.com]]/actions/current-see/default/feed?key=[XXX]. This will be populated with those plugins (and the Craft CMS) that require updating.

Current See Roadmap

Some things to do, and ideas for potential features:

  • Release it

Brought to you by @cole007
Logo by Andrejs Kirma @ Noun Project

currentsee's People

Stargazers

Sean P. Myrick V19.1.7.2 avatar

Watchers

James Cloos avatar Cole Henley avatar David Wood avatar Sean P. Myrick V19.1.7.2 avatar

Forkers

seanpm2001

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.