search

chaincodelabs / onboarding-to-bitcoin-core

The missing onboarding guide to Bitcoin Core
https://bitcoincore.academy
91 stars 37 forks source link

Setup CI/CD #54

Closed adam2k closed 1 year ago

adam2k commented 1 year ago

Problem:

This repo currently does not have any CI/CD. It is a manual build and deploy process. If the person(s) responsible for managing this repo are unavailable then no code changes can be deployed.

Suggestion:

  1. Enable GitHub pages for the main/master branch for this repo
  2. Point the CNAME subdomain records to the Github location. Read the docs here
  3. Setup Github Actions to run the build command asciidoctor -r asciidoctor-diagram index.adoc. Something like this could be a good starting point

Alternate Suggestion:

If steps 1 and 2 are inappropriate then Github Actions could still be used to deploy the built index.html to the current hosting location, but will require some extra Github Actions and some access keys to be added to this repository secrets under the admin Settings page.

willcl-ark commented 1 year ago

Hey @adam2k got round to trying to implement this now and feel like I might be in need of some assistance, if you're available and interested in helping?

I've got the basic stuff setup, but struggling to get mmdc, which is used to generate mermaid diagrams, setup inside the alpine Linux docker...

Unhelpfully, I am something of a docker noob :/

adamjonas commented 1 year ago

closed via #60, fe2ed8c775903ab11a7ede07bd3910e51652e9fd and 6179061e7490b5e1073e3637668754932537612c