Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to Github action #172

Merged
merged 2 commits into from
Apr 20, 2022
Merged

Switch to Github action #172

merged 2 commits into from
Apr 20, 2022

Conversation

aniewielska
Copy link
Contributor

This PR changes the CI engine for automatic documentation build from Travis to Github Actions,
Inspired by similar initiatives for TRS and especially DRS.

Points to consider:

  • the build is only going to happen on push to any of the branches. The original build process was additionally fired for PRs, but did not commit built docs to Github pages.
  • It seems that building and publishing docs for PRs was not taken into consideration by gh-openapi-docs. Introducing it for PRs from branches would be straightforward, for instance by publishing preview of docs under a PR number, but brings not much value (branches are built and published anyway).
  • Introducing building and publishing docs for PRs from forks is a potential security issue and requires bypassing GH actions built-in security measures (more here).
  • If the build without publishing was supposed to work as a validator for PRs, it would be probably a better idea to introduce a dedicated validation GH Action (on my TODO list).
  • contributing doc needs an update, as it still mentions Travis there.
  • there is a Travis badge in read.me.
  • in order to have all the existing PRs where the build failed built in the new system, this PR should be merged first (which branch?) and all the other branches rebased on top of it.

@kellrott kellrott merged commit 53627cb into develop Apr 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants