Setup your developer environment

Developer environment for Azure

Minimal development environment setup for working with the CloudBoost Library

• Git Bash
• VSCode
• Install VSCode extensions from marketplace:
  • Azure Resource Manager Tools for Visual Studio Code

Request access to the CloudBoost Library Git repository on Azure DevOps. Send a message to clemens.reijnen@sogeti.com to get access to the Git repository. When you have an active MSDN Subscription please add your Sogeti.com address to it. When you used a different address when for your MSDN subscription on my.visualstudio.com you still can use your sogeti.com address by adding it as an alternate address atr the bottom pf the page.

Nice to have tools:

• Azure Powershell.
• Azure CLI

Minimal Software to be installed for contributing to the documentation

• Git Bash
• VSCode
• Install VSCode extensions from marketplace:
  • Code Spell Checker
  • Azure Resource Manager Tools for Visual Studio Code
  • Markdown all in one
  • Markdown lint
• NodeJS
  • CSpell
• Jekyll
  • Run Bundle Install to get all packages
  • Start site build and local hosting via bundle exec jekyll serve

Error: Unable to download data from https://rubygems.org/ - timed out

Part of the installation of Jekyll is running the command gem install jekyll bundler. When downloading file, gem has a preference for IPv6. The following error might occur: Unable to download data from https://rubygems.org/ - timed out . Also see: Ruby Help. This can be resolved by updating the hosts file (%System32%\Drivers\etc\hosts) with the following entries:

• 54.186.104.15 rubygems.org
• 54.186.104.15 api.rubygems.org

Clone CloudBoost repository

Clone the Cloud Boost repo. Either via VSCode, Clone command in the Command Palette (Ctrl+Shift+P) or via Git Bash.

git clone "https://dev.azure.com/cloudboost/CloudBoost.ServiceCatalog/_git/CloudBoost.ServiceCatalog"

Validate the installation

• Check if the Git Clone command worked by opening the cloned folder in VSCode.
• Validate CSpell by opening a command prompt and execute cspell "docs/**/*.md" in the cloned directory
• Validate Jekyll by running the site via bundle exec jekyll serve in a command prompt

Start working by creating a Branch

Create a Local Branch for Working. Incorporates changes from a remote repository into the current branch. In its default mode, git pull.

Git checkout master
Git pull
Git branch "MeaningfulName"
Git checkout "MeaningfulName"

or

Git checkout -b "MeaningfulName"

Make changes to the files and commit the changes.

Git add .
Git commit -m "Meaningful commit message"
Git push origin "MeaningfulName"

Finish work by making a pull request

Get changes from master and merge them in your own branch.

Git checkout master
Git pull
Git checkout "MeaningfulName"
Git merge master

Or

Git pull origin master

Goto Azure DevOps and initiate a pull request, ask your team mates for a review.

Setting your email address for a single repository

Git uses the email address set in your local Git configuration to associate commits pushed from the command line with your Git account.

You can change the email address associated with commits you make in a single repository. This will override your global Git config settings in this one repository, but will not affect any other repositories.

Open Git Bash.

Change the current working directory to the local repository where you want to configure the email address that you associate with your Git commits.

Set an email address in Git. You can use your Git-provided no-reply email address or any email address.

Git config user.email "email@example.com"

Confirm that you have set the email address correctly in Git:

Git config user.email email@example.com

Add the email address to your GitHub account by setting your commit email address, so that your commits are attributed to you and appear in your contributions graph.