Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Developer Experience improvements #131

Merged
merged 1 commit into from
Mar 24, 2019

Conversation

justaugustus
Copy link
Member

@justaugustus justaugustus commented Mar 10, 2019

Signed-off-by: Stephen Augustus saugustus@vmware.com

What this PR does / why we need it:
Update developer toolbox and documentation:

  • Update documentation
  • Update .gitignore
  • Remove skip_files in golangci config
  • Bump golang version (1.12.1) / switch thin image to distroless/base
  • Clean up Makefile
  • Bump bazel rules_go (0.18.1)
  • Bump kind version (d4ff13e4808ee5a816ed92bf2d3348bda12413db)
  • Rename build/asm_shim
  • Add bazel generator for kustomize
  • Update example specs
  • Update generate-yaml.sh
  • Update cmd packages
  • Add release tool
  • Regenerate CRDs

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #127, fixes #108, fixes #98, fixes #107

Release note:

Developer Experience improvements

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Mar 10, 2019
@k8s-ci-robot k8s-ci-robot added area/provider/azure Issues or PRs related to azure provider approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 10, 2019
@justaugustus
Copy link
Member Author

/priority critical-urgent
/kind documentation cleanup
/milestone baseline

@k8s-ci-robot k8s-ci-robot added this to the baseline milestone Mar 10, 2019
@k8s-ci-robot k8s-ci-robot added priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now. kind/documentation Categorizes issue or PR as related to documentation. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Mar 10, 2019
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 11, 2019
@justaugustus
Copy link
Member Author

/kind feature

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 11, 2019
Makefile Outdated

.PHONY: lint
lint: dep-ensure ## Lint codebase
@echo If you have generated new mocks, run make copy-genmocks before linting
@echo If you have genereated new mocks, run make copy-genmocks before linting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUPER NIT
Generated is spelled wrong here

{controller_gen} all && \\
cp -fR config $$GENDIR
{controller_gen} all && \\
cp -fR config $$GENDIR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the spaces were removed before these lines. Was that on purpose?

@@ -0,0 +1,26 @@
#!/bin/bash

# Copyright 2018 The Kubernetes Authors.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2018 The Kubernetes Authors.
# Copyright 2019 The Kubernetes Authors.

### Get familiar with basic concepts

This provider is modeled after the upstream cluster-api project. To get familiar
with resources, concepts and conventions refer to the [upstream gitbook](https://kubernetes-sigs.github.io/cluster-api/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUPER DUPER NIT: can we rename it to cluster-api gitbook? Also let's move the link to the bottom of the readme.md for consistency's sake.

### Get familiar with basic concepts

This provider is modeled after the upstream cluster-api project. To get familiar
with resources, concepts and conventions refer to the [upstream gitbook](https://kubernetes-sigs.github.io/cluster-api/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
with resources, concepts and conventions refer to the [upstream gitbook](https://kubernetes-sigs.github.io/cluster-api/).
with the concepts and conventions, refer to the [cluster-api gitbook](https://kubernetes-sigs.github.io/cluster-api/).

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 17, 2019
cmd/clusterctl/examples/azure/credentials.yaml.template Outdated Show resolved Hide resolved
cmd/clusterctl/examples/azure/credentials.yaml.template Outdated Show resolved Hide resolved
cmd/clusterctl/examples/azure/credentials.yaml.template Outdated Show resolved Hide resolved
cmd/clusterctl/examples/azure/credentials.yaml.template Outdated Show resolved Hide resolved
cmd/clusterctl/examples/azure/generate-yaml.sh Outdated Show resolved Hide resolved
cmd/clusterctl/examples/azure/generate-yaml.sh Outdated Show resolved Hide resolved
cmd/clusterctl/examples/azure/generate-yaml.sh Outdated Show resolved Hide resolved
cmd/clusterctl/examples/azure/generate-yaml.sh Outdated Show resolved Hide resolved
docs/releasing.md Show resolved Hide resolved
docs/releasing.md Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
.gitignore Show resolved Hide resolved
.golangci.yml Show resolved Hide resolved
@@ -25,7 +25,7 @@ COPY vendor/ vendor/
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o manager sigs.k8s.io/cluster-api-provider-azure/cmd/manager

# Copy the controller-manager into a thin image
FROM alpine:3.9
FROM gcr.io/distroless/base
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@justaugustus justaugustus changed the title [WIP] Developer Experience improvements Developer Experience improvements Mar 24, 2019
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 24, 2019
@justaugustus
Copy link
Member Author

Ready for review:
/assign @soggiest @tariq1890 @awesomenix

@awesomenix
Copy link
Contributor

overall looks good, let me know once the conflicts are resolved.

- Update documentation
- Update .gitignore
- Remove skip_files in golangci config
- Bump golang version (`1.12.1`) / switch thin image to `distroless/base`
- Clean up Makefile
- Bump bazel rules_go (`0.18.1`)
- Bump kind version (`d4ff13e4808ee5a816ed92bf2d3348bda12413db`)
- Rename build/asm_shim
- Add bazel generator for kustomize
- Update example specs
- Update generate-yaml.sh
- Update cmd packages
- Add release tool
- Regenerate CRDs

Signed-off-by: Stephen Augustus <saugustus@vmware.com>
@justaugustus
Copy link
Member Author

Thanks @awesomenix. Conflicts fixed up!

@awesomenix
Copy link
Contributor

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 24, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: awesomenix, justaugustus

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/provider/azure Issues or PRs related to azure provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
5 participants