Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign updocs: re-introduce typedoc deploy using netlify/actions github actions #1501
Comments
|
Hey @acao , I would like to help with this issue
Line 6 in 91df084 So it is unclear to me , what i need to do, can you explain it further to me? |
|
awesome! glad to have help with this yes, previously we were doing this, however we would like to take a new approach now. we don't want to slow down the deploy previews any further, as they were ~8-10m with typedoc, possibly because of configuration issues that have been addressed, but it still adds ~2-3m to the build and breaks CI stability which as we all know is really helpful for highly collaborative projects. now they seem closer to 6m which is better. as you can see from recent action logs (which should be public, are they?), moving from jenkins to github actions allowed us to parralelize CI tasks better and increase overall speed down to 2 minutes. we are hoping to move more of this to github actions, as not all of what happens on netlify build for build preview so, for these things that don't need to be generated on every commit for the deploy-preview, we can use netlify's own action to be able to use netlify cli commands and actions to publish the typedoc using just github actions instead of netlify's own build system (faster). Then, we can add oother things that are or have been a part of deploy preview to parallel actions. the other advantage is that we can deploy the API docs to a seperate site than the deploy preview, and we will probably create even more sites that are generated by this repo soon. |
|
@acao Got it.
Yup they are public and I can see the build times being 2-3 min.
I have made a workflow based on my understanding.
|
we used to publish at our deploy preview/lsp, however I think just publishing on each merge to master is fine for the time being. we were having issues that were slowing down the netlify build. i would like to break out the netlify config into seperate actions using the cli action. the root package.json script is just
build-docs