obs: add initial Project types

[nitishfy]

Reference: #2295
This PR is created with the purpose of adding the initial project structure for the OBS project meta file for golang library

[k8s-ci-robot]

Welcome @nitishfy!

It looks like this is your first PR to kubernetes-sigs/release-sdk 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/release-sdk has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @nitishfy. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[nitishfy]

General question answered

[xmudrii]

Here's the initial review, I can do another review once these comments are addressed. Looks pretty solid so far!

[xmudrii]

Looks better, some more nits from my side

[nitishfy]

I think I can move forward with adding more features now. Let me know if you have any more feedback to address, I'll resolve them along the way.

[xmudrii]

Some final nits for now. Perhaps we can merge this PR once these nits are addressed.

[xmudrii]

I changed my mind about these fields. Let's make this field non-pointer string and remove omitempty. We're actually going to get the same result.

[nitishfy]

but how is this working internally then?

[xmudrii]

I'm not sure I fully understand your question. Can you elaborate please?

[nitishfy]

mhh, why is there need to remove the pointers and omitempty from here? (these fields are after all not mandatory, isn't it?)

[xmudrii]

Because working with string pointers (or with any other pointer to a primitive type) is a little bit complicated and doesn't provide good user experience. When defining the struct, you have to do something like this:

str := "My Project Name"
p := &Project{
    URL: &str,
}

Instead of:

p := &Project{
    URL: "My Project Name",
}

When you have multiple strings, like in our case, it gets even worse.

Right now, if you completely omit the URL when defining a project, you'll get XML like this one:

<project>
    ...
</project>

If you remove pointers and omitempty, you'll get XML like this one:

<project>
    <url></url>
</project>

These two XMLs are practically the same. OBS is even going to remove the empty tags automatically. However, the user experience of using the library is much better in the second case (when not using pointers to primitive types).

[xmudrii]

/test all

[xmudrii]

/ok-to-test

[xmudrii]

/assign @saschagrunert @cpanato
PTAL at this PR :)

[xmudrii]

/retitle obs: add initial Project types

[nitishfy]

Update: PR is ready for the next set of review and probably for merge as well.
cc: @saschagrunert @cpanato

[xmudrii]

Some nits, but let's address these nits in a follow-up.
/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nitishfy, xmudrii

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:

• OWNERS [xmudrii]

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