feat(scripts): push to docs on release #3196
Conversation
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
44823d4 to
ed6ad01
Compare
| @@ -145,9 +145,15 @@ async function transformBundle({ | |||
| : ({} as SnippetSamples); | |||
|
|
|||
| if (docs) { | |||
| const snippets = transformCodeSamplesToGuideMethods(JSON.parse(JSON.stringify(snippetSamples))); | |||
| // the JS file will be removed once algolia/doc leverages the JSON one | |||
There was a problem hiding this comment.
we should support the JSON one you mean, the js one is for our doc.
There was a problem hiding this comment.
Yes but the JS one will be removed once the doc is live that's what i meant
There was a problem hiding this comment.
so we plan on removing our doc entirely ? :(
There was a problem hiding this comment.
Yup at least for GA, @kai687 has great plans for it!
| @@ -0,0 +1,92 @@ | |||
| /* eslint-disable no-console */ | |||
There was a problem hiding this comment.
which version of the file did you take for this ? there was a lot of bug fixes done to the previous one
There was a problem hiding this comment.
I think the last but you are right I'll double check!
| await run(`cp ${toAbsolutePath('specs/bundled/*.doc.yml')} ${dest}`); | ||
| await run(`cp ${toAbsolutePath('config/release.config.json')} ${dest}`); | ||
| await run(`cp ${toAbsolutePath('website/src/generated/*.json')} ${dest}`); |
There was a problem hiding this comment.
the snippets are already contained in the bundled spec, is it necessary to also send the json file ?
There was a problem hiding this comment.
Yup it's so that they can leverage the JSONs for the guides like we did!
There was a problem hiding this comment.
we had to do this to have both the snippets for redoc, and the snippets for custom guide, are they using the same techno ?
There was a problem hiding this comment.
Yup! Given the time constraint it seems like the better, wdyt?
There was a problem hiding this comment.
I don't know how well this will work with ruby but why not !
There was a problem hiding this comment.
I believe fine, since it's simple json input but at least it gives @kai687 the opportunity to try the current solution
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-2458
Changes included:
bring back our beloved spread script, which publishes to the official documentation:
we only spread after a successful release, see example PR here: https://github.com/algolia/doc/pull/9098