rescript-compiler icon indicating copy to clipboard operation
rescript-compiler copied to clipboard

automatically sync API docs on rescript-lang.org

Open tsnobip opened this issue 6 months ago • 1 comments

tsnobip avatar Jun 16 '25 16:06 tsnobip

@cknitt would be cool to have this merged before the next release so that it can be already testet fully.

fhammerschmidt avatar Jun 16 '25 21:06 fhammerschmidt

Open in StackBlitz

rescript

npm i https://pkg.pr.new/rescript-lang/rescript@7555
@rescript/darwin-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-arm64@7555
@rescript/darwin-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-x64@7555
@rescript/linux-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-arm64@7555
@rescript/linux-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-x64@7555
@rescript/win32-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/win32-x64@7555

commit: 931c6f8

pkg-pr-new[bot] avatar Jun 17 '25 08:06 pkg-pr-new[bot]

Does it really need to execute on every PR or is that just for testing? Because the sync step takes 2.45 minutes and only the commit and push part is omitted if it is not a tag build.

At least that part seems to work already :)

fhammerschmidt avatar Jun 17 '25 08:06 fhammerschmidt

Does it really need to execute on every PR or is that just for testing? Because the sync step takes 2.45 minutes and only the commit and push part is omitted if it is not a tag build.

At least that part seems to work already :)

@fham I think it's worth executing this on every PR in case of malformed docstrings. The cool thing is 2'26" taken by website build is only done when there are changes in docstrings! So the overhead is only a dozen seconds otherwise.

tsnobip avatar Jun 17 '25 08:06 tsnobip

Ok I missed that part. I guess then it's totally fine.

fhammerschmidt avatar Jun 17 '25 08:06 fhammerschmidt

I noticed image

on https://github.com/rescript-lang/rescript/pull/7554

@tsnobip is this too be expected?

nojaf avatar Jun 17 '25 08:06 nojaf

I noticed image

on #7554

@tsnobip is this too be expected?

@nojaf yeah I think so, we should only merge PRs that have valid docstrings, don't you think?

tsnobip avatar Jun 17 '25 08:06 tsnobip

@tsnobip got it! Was wondering if that did any actual syncing, which would be a little strange for a PR.

nojaf avatar Jun 17 '25 09:06 nojaf

@tsnobip got it! Was wondering if that did any actual syncing, which would be a little strange for a PR.

@nojaf you're right, should I rename the job?

tsnobip avatar Jun 17 '25 09:06 tsnobip

should I rename the job?

Yes, please, that would be less confusing.

nojaf avatar Jun 17 '25 09:06 nojaf