Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub Actions to test build and parsing pipelines #8

Open
ovflowd opened this issue May 30, 2024 · 1 comment
Open

Add GitHub Actions to test build and parsing pipelines #8

ovflowd opened this issue May 30, 2024 · 1 comment

Comments

@ovflowd
Copy link
Member

ovflowd commented May 30, 2024

We want to add a GitHub Actions pipeline that triggers on a new commit on main of nodejs/node to:

  • Retrieve the repo contents at the time of the commit (git checkout or fetch or whatever) (our goal are the API docs)
  • Runs the CLI for the API Doc Tooling giving the input glob and output directory
  • Generates the MDX as an output target to begin with
  • Verifies that all files were generated
  • Produces an artifact with a zip of the generated files?
@AugustinMauroy
Copy link
Collaborator

I don't really understand this issue, the goal is to fetch the doc (which is on the nodejs/node repo) into this repo to generate an artifact output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants