Skip to content
This repository was archived by the owner on Jul 1, 2024. It is now read-only.

Improve publish workflow#10

Open
marcokrikke wants to merge 7 commits into
developmentfrom
fb_gh-workflow
Open

Improve publish workflow#10
marcokrikke wants to merge 7 commits into
developmentfrom
fb_gh-workflow

Conversation

@marcokrikke

@marcokrikke marcokrikke commented Oct 4, 2019

Copy link
Copy Markdown
Member

Proposed changes

The API specs project now uses Github Workflows to lint, build and publish the resulting documentation.

Changes in this PR:

  • Run a lint action on push to any branch.
  • Build documentation to a build directory when pushed to master branch.
  • Push the contents of the build directory to the gh-pages branch. This seems to be best practice when manually including assets (see next change).
  • Use a static JS asset for ReDoc, instead of a version from a CDN. The standalone ReDoc version is pulled from NPM (as suggested by the ReDoc documentation) and put into an assets folder.
  • Remove Travis CI build.

Testing

Tested using the branch of this PR as the Github Workflow trigger.

Documentation

README has been updated.

Upgrade notes for breaking changes

  • UPGRADE_NOTES.md has been updated (when applicable).

@marcokrikke
marcokrikke force-pushed the fb_gh-workflow branch 2 times, most recently from ca92d89 to ba1c2a2 Compare October 4, 2019 12:58
@marcokrikke marcokrikke changed the title Deploy Github Pages using Github Workflow Improve lint and deploy workflow Oct 4, 2019
@marcokrikke marcokrikke mentioned this pull request Oct 4, 2019
1 task
@marcokrikke marcokrikke changed the title Improve lint and deploy workflow Improve publish workflow Oct 4, 2019
@marcokrikke
marcokrikke requested a review from evpaassen October 4, 2019 13:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants