talawa-api icon indicating copy to clipboard operation
talawa-api copied to clipboard

Published 20 hours ago • verified publisher icon PalisadoesFoundation

CI/CD pipeline for generating JSDoc artifacts used for automating documentation

Open DMills27 opened this issue 3 years ago • 6 comments

Following https://github.com/PalisadoesFoundation/talawa-api/issues/474, create a pipeline to run the jsdoc command for any files that get approved in a pull request. After the command has been run, the artifact HTML files generated from this should then be added via a pull request to the path docs/talawa-api/ in the Talawa Docs repo (https://github.com/PalisadoesFoundation/talawa-docs).

Parent Issue:

  • https://github.com/PalisadoesFoundation/talawa-docs/issues/188

Sister Issue:

  • https://github.com/PalisadoesFoundation/talawa-api/issues/474

DMills27 avatar Feb 18 '22 01:02 DMills27

i would like to work on this

akshatgarg12 avatar Mar 11 '22 12:03 akshatgarg12

Screenshot 2022-03-14 at 12 17 09 PM Is this the correct flow?

akshatgarg12 avatar Mar 14 '22 06:03 akshatgarg12

Also should we configure this whole action to trigger on push on develop branch, because it only makes sense to update the docs if the code is merged in the develop branch of talawa-api.

akshatgarg12 avatar Mar 14 '22 07:03 akshatgarg12

@akshatgarg12 Are you still working on this? Did you get a response from @DMills27?

palisadoes avatar Mar 29 '22 16:03 palisadoes

This issue did not get any activity in the past 60 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

github-actions[bot] avatar May 29 '22 00:05 github-actions[bot]

Hello @akshatgarg12 , I am unassigning you due to no activity.

SiddheshKukade avatar Dec 03 '22 09:12 SiddheshKukade

Is this issue still open for contribution or its been solved?

If it's open can I work on it? I've worked on Github Actions for a while now!

StarTrooper08 avatar Jan 29 '23 09:01 StarTrooper08

Assigned to you. Now you can work on this.

noman2002 avatar Jan 29 '23 09:01 noman2002

This issue did not get any activity in the past 14 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

github-actions[bot] avatar Feb 13 '23 00:02 github-actions[bot]

@tasneemkoushar should we close this as we are migrating to TSDocs?

palisadoes avatar Feb 19 '23 17:02 palisadoes

unassigned due to inactivity.

noman2002 avatar Feb 19 '23 18:02 noman2002

Is this issue still open?

KrutikaBhatt avatar Mar 02 '23 10:03 KrutikaBhatt

Yes, but it should be closed as we are now using TSDocs

palisadoes avatar Mar 02 '23 10:03 palisadoes

@tasneemkoushar Should is there another issue for this for TSDoc? If not, should we create it?

palisadoes avatar Mar 02 '23 10:03 palisadoes