Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (60 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

78 lines (60 loc) · 3.2 KB
layout default
title Contributing code to Cluster.dev
permalink /contributing/

Development

If you plan to make some big changes, please look over our style guide requirements first.

If you adding additional Cloud Provider or Kubernetes Provisioner, see add-provider-provisioner.md

How to contribute

  1. Create an issue that you are going to address in GH Issues, for example issue #3.

  2. Spawn new branch from master named with the GH Issue you are going to address: feature/GH-3. For preferable branch naming format see here.

  3. To start a new cluster corresponding to your issue, create a manifest file in .cluster.dev/gh-3.yaml, setting the name with the target issue:

cluster:
  name: gh-3 #CHANGE ME
  installed: true
  cloud:
    provider: aws
    region: eu-central-1
    vpc: default
    domain: shalb.net
    provisioner:
      type: minikube
      instanceType: m5.large
  1. Create a new workflow in .github/workflows and name it corresponding to your issue: gh-3.yaml.
    Set the required branch and file name in placeholders (marked with #CHANGE ME), for example:
on:
  push:
      branches:
        - feature/GH-3 #CHANGE ME
jobs:
  deploy_cluster_job:
    runs-on: ubuntu-latest
    name: Deploy and Update K8s Clusters
    steps:
    - name: Checkout Repo
      uses: actions/checkout@v2
      with:
        ref: 'feature/GH-3' #CHANGE ME
    - name: Reconcile Clusters
      id: reconcile
      uses: shalb/cluster.dev@feature/GH-3 #CHANGE ME
      env:
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        CLUSTER_CONFIG_PATH: "./.cluster.dev/"
        VERBOSE_LVL: DEBUG
    # Use the output from the `reconcile` step
    - name: Get the Cluster Credentials
      run: echo -e "${{ steps.reconcile.outputs.ssh }}\n\033[1;32m${{ steps.reconcile.outputs.kubeconfig }}"

  1. Commit and push both files with the comment, for example: GH-3 Initial Commit. GitHub automatically creates reference to the related issue to let other contributors know that related work has been addressed somewhere else.

  2. Check the logs in GH Actions to track the environment building process. To do this, choose your branch in the workflows section and choose your last build.
    select the branch

  3. Check the cluster status with your target cloud provider.

  4. After you have made all the necessary changes, open a Pull Request and assign it to @voatsap or @MaxymVlasov for the review.

  5. After successful review, squash and merge your PR to master with the included comment Resolve GH-3.

  6. After merging be sure to delete all the resources associated with the issue (EC2 instances, Elastic IP's etc.) that have been used for testing.