search

lifechurch / youversion-web-open-ideas

Ideas, problems, and puzzling things that are open for volunteer involvement. See the issues page for open ideas, and create a pull request if you have a solution!
https://www.youversion.com/volunteers/
Apache License 2.0
39 stars 18 forks source link

Setup Deployment and CI/CD for this Repo #3

Closed michael-martin-al closed 6 years ago

michael-martin-al commented 6 years ago

I don't think this can be completed until #2 is merged.

Background

The purpose of this repo is to create a sandboxed environment for creating (mostly) React components that will be used on Bible.com and various other YouVersion web applications. So, this site doesn't need to be 💯 rock solid. We just need a fast and easy way for contributors to try out / demo their work on a site. The ultimate goal to create as simple a process as possible.

Suggested Approach

There are lots of ways we could go with this, but I believe Netlify would be the easiest to get started. We can always change it later if it doesn't meet our needs.

TODO

Need Help?

I realize that someone may need elevated privileges to this repo in order to make this happen because of the OAuth flow that needs to happen. Just let me know what you need.

glasssd commented 6 years ago

@michael-martin-al I was able to deploy my fork to Netlify (https://boring-pare-ddcd15.netlify.com/) and Heroku (https://youversion-web-open-ideas.herokuapp.com/). Not sure if that's an option or not. This is way outside of my experience, so I wouldn't claim it has the best settings, but both sites seem to work. If it helps, I can write up the steps I followed for whenever a github admin has time to hook up the repository.

adamaverycole commented 6 years ago

That’s great, @glasssd!

michael-martin-al commented 6 years ago

@glasssd thanks for putting some effort into this. After reading your comment, I went into Netlify and connected up our repo. Everything seems to be running fine. We're even able to see preview deploys for pull requests.

glasssd commented 6 years ago

@michael-martin-al sorry for the delay. I captured screenshots for each step, but I hadn't figured out how to post them. I was thinking that the instructions might help those contributors that want to deploy their forks and provide a sample URL as part of PR submission.

michael-martin-al commented 6 years ago

That's my fault @glasssd. I created an issue that mostly required work by someone with access to this repo. I think that Netlify is now automatically deploying a contributors fork when they submit a PR and automatically putting a link into the PR. But, I still think your instructions will be useful for people who aren't ready to submit PRs yet. I'll re-open this issue.

glasssd commented 6 years ago

@michael-martin-al, I'm afraid I'm stuck. Do you think we could enable the repository's wiki (settings -> features)? I have the deployment instructions written with a series of screenshots, but I don't see a clean way to serve up the images. I first tried a markdown page with embedded data uri images, but GitHub appears to short-circuit that because of fear of a SVG vulnerability. I next tried an HTML page, but of course that doesn't actually render the HTML. <duh> 🥇 Use of the wiki appears to be the preferred venue for this sort of documentation. Thanks!

michael-martin-al commented 6 years ago

✅ wiki.enable()

glasssd commented 6 years ago

@michael-martin-al , the wiki tab is visible, but disabled. After some experimentation, I think I'm still going to have a problem with hosting the images, even there. The hack around this limitation appears to be to upload the images either as issues or comments. (http://blog.davidebbo.com/2014/11/using-issues-for-github-pages-screenshots.html and https://haacked.com/archive/2013/12/02/dr-jekyll-and-mr-haack/#comment-1148987401). I'm going to use this issue rather than one from my personal repository in case I "win the lottery".

netlify_01 netlify_02 netlify_03 netlify_04 netlify_05 netlify_06 netlify_07 netlify_08 netlify_09 netlify_10