Create a GitHub issue block

bobbingwide / oik-blocks

WordPress 5.0 blocks for oik shortcodes

https://oik-plugins.com/oik-plugins/oik-blocks

GNU General Public License v3.0

1 stars 0 forks source link

Create a GitHub issue block #4

Closed bobbingwide closed 2 years ago

bobbingwide commented 6 years ago

Requirement

An easy way to produce links to issues on GitHub

Prototype solution

Initially the GitHub block will simply contain HTML to invoke the [github] shortcode ( from oik-bob-bing-wide )
The only variable will be the issue number - the 4th parameter to the shortcode
This needs to be extended so that multiple issue numbers may be entered

Future solution

It should detect URLs pasted into the content and automatically update the block
Or support conversion from a GitHub link to a block.
Or just detect #xxxx in the same way that GitHub does.

bobbingwide commented 6 years ago

In 2.3 the GitHub block produces a deprecated message in the console

wp.blocks.InspectorControls.TextControl is deprecated and will be removed from Gutenberg in 2.4. Please use wp.components.TextControl instead.

The code will need to be changed as indicated.

bobbingwide commented 5 years ago

While updating the block for Gutenberg v4.0.0 compatibility make minor improvements that will eventually allow the block to support the parameters already supported by the shortcode. i.e. Add defaults for owner, repo and type. These could then be displayed and edited in the Settings area, with defaults potentially being sourced from post meta data / options. See #16.

To support multiple issues we should extend the shortcode logic.

Note: The logic to embed the GitHub issue could use logic like WebDevStudios github-gist block.

bobbingwide commented 5 years ago

See the wp-github-oembed project for a WordPress plugin that uses GitHub's oembed API. e.g. This issue is returned in JSON using... https://api.github.com/repos/bobbingwide/oik-blocks/issues/4

bobbingwide commented 5 years ago

make minor improvements that will eventually allow the block to support the parameters already supported by the shortcode. i.e. Add defaults for owner, repo and type.

As part of an investigation to implement internationalisation I've added Owner and Repo fields to the block.

bobbingwide commented 2 years ago

The GitHub block is now in oik-bob-bing-wide. See https://github.com/bobbingwide/oik-bob-bing-wide/issues/25