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

Automatic checks for docs changes #63

Open
ericvalcik opened this issue Jun 26, 2020 · 2 comments
Open

Automatic checks for docs changes #63

ericvalcik opened this issue Jun 26, 2020 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@ericvalcik
Copy link
Contributor

Create automatic checks for changes in referenced documentation. Add a time-triggered check for documentation changes. Travis build fails if documentation was changed.

@ericvalcik ericvalcik added the enhancement New feature or request label Jun 26, 2020
@ericvalcik ericvalcik self-assigned this Jun 26, 2020
@ericvalcik
Copy link
Contributor Author

I just got another idea.
What if the script for this feature would have a separate branch.

We would set a Cron job to this branch, and let the docs checker live alone in this branch. The notification setting would be easier like this because we would have two .travis.yml files. We wouldn't have to add any more code to the current Makefile and the periodic builds wouldn't have to build the entire repo every time.

Tell me what do you think.

@mukrop
Copy link
Member

mukrop commented Jul 17, 2020

I did not expect the cron job would build the whole repository. If we used Travis I would try to construct a conditional to just run the docs check (e.g. if travis-cron then ...).

However, it may be far easier to run the docs-checker using GitHub Actions. It's free and baked right into GitHub. Still quite new (so by far not as powerful as Travis) but has a much more elaborate system of pipelines and triggers (you can define multiple build recipes with different triggers running independently).

  • Downside: Splitting the build process on two platforms (at least for now).
  • Upside: The two builds have very different functionality and core (ruby vs. python), so running independently on different machines may actually be an efficient step.

Al in all, I would suggest you look into GitHub actions now to find out if it's good for us. We may eventually migrate the whole build process there but that is for decision later.

@mukrop mukrop assigned mukrop and unassigned ericvalcik Oct 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants