vipickering / mastr-cntrl

A Micropub Microservice
MIT License
26 stars 2 forks source link

Try supporting https://github.com/voxpelli/node-github-publish #67

Closed vipickering closed 5 years ago

vipickering commented 5 years ago

It would be cleaner to use a repo that has already worked out most of the Github kinks, than rolling my own PUT/POST requests each time.

vipickering commented 5 years ago

Doesn't meet my needs unfortunately.

paulrobertlloyd commented 5 years ago

I was looking to possibly adopt this for my own project, but it needs to include support for deleting files first (and I’m considering making a pull request to add this). Is this what you require, too?

Also, I’m unsure whether it’s better to use direct REST methods (which this module uses), or interact using GitHub’s official module. I’m using that at the moment, and it provides additional logging and rate limiting features, which may come in useful later.

voxpelli commented 5 years ago

I’m not unreasonable when it comes to features and tweaks :)

I do as we do in the IndieWeb community though and dogfood stuff for myself, so I won’t add stuff unless someone asks for it or I need it myself.

Care to share what you found missing?

vipickering commented 5 years ago

@voxpelli I really liked the neatness, and your implementation. It would be helpful for the readme to contain a few examples around using the options in brackets. It wasn't clear from the docs what markup I needed to pass in and what format was expected.

On the reasons why I initially decided not to implement it at this time (and feel free to correct me if I'm wrong!):

I couldn't find a way to push to branches specifically. I've found it really helpful when testing code and I need to see the outcome finished in Github, to use a environmental variable for my branch and swap it over to a dev branch so I can run end-to-end tests and not accidentally deploy anything. I was expecting this to be on the options, but I couldn't make it work.

As well as @paulrobertlloyd delete is something I want to add soonish, specifically in relation to deleting webmentions (if someone sends me a request). It looks like the module does a PUT request, but not an Update/Post or a Delete? I wasn't sure if the purpose of this module, is simply create and post. Or if you were wanting to do more.

In terms of using this module I would be using it for Adding, Updating and Deleting Webmentions (which I save as json files), as well as creating and updating posts.

@paulrobertlloyd I initially looked at the official Github module as well, at first I thought it might be overkill. But as my offering has matured (and my confidence!) I'm doing more and more. Is it meeting your needs?

voxpelli commented 5 years ago

The lack of branch-pushing is just a shortcoming of the Readme, because it is implemented and works: https://github.com/voxpelli/node-github-publish/blob/ded7f9735019b5fc1221a6a5d18d3aaaf3f8f36c/index.js#L12

I would consider all CRUD methods for content to be within the scope of the module and I will eventually need deletions as well, so it should get in there eventually one way or another – either by PR or that I eventually do it myself.

voxpelli commented 5 years ago

Any update on reasoning @vipickering that had you close this again? 🙂

vipickering commented 5 years ago

I accidentally opened it when I commented last time, I'm just keeping open the tasks that are "what I want to pick from next". My time is limited to short bursts (an hour here or there at the moment) So I'm just keeping open tasks that are still being brain dumped or shorter things I want to pick up next.