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

Comment out step that switches to the new branch #10

Merged
merged 1 commit into from Oct 31, 2020

Conversation

greg0ire
Copy link
Member

We decided in https://github.com/orgs/doctrine/teams/doctrinecore/discussions/19
that the default branch should be the lowest one in order to make
retargeting branches easier, with the exception of some repositories
that may keep that particular step.

We decided in https://github.com/orgs/doctrine/teams/doctrinecore/discussions/19
that the default branch should be the lowest one in order to make
retargeting branches easier, with the exception of some repositories
that may keep that particular step.
@morozov
Copy link
Member

morozov commented Oct 24, 2020

Why not just remove it? We have the history in Git.

@greg0ire
Copy link
Member Author

greg0ire commented Oct 24, 2020

Why not just remove it? We have the history in Git.

I'm thinking about people like @alcaeus and @malarzm that might want to uncomment this step instead of dropping it when setting up the workflow on their repositories, I added a small comment before the step to explain that.

@morozov
Copy link
Member

morozov commented Oct 24, 2020

I'm thinking about people […] that might want to uncomment this step

This way, it becomes not code but documentation which I believe already exists in other places. I may not understand this concept of templates entirely but it looks like introduces a lot of unnecessary friction being just copy/paste via the UI.

The same result could be achieved by publishing the needed code snippets in a README instead of maintaining them in VCS.

@greg0ire
Copy link
Member Author

The same result could be achieved by publishing the needed code snippets in a README instead of maintaining them in VCS.

It does a bit more than that, see gif in #2 (comment) for why the files in this repository also come with metadata files and how this works.

@morozov
Copy link
Member

morozov commented Oct 24, 2020

This will have to be approved by those who are going to consume this template with the commented-out part.

@malarzm
Copy link
Member

malarzm commented Oct 26, 2020

I'd rather have this in "code" commented out. Reasons that come to my mind:

  1. DoctrineMongoDBBundle already has the action installed. If I compare the "code" 3 months from now I won't need to wonder why I have an additional step in the bundle
  2. I can install the action as-is for ODM as we're still using master as a default there and hopefully just uncomment related part when we change default branch instead of looking up readmes and whatnot to see what I need to add.

These might be invalid if only I knew what I'm doing with GA, but sadly I don't: I'm installing stuff hoping it'll work as the old release tool used to. Please don't take it as an ignorant's position, I just don't have time to learn about everything that is happening.

@greg0ire
Copy link
Member Author

It will be very similar to the previous tool 👍

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

Successfully merging this pull request may close these issues.

None yet

3 participants