setup relase script - Githubissues

envato-archive / guide

Document your application with a living component library and styleguide

https://rubygems.org/gems/guide

MIT License

8 stars 3 forks source link

setup relase script #67

Closed fraserxu closed 3 years ago

fraserxu commented 8 years ago

Why?

Currently we keep the compiled assets in the git repo, which is generating a lot of noise in git diff and make code review hard.

This pull request

add the bootstrap.sh which is used to setup the development environment, including Ruby, bundle, npm, and install the needed dependencies, the goal is make it more easy to get started
add the release.sh script which will run javascript code lint, unit test, build the front-end assets, so no more annoying git diff in pr.

TODO:

[ ] add gem spec to release.sh
[ ] add git tag task and gem release task
[ ] add application.js and application.css to .gitignore

Need some Ruby ❤️ to help me with the gem part.

cc/ @lukearndt @jordanlewiz @zubin @jacobbednarz @thefoxis

thefoxis commented 8 years ago

hard agree to not committing compiled assets. I think when I was reading the diff once I mistaken app/assets/stylesheets for the place I should be writing styles in :sweat: so great idea :+1:

zubin commented 8 years ago

@fraserxu I don't understand the context. Is there some reason we're not using sprockets and rails asset pipeline?

fraserxu commented 8 years ago

@zubin Great question! I think the main reason is to separate the front-end code completely from sprocket, having a separate setup means the front-end team could choose the tools and framework to get the job done, and embrace best practises of the current front-end ecosystem(we're using postcss here for example which is not easy to do with sprockets at least).

There's also lots of history reasons behind the marketplace project and we are doing the same thing for it. This project maybe small enough that we probably don't need to worry about it, but we want to strech our skills and probably learn something new from it.

Last but not least, this is gonna to be an open source project, we want our front-end stack could as shine as the back-end. :D

jordanlewiz commented 8 years ago

@fraserxu I don't understand the code but I applaud the direction this PR is taking.

Also 💯 to

we want to stretch our skills and probably learn something new from it.

zubin commented 8 years ago

@fraserxu Thanks for explaining the motivation; I support that!

orien commented 3 years ago

In #101, the Ruby gem release process has been updated to generate assets. We no-longer need the scripts proposed in this PR. To release:

Update the gem version, commit, and run:

rake release