Skip to content
This repository has been archived by the owner on May 18, 2021. It is now read-only.

Create script to publish Generated API docs #3

Open
mlvandijk opened this issue Sep 18, 2017 · 0 comments
Open

Create script to publish Generated API docs #3

mlvandijk opened this issue Sep 18, 2017 · 0 comments

Comments

@mlvandijk
Copy link
Contributor

mlvandijk commented Sep 18, 2017

When we make a release, the javadocs/scaladocs/yardocs are published as zip files alongside the jars.
If we should just pull down those jars post release, unzip them and add them to git? That can be done with a script.

Part of the cucumber-jvm release process would be to switch to your api.cucumber.io working copy and run a script. That script would download generated docs and add them to git. Then you push. For cucumber-ruby it would be similar.

Aslak recommends this:

  1. Manually download zip files with javadocs, expand and add to git.
  2. Automate that process with a script
  3. Update release process doc with instructions how to run the script.

We could use bash scripting and/or make for this kind of stuff. It would be using curl to fetch docs.

@mlvandijk mlvandijk changed the title Create script to publish javadocs Create script to publish Generated API docs Sep 25, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant