Skip to content
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.

Multi-profile repo proposal #108

Merged
merged 13 commits into from May 7, 2021

Conversation

aclevername
Copy link
Contributor

@aclevername aclevername commented May 6, 2021

Description

rendered. Sorry in advance for the poor spelling and grammar, feel free to update 馃槃

Checklist

  • Added tests that cover your change
  • Added/modified documentation as required (such as the README.md (diagrams, usage, roadmap etc), and anything in examples/)
  • Made sure the title of the PR is a good description that can go into the release notes
  • Added a kind label to the PR (e.g. kind/feature)

@aclevername aclevername force-pushed the mult-repo-proposal branch 4 times, most recently from bfd8913 to 4d458c6 Compare May 6, 2021 10:57
@aclevername aclevername marked this pull request as ready for review May 6, 2021 10:58
@aclevername
Copy link
Contributor Author

@Callisto13 be good to get all your thoughts on this before you go on holiday 馃槃

docs/proposal-01-multi-profile-repo.md Outdated Show resolved Hide resolved
docs/proposal-01-multi-profile-repo.md Outdated Show resolved Hide resolved
docs/proposal-01-multi-profile-repo.md Outdated Show resolved Hide resolved
docs/proposal-01-multi-profile-repo.md Outdated Show resolved Hide resolved
docs/proposal-01-multi-profile-repo.md Outdated Show resolved Hide resolved
docs/proposal-01-multi-profile-repo.md Outdated Show resolved Hide resolved
@Skarlso
Copy link
Contributor

Skarlso commented May 6, 2021

So far so good. I would definitely opt for approach one and no sub-directories for sure.

@aclevername aclevername changed the title add multi-repo profile proposal add multi-profile repo proposal May 6, 2021
@aclevername aclevername changed the title add multi-profile repo proposal Multi-profile repo proposal May 6, 2021
Jake Klein and others added 7 commits May 6, 2021 13:30
Co-authored-by: Claudia <claudiaberesford@gmail.com>
Co-authored-by: Claudia <claudiaberesford@gmail.com>
Co-authored-by: Claudia <claudiaberesford@gmail.com>
Co-authored-by: Claudia <claudiaberesford@gmail.com>
Co-authored-by: Gergely Brautigam <skarlso777@gmail.com>
Co-authored-by: Claudia <claudiaberesford@gmail.com>
Co-authored-by: Claudia <claudiaberesford@gmail.com>
@aclevername
Copy link
Contributor Author

So far so good. I would definitely opt for approach one and no sub-directories for sure.

Yes this is my preference too

```

This approach makes it clear upon inspection what tag is actually being referenced in the repository, but is less clear what directory/profile inside the repository is being referenced.
It also maintains two completely different approaches for using `branch` vs `tag`
Copy link
Contributor

Choose a reason for hiding this comment

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

I prefer this option, path is more explicit than inferring from the tag, tagging strategies vary wildly and we can't really rely on it. Instead of a tag, you could ref a SHA (which is more reliable) and there's no path inferrable.

Copy link
Contributor

Choose a reason for hiding this comment

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

Would you mind explaining what do you mean under tagging strategies vary wildly and that we can't rely on it?
I mean we apply the strategy. We create tags and we create the folder structure for it. And if it's documented, why can't we rely on it? Do you mean that people will have difficulties adjusting to it and using it in their own repos and profiles and that we can't rely on proper adoption?

Copy link
Contributor

Choose a reason for hiding this comment

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

There are many tag naming policies (we are not going to be the only folks maintaining profiles).

So, it's not about us relying on our tag naming strategy, it's other folks... :-)

Copy link
Contributor

@Skarlso Skarlso May 6, 2021

Choose a reason for hiding this comment

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

Do you mean that people will have difficulties adjusting to it and using it in their own repos and profiles and that we can't rely on proper adoption?

Ok, so you're are worried about adoption part. Makes sense. But Kustomize is widely adopted and being contributed too. We could argue that this scheme is already pretty well known?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding the option for SHA sounds like a nice follow up feature 馃槈

But Kustomize is widely adopted and being contributed too. We could argue that this scheme is already pretty well known?

Anecdotal but before Kevin pointed me at this repo I'd never seen this pattern before 馃槃

I think with either approach its up to us to heavily document and explain the process to the users, so it doesn't matter too much

Copy link
Contributor

Choose a reason for hiding this comment

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

I am happy with the greater clarity of approach 2 馃憤

@Callisto13
Copy link
Contributor

So far so good. I would definitely opt for approach one and no sub-directories for sure.

Yes this is my preference too

+1 this, max depth of 1 is enough to allow for multiple profiles per repo

@aclevername
Copy link
Contributor Author

aclevername commented May 7, 2021

Are folks happy for this to be approved and approach 2 chosen? If so I will update the proposal to show approach 2 was chosen (I'll move approach 1 to alternatives) and write out the follow up stories @Callisto13 @bigkevmcd @Skarlso

@bigkevmcd
Copy link
Contributor

Works for me for now :-)

@bigkevmcd bigkevmcd closed this May 7, 2021
@aclevername aclevername deleted the mult-repo-proposal branch May 7, 2021 12:14
@aclevername aclevername restored the mult-repo-proposal branch May 7, 2021 12:15
@aclevername aclevername reopened this May 7, 2021
@aclevername
Copy link
Contributor Author

Works for me for now :-)

cool. Re-opening as I would like this doc to be merged so we have an historical artifact

@bigkevmcd
Copy link
Contributor

Oops, didn't mean to close it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation] How we will implement multi-profile repos with tagging
4 participants