search

bible-technology / scripture-burrito

Scripture Burrito Schema & Docs 🌯
http://docs.burrito.bible/
MIT License
21 stars 13 forks source link

Create Github Action for Validation #199

Closed jag3773 closed 4 years ago

jag3773 commented 4 years ago

For all of the issues in https://github.com/bible-technology/scripture-burrito/milestone/6 it would be a lot easier to setup automated validation if we had a Github Action that we could apply to the repositories.

Alternately, we could copy our Travis CI configuration but since Github Actions are an integrated service it seems preferable to go that route.

jag3773 commented 4 years ago

Consider whether this should include setting up some sort of "mega schema" that is one file including all the relevant pieces of the schema.

jag3773 commented 4 years ago

I setup an example action which tests against the develop branch of SB.

I ran it against develop because I'm assuming we will want to do releases of the schema in conjunction with updated example repositories. Hence, tying these examples repos to develop seems like the best way to keep them in sync.

Note that I also converted the validation running in this repository to run via Github Actions too (#202 ).

jag3773 commented 4 years ago

Steps to setup this github action on your example repo would look something like this...

  1. Click Actions on your repo page.
  2. Click "Skip this and set up a workflow yourself "
  3. Copy the text from https://github.com/bible-technology/sb_textStories/blob/master/.github/workflows/main.yml and paste into your edit window.
  4. Click "Start Commit" in the upper right.
  5. Put your changes on a new branch and start the PR
  6. Open the README.md in your new branch and put the badge code at the top, something like this (substituting your repo's name):

[![CI](https://github.com/bible-technology/sb_textStories/workflows/CI/badge.svg?branch=master)](https://github.com/bible-technology/sb_textStories/actions)

Finally, merge your PR and verify that you've got CI badge that shows passing.