From 336b488d70038a9b54ec9cd5e57c7edc0549bf62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20Ku=C5=9B?= Date: Fri, 17 Mar 2017 16:18:52 +0100 Subject: [PATCH 1/6] Create buddyworks Added description for configuring a Jekyll build using a free https://buddy.works project. --- docs/_docs/continuous-integration/buddyworks | 63 ++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/_docs/continuous-integration/buddyworks diff --git a/docs/_docs/continuous-integration/buddyworks b/docs/_docs/continuous-integration/buddyworks new file mode 100644 index 00000000..45daa1f2 --- /dev/null +++ b/docs/_docs/continuous-integration/buddyworks @@ -0,0 +1,63 @@ +--- +title: "BuddyWorks" +--- + +[BuddyWorks][0] is a [Docker][1]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][2], [Bitbucket][3], and [GitLab][4] repositories, can be installed on-premises or in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project. + +[0]: https://buddy.works +[1]: https://www.docker.com/ +[2]: https://github.com +[3]: https://https://bitbucket.org/ +[4]: https://gitlab.com + +## 1. Getting started + +1. Log in at with your GitHub/Bitbucket account or email +2. Choose your Git provider and select or push your Jekyll Project +3. Create a new pipeline and set the trigger mode to 'On every push' +4. Add the Jekyll action and save the pipeline + +## 2. How it works + +Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][0]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and Cloud services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server. + +![Jekyll Build](https://buddy.works/data/blog/_images/buddyworks-jekyll-small.png) + +[0]: https://hub.docker.com/r/jekyll/jekyll/ + +## 3. Using YAML for configuration + +If you prefer configuration as code over GUI, you can generate `buddy.yml` that will create a pipeline with the Jekyll action once pushed to the repository: + +```ruby +- pipeline: "Build and Deploy Jekyll site" + trigger_mode: "ON_EVERY_PUSH" + ref_name: "master" + actions: + - action: "Execute: jekyll build" + type: "BUILD" + docker_image_name: "jekyll/jekyll" + docker_image_tag: "latest" + execute_commands: + - "# Working directory with cloned repository: /srv/jekyll" + - "jekyll build" +``` + +## 4. Setting up on-premises server + +The self-hosted version of BuddyWorks can be installed on any type of server supporting Docker, including [Linux][1], [Mac][2], [AWS EC2][3], [DigitalOcean][4], and [Microsoft Azure][5]. + +[0]: https://buddy.works/buddy-go +[1]: https://buddy.works/knowledge/standalone/installation-linux +[2]: https://buddy.works/knowledge/standalone/installation-mac-osx +[3]: https://buddy.works/knowledge/standalone/installation-amazon-ec2 +[4]: https://buddy.works/knowledge/standalone/installation-digitalocean +[5]: https://buddy.works/knowledge/standalone/installation-azure + +## 5. Questions? + +This entire guide is open-source. Go ahead and [edit it][0] if you want to expand it or have a fix or [ask for help][1] if you run into trouble and need assistance. BuddyWorks also has an [online community][2] for help. + +[0]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md +[1]: https://jekyllrb.com/help/ +[2]: http://forum.buddy.works/ From be7fc8a2c4e9fa77ab6e367d55060cf07b353ae5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20Ku=C5=9B?= Date: Fri, 17 Mar 2017 16:46:31 +0100 Subject: [PATCH 2/6] added extension + fixed line 15 --- docs/_docs/continuous-integration/{buddyworks => buddyworks.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename docs/_docs/continuous-integration/{buddyworks => buddyworks.md} (97%) diff --git a/docs/_docs/continuous-integration/buddyworks b/docs/_docs/continuous-integration/buddyworks.md similarity index 97% rename from docs/_docs/continuous-integration/buddyworks rename to docs/_docs/continuous-integration/buddyworks.md index 45daa1f2..5c845270 100644 --- a/docs/_docs/continuous-integration/buddyworks +++ b/docs/_docs/continuous-integration/buddyworks.md @@ -12,7 +12,7 @@ title: "BuddyWorks" ## 1. Getting started -1. Log in at with your GitHub/Bitbucket account or email +1. Log in at https://buddy.works with your GitHub/Bitbucket account or email 2. Choose your Git provider and select or push your Jekyll Project 3. Create a new pipeline and set the trigger mode to 'On every push' 4. Add the Jekyll action and save the pipeline From 9e55247dac8f463d60b53885572405857ae2e97f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20Ku=C5=9B?= Date: Mon, 20 Mar 2017 11:59:25 +0100 Subject: [PATCH 3/6] fix in line 42 --- docs/_docs/continuous-integration/buddyworks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/continuous-integration/buddyworks.md b/docs/_docs/continuous-integration/buddyworks.md index 5c845270..7a3a7eee 100644 --- a/docs/_docs/continuous-integration/buddyworks.md +++ b/docs/_docs/continuous-integration/buddyworks.md @@ -39,7 +39,7 @@ If you prefer configuration as code over GUI, you can generate `buddy.yml` that docker_image_name: "jekyll/jekyll" docker_image_tag: "latest" execute_commands: - - "# Working directory with cloned repository: /srv/jekyll" + - "chown jekyll:jekyll $WORKING_DIR" - "jekyll build" ``` From 93f472d1eb8251762321cfcc3af5957fc61c7fd7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20Ku=C5=9B?= Date: Tue, 21 Mar 2017 09:34:43 +0100 Subject: [PATCH 4/6] Update buddyworks.md added unique links + minor text changes --- .../continuous-integration/buddyworks.md | 33 +++++++++---------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/docs/_docs/continuous-integration/buddyworks.md b/docs/_docs/continuous-integration/buddyworks.md index 7a3a7eee..d33259df 100644 --- a/docs/_docs/continuous-integration/buddyworks.md +++ b/docs/_docs/continuous-integration/buddyworks.md @@ -2,12 +2,12 @@ title: "BuddyWorks" --- -[BuddyWorks][0] is a [Docker][1]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][2], [Bitbucket][3], and [GitLab][4] repositories, can be installed on-premises or in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project. +[BuddyWorks][0] is a [Docker][1]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][2], [Bitbucket][3], and [GitLab][4] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project. [0]: https://buddy.works [1]: https://www.docker.com/ [2]: https://github.com -[3]: https://https://bitbucket.org/ +[3]: https://bitbucket.org/ [4]: https://gitlab.com ## 1. Getting started @@ -15,19 +15,19 @@ title: "BuddyWorks" 1. Log in at https://buddy.works with your GitHub/Bitbucket account or email 2. Choose your Git provider and select or push your Jekyll Project 3. Create a new pipeline and set the trigger mode to 'On every push' -4. Add the Jekyll action and save the pipeline +4. Add and configure the Jekyll action and save the pipeline ## 2. How it works -Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][0]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and Cloud services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server. +Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][5]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server. ![Jekyll Build](https://buddy.works/data/blog/_images/buddyworks-jekyll-small.png) -[0]: https://hub.docker.com/r/jekyll/jekyll/ +[5]: https://hub.docker.com/r/jekyll/jekyll/ ## 3. Using YAML for configuration -If you prefer configuration as code over GUI, you can generate `buddy.yml` that will create a pipeline with the Jekyll action once pushed to the repository: +If you prefer configuration as code over GUI, you can generate `buddy.yml` that will create a pipeline with the Jekyll action once you push it to the target branch: ```ruby - pipeline: "Build and Deploy Jekyll site" @@ -45,19 +45,18 @@ If you prefer configuration as code over GUI, you can generate `buddy.yml` that ## 4. Setting up on-premises server -The self-hosted version of BuddyWorks can be installed on any type of server supporting Docker, including [Linux][1], [Mac][2], [AWS EC2][3], [DigitalOcean][4], and [Microsoft Azure][5]. +The self-hosted version of BuddyWorks can be installed on any type of server supporting Docker, including [Linux][6], [Mac][7], [AWS EC2][8], [DigitalOcean][9], and [Microsoft Azure][10]. -[0]: https://buddy.works/buddy-go -[1]: https://buddy.works/knowledge/standalone/installation-linux -[2]: https://buddy.works/knowledge/standalone/installation-mac-osx -[3]: https://buddy.works/knowledge/standalone/installation-amazon-ec2 -[4]: https://buddy.works/knowledge/standalone/installation-digitalocean -[5]: https://buddy.works/knowledge/standalone/installation-azure +[6]: https://buddy.works/knowledge/standalone/installation-linux +[7]: https://buddy.works/knowledge/standalone/installation-mac-osx +[8]: https://buddy.works/knowledge/standalone/installation-amazon-ec2 +[9]: https://buddy.works/knowledge/standalone/installation-digitalocean +[10]: https://buddy.works/knowledge/standalone/installation-azure ## 5. Questions? -This entire guide is open-source. Go ahead and [edit it][0] if you want to expand it or have a fix or [ask for help][1] if you run into trouble and need assistance. BuddyWorks also has an [online community][2] for help. +This entire guide is open-source. Go ahead and [edit it][11] if you want to expand it or have a fix or [ask for help][12] if you run into trouble and need assistance. BuddyWorks also has an [online community][13] for help. -[0]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md -[1]: https://jekyllrb.com/help/ -[2]: http://forum.buddy.works/ +[11]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md +[12]: https://jekyllrb.com/help/ +[13]: http://forum.buddy.works/ From 086bf13a33ae132af7009acf456dea8158212f5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20Ku=C5=9B?= Date: Tue, 21 Mar 2017 10:49:48 +0100 Subject: [PATCH 5/6] Update buddyworks.md added article to `buddy.yml` --- docs/_docs/continuous-integration/buddyworks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/continuous-integration/buddyworks.md b/docs/_docs/continuous-integration/buddyworks.md index d33259df..c60b5b36 100644 --- a/docs/_docs/continuous-integration/buddyworks.md +++ b/docs/_docs/continuous-integration/buddyworks.md @@ -27,7 +27,7 @@ Whenever you make a push to the selected branch, the Jekyll action runs `jekyll ## 3. Using YAML for configuration -If you prefer configuration as code over GUI, you can generate `buddy.yml` that will create a pipeline with the Jekyll action once you push it to the target branch: +If you prefer configuration as code over GUI, you can generate a `buddy.yml` that will create a pipeline with the Jekyll action once you push it to the target branch: ```ruby - pipeline: "Build and Deploy Jekyll site" From b60b78cfc4c8743446284a88d85c251634eff624 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20Ku=C5=9B?= Date: Wed, 22 Mar 2017 13:55:56 +0100 Subject: [PATCH 6/6] changed link references to names --- .../continuous-integration/buddyworks.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/_docs/continuous-integration/buddyworks.md b/docs/_docs/continuous-integration/buddyworks.md index c60b5b36..1dea8be5 100644 --- a/docs/_docs/continuous-integration/buddyworks.md +++ b/docs/_docs/continuous-integration/buddyworks.md @@ -2,13 +2,13 @@ title: "BuddyWorks" --- -[BuddyWorks][0] is a [Docker][1]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][2], [Bitbucket][3], and [GitLab][4] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project. +[BuddyWorks][buddyworks-homepage] is a [Docker][docker-homepage]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][github-homepage], [Bitbucket][bitbucket-homepage], and [GitLab][gitlab-homepage] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project. -[0]: https://buddy.works -[1]: https://www.docker.com/ -[2]: https://github.com -[3]: https://bitbucket.org/ -[4]: https://gitlab.com +[buddyworks-homepage]: https://buddy.works +[docker-homepage]: https://www.docker.com/ +[github-homepage]: https://github.com +[bitbucket-homepage]: https://bitbucket.org/ +[gitlab-homepage]: https://gitlab.com ## 1. Getting started @@ -19,11 +19,11 @@ title: "BuddyWorks" ## 2. How it works -Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][5]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server. +Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][jekyll-docker-image]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server. ![Jekyll Build](https://buddy.works/data/blog/_images/buddyworks-jekyll-small.png) -[5]: https://hub.docker.com/r/jekyll/jekyll/ +[jekyll-docker-image]: https://hub.docker.com/r/jekyll/jekyll/ ## 3. Using YAML for configuration @@ -45,18 +45,18 @@ If you prefer configuration as code over GUI, you can generate a `buddy.yml` tha ## 4. Setting up on-premises server -The self-hosted version of BuddyWorks can be installed on any type of server supporting Docker, including [Linux][6], [Mac][7], [AWS EC2][8], [DigitalOcean][9], and [Microsoft Azure][10]. +The self-hosted version of BuddyWorks can be installed on any type of server supporting Docker, including [Linux][bw-linux], [Mac][bw-mac], [AWS EC2][bw-aws-ec2], [DigitalOcean][bw-digitalocean], and [Microsoft Azure][bw-azure]. -[6]: https://buddy.works/knowledge/standalone/installation-linux -[7]: https://buddy.works/knowledge/standalone/installation-mac-osx -[8]: https://buddy.works/knowledge/standalone/installation-amazon-ec2 -[9]: https://buddy.works/knowledge/standalone/installation-digitalocean -[10]: https://buddy.works/knowledge/standalone/installation-azure +[bw-linux]: https://buddy.works/knowledge/standalone/installation-linux +[bw-mac]: https://buddy.works/knowledge/standalone/installation-mac-osx +[bw-aws-ec2]: https://buddy.works/knowledge/standalone/installation-amazon-ec2 +[bw-digitalocean]: https://buddy.works/knowledge/standalone/installation-digitalocean +[bw-azure]: https://buddy.works/knowledge/standalone/installation-azure ## 5. Questions? -This entire guide is open-source. Go ahead and [edit it][11] if you want to expand it or have a fix or [ask for help][12] if you run into trouble and need assistance. BuddyWorks also has an [online community][13] for help. +This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddyworks] if you want to expand it or have a fix or [ask for help][jekyll-help] if you run into trouble and need assistance. BuddyWorks also has an [online community][buddyworks-forum] for help. -[11]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md -[12]: https://jekyllrb.com/help/ -[13]: http://forum.buddy.works/ +[jekyll-docs-ci-buddyworks]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md +[jekyll-help]: https://jekyllrb.com/help/ +[buddyworks-forum]: http://forum.buddy.works/