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

build-tooling-getting-started questions #47

Open
codegold79 opened this issue Jan 4, 2023 · 0 comments
Open

build-tooling-getting-started questions #47

codegold79 opened this issue Jan 4, 2023 · 0 comments
Labels
kind/documentation Improvements or additions to documentation

Comments

@codegold79
Copy link
Contributor

codegold79 commented Jan 4, 2023

Describe the bug

Some areas of the build-tooling-getting-started.md is unclear and I have some questions.

Questions

In the section Steps to use the build tooling, it says,

Copy the contents of the Makefile

Where do I copy the Makefile to? My Documents folder? The root directory of a plugin repository? Can I follow the COMPONENTS example where it uses COMPONENTS ?= featuregates.featuregates-controller-manager.featuregates, and put a copy of the Makefile in vmware-tanzu/framework/featuregates/controller?

In step 2, it says,

...is the name of the package, this should be same as the directory name that holds the package definition of featuregates in packages directory that's in the project's root directory.

I'm not sure what it means by "name of the package". What do you mean by "package"? Is that a Carvel term? A Go term? And what is a "package definition"? Might be worth having links to the definitions/examples of packages and package definition.

In step 4, it says,

If you are using one of the seed projects, you need to customize the existing package in that project...

How do I customize the existing project?

In step 6, it says,

Following env vars should be set when running the above make target

    OCI_REGISTRY - remote OCI registry where you would like to push the images and package bundles.
    IMG_VERSION_OVERRIDE - image tag for the image to be built.
    PACKAGE_REPOSITORY - package repository of the package bundles.
    PACKAGE_VERSION - package version of the package bundle being built.
    PACKAGE_SUB_VERSION - package subversion of the package bundle being built.
    REGISTRY_USERNAME - OCI registry username.
    REGISTRY_PASSWORD - OCI registry password.
    REGISTRY_SERVER - OCI registry server url.

What are examples of what the OCI_REGISTRY, IMG_VERSION_OVERRIDE, PACKAGE_REPOSITORY, PACKAGE_VERSION, PACKAGE_SUB_VERSION look like? What is the difference between OCI_REGISTRY and REGISTRY_SERVER?

What rules do we need to follow for the above mentioned variable? Or maybe there are no rules. For version, can I use anything I want?

@codegold79 codegold79 added the kind/documentation Improvements or additions to documentation label Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant