loading...
Cover image for Working on Github Actions - Update 2 (Beta Release)

Working on Github Actions - Update 2 (Beta Release)

pika1998 profile image Prafulla Raichurkar ・1 min read

It's been a while since I started working on express-autodocs, A GitHub action that generates documentation by scanning express APIs.

Today I would like to gladly share the first public version of the action with the DEV community πŸŽ‰πŸŽŠ

GitHub logo Pika1998 / express-autodocs

A GitHub action which automatically generates documentation for your express APIs.



Contributions

πŸ’‘ Introduction

This action automatically scans for express APIs in your codebase and generates a documentation website


How to add to your workflow ❔

To add this action to your workflow simply modify your workflows main.yml file.

# This is a basic workflow to help you get started with Express AutoDocs Action
name: Express AutoDocs.
# This specifies when the action should occur
on
  push
    branches: [master]

jobs:
  generate_docs_job:
    runs-on: ubuntu-latest
    name: Generating Docs
    steps:
      # this step checks out the master branch of your repo using checkout action.
      - name: Checks out the repository
        id: checksout-repository
        uses: actions/checkout@v2
        with:
          repository: ""
      # this step generates the docs
      - name: Generating Docs.
        id: reading-file
        uses: Pika1998/express-autodocs@v0.0.1
      # Use the output from the `hello` step
      - name: Get the output time
        run
…

Here is the working demo:

βœ… Tested on Repository

Processing Output
Processing output

Outputs

docs/readme.md
Readme

docs/pages/api-items.md
api-items route

πŸ’– Feel free to try out this action & share your opinions about it :)

Posted on by:

pika1998 profile

Prafulla Raichurkar

@pika1998

Developer. 21 y/o IT Engineering Student

Discussion

pic
Editor guide