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

Update mainline.md #4076

Closed
wants to merge 1 commit into from
Closed

Update mainline.md #4076

wants to merge 1 commit into from

Conversation

zammitjohn
Copy link

@zammitjohn zammitjohn commented Jun 24, 2024

As of v6.0.0 of the schema, the Mainline mode and the related implementation has been removed completely. The new Mainline version strategy should be used instead.

Description

As per new version on the schema, we must use the new strategies array.

Motivation and Context

Fixes to documentation.

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

As of v6.0.0 of the schema, the Mainline mode and the related implementation has been removed completely. The new Mainline version strategy should be used instead.
@arturcic arturcic requested a review from HHobeck June 24, 2024 08:11
@HHobeck
Copy link
Contributor

HHobeck commented Jun 24, 2024

I would recommend the following configuration when using the Mainline strategy:

  1. From scratch (other configuration properties needs to be expressed):
workflow: ''
strategies:
- Mainline
- ConfiguredNextVersion
...
  1. Using the pre-defined GitFlow workflow as a base template:
workflow: GitFlow/v1
strategies:
- Mainline
- ConfiguredNextVersion
  1. Using the pre-defined GitHubFlow workflow as a base template:
workflow: GitHubFlow/v1
strategies:
- Mainline
- ConfiguredNextVersion
  1. Using the pre-defined TrunkBased workflow as a base template:
workflow: TrunkBased/preview1

We need to make clear that it is a new implementation which needs to be used in experimental context only. In advance multi mainline branches are not supported in version 6.x.

Edit:
Thank you very much for contributing. ;)

@arturcic
Copy link
Member

@HHobeck can we merge this one? The build will not continue as there are only documentation changes

@HHobeck
Copy link
Contributor

HHobeck commented Jun 25, 2024

@HHobeck can we merge this one? The build will not continue as there are only documentation changes

Actually I would like to see the points I mentioned in the documentation. The current change makes no sense because it lean on the fact that the default value of workflow is GitFlow/v1 (This is because of backwards compatibility reason). In future releases we are going to not support this (probably).

@arturcic
Copy link
Member

@HHobeck can we merge this one? The build will not continue as there are only documentation changes

Actually I would like to see the points I mentioned in the documentation. The current change makes no sense because it lean on the fact that the default value of workflow is GitFlow/v1 (This is because of backwards compatibility reason). In future releases we are going to not support this (probably).

Can we update the docs based on your suggestion and then we can push the rc2?

@HHobeck
Copy link
Contributor

HHobeck commented Jun 25, 2024

Can we update the docs based on your suggestion and then we can push the rc2?

Yes I agree

@arturcic
Copy link
Member

@HHobeck please then close this PR

@HHobeck HHobeck closed this Jun 25, 2024
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