Dealing with breaking changes

michael / hub

Substance Hub

6 stars 0 forks source link

Dealing with breaking changes #45

Open michael opened 11 years ago

michael commented 11 years ago

We need a better way to coordinate breaking changes on the API side. At least for me it is quite hard to keep up with a number of API changes that need to be reflected on the composer side.

My suggestion: Let's try to apply API changes in smaller increments, so we can nail them one by one.

Proposed workflow:

Suggest an API change using a GitHub Issue. E.g. POST /register -> POST /users
Coordinate implementation, so the change is reflected in both repos (hub, composer)
Close Issue

Thoughts?

vectorsize commented 11 years ago

Totally agree – this sort of things can block everyone else's work…

michael commented 11 years ago

Once I'm ready adapting the new API I'm going to host a bleeding edge hub on the substance server.

Will be available at: http://edge.substance.io or http://substance.io:3001

Maybe we should also look into some continuous integration solutions. Something like this:

Every push to hub:master triggers a deploy to edge.substance.io
However the deploy only happens if the testsuite passes through
If there are errors we should be able to easily check the log on a webinterface (e.g. http://edge.substance.io/status)

Much like of Github's "battlestation fully operational".

Will need some time to set this up. But I guess this could be incredibly helpful for speeding up development.

yuchi commented 11 years ago

About APIs changes: totally agree. I'm sorry for what happened in the last refactor. The testsuite is also there to consolidate development.

About CI: that's perfect. I'm a little bit worried about the database. Is it going to be a different one?

michael commented 11 years ago

Yeah it's a different database for our staging environment.

I just got the new server instance live:

See: http://edge.substance.io (you can also access the admin panel -> http://edge.substance.io/admin)

michael commented 11 years ago

@yuchi I like how the admin panel looks. Now I see why bootstrap is a good idea here. :)

yuchi commented 11 years ago

I hate Bootstrap... but god it's so fast to work with :\

vectorsize commented 11 years ago

yeah @yuchi but any of the like are the same, just keeps you up and running quick… I had bookmarked other possible alternatives. [edit] removed the links, these where not the ones haha