reactist icon indicating copy to clipboard operation
reactist copied to clipboard

Do we need built assets in git

Open gnapse opened this issue 5 years ago • 5 comments

⚙️ Improvement

I wonder if we need to have checked in git all the files generated from a build. That hasn't been my experience working in other libraries. Though I have to admit I am not knowledgeable at all when it comes to all the build/config parts of the job so I'm not even sure what the implications are in terms of publishing, etc.

gnapse avatar Jul 10 '20 14:07 gnapse

I think it's not needed for publishing as npm publish runs the prepare scripts which generates the assets. I'm not sure about linking reactist it into Twist / Todoist, but if that works let's go for it 👍

Also @vishnugopal in case I overlooked something

henningmu avatar Jul 13 '20 11:07 henningmu

Sorry to jump on the discussion. I don't want to be invasive.

I think the problem you could face by adding any generated files into Github is conflicts hard to resolve. It should not be a problem when it comes to the isolated components files but could be more difficult with file like dist/reactist.cjs.production.min.js or dist/reactist.cjs.development.js.

If the problem is about working on Reactist from other product

It is dangerous because you could rely too much on a certain app context but if still needed we use npm link

If the problem is to wait to have a release done before having it in other product

As soon you put in place a CI/CD you can have quick releases, maybe setup a beta build/tag on development branch and production tag on master could help to get it quicker to the end product without any effort.

Otherwise we use to target branches instead of tags which allow you to see it working on the end product.

For CI/CD at Quandoo, We use https://github.com/semantic-release/semantic-release for our design system and it is a really good tool. It comes with some requirements though such as following certain commits format.

If you are interested on the last point I could work on it, I already set it up for some of our products. But I think it would be an other issue.

clempat avatar Jul 15 '20 15:07 clempat

@clempat the discussion I brought up here is precisely towards ceasing to do this, which we already do. Sorry it was not clear from the original issue description, which I can see it is ambiguous and could be interpreted as proposing to do this. It is really proposing to stop doing it.

gnapse avatar Jul 17 '20 01:07 gnapse

Oh thanks for the precision @gnapse. I missed it because I was looking to the dist folder which is not there. But now I think I see what you mean.

So my new guess is you speak about the storybook static files (docs folder) which was probably done this way to be served by GitHub pages ?

https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/

clempat avatar Jul 17 '20 04:07 clempat

Linking Reactist into Twist or Todoist also should run prepare so +1 for this! 👏

vishnugopal avatar Jul 17 '20 04:07 vishnugopal