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

SDK-4673: Integration of Code Releases into your project repository #2231

Merged
merged 22 commits into from
Oct 20, 2023

Conversation

sergeyspryker
Copy link
Contributor

PR Description

https://spryker.atlassian.net/browse/SDK-4673

TBD

Checklist

  • I agree with the Code Contribution License Agreement in CONTRIBUTING.md

@sergeyspryker sergeyspryker added the small changes PR contains small changes, like typo fixes label Oct 9, 2023
@vlunov-spryker vlunov-spryker force-pushed the feature/SDK-4673-add-documentation branch from dcde4c5 to c0e4e95 Compare October 9, 2023 13:11
With Spryker Code Upgrader, the process of integrating plugins, configuration updates, adding new translations, and other code changes is automated.
As the result the manual step can be skipped when engineers have to understand and apply code changes by themselves in order to add new features in the project.

Supported extension points:
Copy link
Contributor

Choose a reason for hiding this comment

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

By what? Upgrader supports

The release rating is a measure of the integrability coverage of each Spryker release, representing the percentage of automatically integratable plugins, configurations, schemas, and other components.
This rating is determined during internal testing, where the generated integration code is compared with the manually released code to assess the level of integration achieved. If both are equal, then the release is fully integratable.

There are some kind of releases that provide only dependency updates without any code integrations (so called module-only releases). Such releases have 100% coverage.
Copy link
Contributor

Choose a reason for hiding this comment

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

not kind of, there are types of releases.


To detect violations related to it [Evaluator analysis tool](/docs/scos/dev/guidelines/keeping-a-project-upgradable/run-the-evaluator-tool.html) can be used.

The Evaluator checkers responsible for that:
Copy link
Contributor

Choose a reason for hiding this comment

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

These are not relevant to the security releases, probably you wanted to list it on another page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I left only checkers that related to generic php security

vlunov-spryker
vlunov-spryker previously approved these changes Oct 11, 2023
@DmytroKlymanSpryker DmytroKlymanSpryker changed the title SDK-4673 add documentation SDK-4673: Integration of Code Releases into your project repository Oct 11, 2023

## Release integrability rating threshold

By default, the Upgrader creates PRs for all the releases with rating 70% or more. The description of the PRs contains the rating of the suggested release.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What if I integrate a 70% release? Isn't there any manual development required for the remaining 30%?

Copy link
Contributor Author

@sergeyspryker sergeyspryker Oct 18, 2023

Choose a reason for hiding this comment

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

70% it's a threshold - min release rating for automatic integration. If release has less than 70% rating, upgrader just updates the dependencies, the automatic integration will be skipped (must be provided manually). No partial updates are provided

The upgrader offers validations ensure the accuracy and safety of the upgrade process.
The warnings provide guidance on potential risks or necessary actions for a successful upgrade.

Warning types:
Copy link
Collaborator

Choose a reason for hiding this comment

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

  1. Are these warnings provided before or after merging a PR?
  2. Where are they provided?

Copy link
Contributor Author

@sergeyspryker sergeyspryker Oct 18, 2023

Choose a reason for hiding this comment

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

  1. Are provided before merging the PR (Upgrader creates PR with description that already contains the warnings).
  2. Warnings are placed in PR description text area

@andriitserkovnyi andriitserkovnyi merged commit ab3b042 into master Oct 20, 2023
13 checks passed
@andriitserkovnyi andriitserkovnyi deleted the feature/SDK-4673-add-documentation branch October 20, 2023 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
small changes PR contains small changes, like typo fixes
Development

Successfully merging this pull request may close these issues.

4 participants