developmentseed / developmentseed/osm-teams

Auto-update API docs version on develop branch

Open
#401 0 comments 0 reactions 0 assignees View on GitHub
Category: Documentation
Dominant language
JavaScript
Stars
29
Forks
4
PR merge metrics
No merged PRs in 30d

Description

In release v2.1.0 we merged `develop` to `main` without updating API docs version in `next-swagger-doc.json`. It is easy to forget to update that file, so I suggest we add a Github Action step to update it automatically. The algorithm would be something like this:

- on commit to `develop` branch
- run `yarn docs:validate` (this task auto-update `next-swagger-doc.json` with `package.json` version)
- commit file `next-swagger-doc.json` if changed

cc @kamicut @batpad

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading package.json and the existing GitHub Actions workflows, then run yarn docs:validate to observe how next-swagger-doc.json changes from the package version. The work is done when commits to develop trigger the validation and any changed next-swagger-doc.json is committed automatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, javascript
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.