Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here.
To contribute to the devworkspace-operator project, developers should follow the fork and pull request workflow.
1. Fork Devworkspace operator repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your-github-username>/devworkspace-operator.git
In the steps listed below, we set up the development environment using a minikube cluster.
1. Start the minikube cluster.
minikube start
2. Enable the ingress add-on for your minikube cluster.
minikube addons enable ingress
3. Set the namespace environment variable for the development environment to avoid changes inside the default namespace.
export NAMESPACE="devworkspace-controller"
4. Install the kubernetes certificate management controller to generate and manage TLS certificates for your cluster.
make install_cert_manager.
Please note that the above step is not specific to minikube. The cert-manager is required for all deployments on kubernetes.
5. Install the dependencies for running the devworkspace-operator in your cluster.
make install
6. Scale down the replicas controller-manager pods to 0.
kubectl patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"replicas\":0}}" -n $NAMESPACE
7. Run the devworkspace-operator.
make run
This will run the devworkspace-controller in your local system.
8. Make your changes in the new branch and test the changes.
1. Take a look samples devworkspace configuration in ./samples folder.
2. Apply any of them by executing kubectl apply -f ./samples/theia-latest.yaml -n <namespace>.
3. As soon as devworkspace is started you're able to get IDE url by executing kubectl get devworkspace -n <namespace>
1. Make a change to the webhook.
2. Ensure the DWO_IMG environment variable points to your container image repository, eg. export DWO_IMG=quay.io/aobuchow/dwo-webhook:next.
3. Run make docker restart (assuming DWO is already deployed to the cluster, otherwise make docker install).
Wait for the webhook deployment to update with your image that contains your latest changes.
To contribute to this project, you must agree to the code fo conduct for each commit you make.
See the code of conduct file for the full text of what you must agree to. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages:
Signed-off-by: John Doe <john.doe@example.com>
Note: you don't have to manually include this line on your commits, git does that for you as shown below:
$ git commit -s -m “my commit message w/signoff”
In most cases, git automatically adds the signoff to your commit with the use of
-s or --signoff flag to git commit. You must use your real name and a reachable email
address (sorry, no pseudonyms or anonymous contributions).
To ensure all your commits are signed, you may choose to add this alias to your global .gitconfig:
~/.gitconfig
[alias]
amend = commit -s --amend
cm = commit -s -m
commit = commit -s