DEV Community

Cover image for Working on Github Actions - Update 2 (Beta Release)
Prafulla Raichurkar
Prafulla Raichurkar

Posted on

Working on Github Actions - Update 2 (Beta Release)

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 prafulla-codes / 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


Whats New?

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
Enter fullscreen mode Exit fullscreen mode

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 :)

Discussion (0)