DIY CI - Revision history

Admin: /* Github bot */

2018-08-05T03:29:11Z

Github bot

← Older revision		Revision as of 03:29, 5 August 2018
Line 54:		Line 54:

	Related: [[Github/Bots]]		Related: [[Github/Bots]]




			=Flags=

			[[Category:CI]]
			[[Category:Github]]
			[[Category:Bots]]

Admin at 02:44, 5 August 2018

2018-08-05T02:44:01Z

← Older revision		Revision as of 02:44, 5 August 2018
Line 52:		Line 52:

	Head over to [[Markdown Cleanup Github Bot]]		Head over to [[Markdown Cleanup Github Bot]]

			Related: [[Github/Bots]]

Admin: /* Infrastructure */

2018-08-04T19:07:59Z

Infrastructure

← Older revision		Revision as of 19:07, 4 August 2018
Line 48:		Line 48:
	** build site/		** build site/
	** deploy site/ (optionally, to heroku)		** deploy site/ (optionally, to heroku)

			===Github bot===

			Head over to [[Markdown Cleanup Github Bot]]

Admin: /* Infrastructure */

2018-08-04T19:07:28Z

Infrastructure

← Older revision		Revision as of 19:07, 4 August 2018
Line 37:		Line 37:

	Markdown cleanup github bot:		Markdown cleanup github bot:
	* waits for a mention		* when mentioned on a PR, it will apply a commit that cleans up the markdown to any markdown files changed in the given PR
	* when a ~~mention is made~~, it will apply markdown ~~cleanup (but ONLY~~ to files changed in the given ~~pull request)~~

	Captain Hook:		Captain Hook:

Admin: /* Infrastructure */

2018-08-04T19:06:54Z

Infrastructure

← Older revision		Revision as of 19:06, 4 August 2018
Line 36:		Line 36:
	===Infrastructure===		===Infrastructure===

	Markdown cleanup bot:		Markdown cleanup github bot:
	* waits for a mention		* waits for a mention
	* when a mention is made, it will apply markdown cleanup (but ONLY to files changed in the given pull request)		* when a mention is made, it will apply markdown cleanup (but ONLY to files changed in the given pull request)

Admin: /* Infrastructure */

2018-08-04T19:06:37Z

Infrastructure

← Older revision		Revision as of 19:06, 4 August 2018
Line 36:		Line 36:
	===Infrastructure===		===Infrastructure===

	Markdown bot:		Markdown cleanup bot:
	* waits for a mention		* waits for a mention
	* when a mention is made, it will apply markdown cleanup (but ONLY to files changed in the given pull request)		* when a mention is made, it will apply markdown cleanup (but ONLY to files changed in the given pull request)

Admin: /* The Scenario */

2018-08-04T19:05:05Z

The Scenario

← Older revision		Revision as of 19:05, 4 August 2018
Line 7:		Line 7:
	The first example we focus on here is building documentation.		The first example we focus on here is building documentation.

	===~~The~~ Scenario===		===Scenario===

	The scenario is, we have multiple repositories full of markdown documents, and we want to build them into a single static site using mkdocs.		The scenario is, we have multiple repositories full of markdown documents, and we want to build them into a single static site using mkdocs.

Admin: Created page with "=Do-It-Yourself Continuous Integration= This page covers notes on creating a homebrew continuous integration server. ==Documentation Builds== The first example we focus on..."

2018-08-04T19:04:54Z

Created page with "=Do-It-Yourself Continuous Integration= This page covers notes on creating a homebrew continuous integration server. ==Documentation Builds== The first example we focus on..."

New page

=Do-It-Yourself Continuous Integration=

This page covers notes on creating a homebrew continuous integration server.

==Documentation Builds==

The first example we focus on here is building documentation.

===The Scenario===

The scenario is, we have multiple repositories full of markdown documents, and we want to build them into a single static site using mkdocs.

We create each repository full of markdown files. Then we create a master www repository that is set up like a normal mkdocs repository - it has an mkdocs.yml file, a docs/ folder, and an mkdocs theme, and it builds the documentation into site/.

In the docs/ folder, each repository with markdown files is set up as a submodule of the main www repository. In this way, changes to the markdown files in those repositories will be automatically reflected in the parent www repository.

To build the docs, we just run the mkdocs command. This builds the documentation into site/.

===The workflow===

What is the workflow that we want?

In the documentation repositories full of markdown files:

* Users will create a branch, edit documents, create a pull request
* Pull requests are reviewed and merged into master when ok
* When a pull request is open, there should be functionality to apply markdown cleanup (and also to keep making modifications, i.e., to reverse any changes)

In the www repository:

* When changes are pushed to master branch of any submodule:
** update submodule
** rebuild site
** redeploy site

===Infrastructure===

Markdown bot:
* waits for a mention
* when a mention is made, it will apply markdown cleanup (but ONLY to files changed in the given pull request)

Captain Hook:
* flask hook server running in container
* listens for incoming web hook
* hook scripts will:
** clone private www
** update the submodule and commit
** clone site/
** build site/
** deploy site/ (optionally, to heroku)