Skip to content

Commit f717ab3

Browse files
authored
Improve PR description of the automatic PR (#213)
1 parent ca8ee09 commit f717ab3

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

.github/workflows/autoupdate-prod.yaml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,25 @@ jobs:
5353
2. Documentation style
5454
3. Transformation engine linting
5555
56+
> NOTE: New automation PRs need to be closed and reopened to trigger builds
57+
5658
## Important Details
5759
58-
1. If build is failing please check the logs and fix the issues in the OpenAPI file (openapi/atlas-api.yaml)
59-
2. Do not attempt to manually fix any issues in the Golang Codebase as all changes are automatically generated.
60-
Fixes should be applied to the OpenAPI file (openapi/atlas-api.yaml) or ./tools engine in separate PR.
60+
1. If the build is failing please check the logs and fix the issues in the OpenAPI file (openapi/atlas-api.yaml)
61+
2. Do not attempt to manually fix any issues in the Golang code as all changes are automatically generated.
62+
Fixes should be applied to the OpenAPI file (openapi/atlas-api.yaml) or ./tools engine in a separate PR.
6163
6264
## Manual Review Procedure
6365
6466
1. Review changes in the OpenAPI file (openapi/atlas-api.yaml)
65-
2. If we see any breaking changes without new resource version (
66-
- Review breaking changes listed in `Detect Breaking Changes` action
67+
2. If we see any breaking changes [without a new resource version](https://github.com/mongodb/atlas-sdk-go/tree/main/tools/releaser#new-resource-version).
68+
- View the log of breaking changes in the `Detect Breaking Changes` action
6769
- Checkout PR locally and run `make update-version`
68-
- Provide breaking changes infomation in generated `./releaser/breaking_changes/{release_version}.md` file
70+
- Provide breaking changes information in generated `./releaser/breaking_changes/{release_version}.md` file
6971
- Push your changes directly to the automation PR.
70-
3. If we have major version release request feedback from additional reviewer if possible.
71-
4. Merge PR into main branch
72-
5. After merge automated release process will be triggered.
72+
3. If we have a major version release request feedback from additional reviewers if possible.
73+
4. Merge PR into the main branch
74+
5. After the merge automated release process will be triggered.
7375
7476
7577

0 commit comments

Comments
 (0)