Skip to content

Commit da99adb

Browse files
committed
Merge branch 'feature/publish_pypi_packages' of github.com:fairagro/m4.2_advanced_middleware_api into feature/publish_pypi_packages
2 parents 29af11c + ae19be6 commit da99adb

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

spec/ci-cd/spec.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ pipelines run on GitHub Actions.
1313
never be skipped.
1414
- [ ] When only non-code files (docs, specs, Helm chart YAML) were modified, all
1515
required checks must complete immediately with a success status, without
16-
performing any actual work (no builds, no test runs, no scans). Job that
16+
performing any actual work (no builds, no test runs, no scans). Jobs that
1717
are not required are skipped.
1818
- [ ] When code files were modified, all required checks run normally; failures
1919
block the PR merge.
20-
- [ ] Required Checks are: "Container Structure Tests" and "Code Qulity Check"
20+
- [ ] Required Checks are: "Container Structure Tests" and "Code Quality Check"
2121

2222
<!-- Code Quality -->
2323
- [ ] Enforce consistent code formatting with Ruff; fail when committed code
@@ -110,14 +110,14 @@ pipelines run on GitHub Actions.
110110
- [ ] PyPI packages must use the exact same semantic version as the Docker image.
111111
- [ ] Final release from `main`: `MAJOR.MINOR.PATCH`.
112112
- [ ] Feature branch pre-release: `MAJOR.MINOR.PATCH-rc.{branch-label}.{run_number}`.
113-
- [ ] If a github release is created, the packages must added to the artifact list.
113+
- [ ] If a GitHub release is created, the packages must be added to the artifact list.
114114
- [ ] If a github release is created, include `pip install` commands for each package with exact version information.
115-
- [ ] If a github release is created, provide fallback instructions for local installation from source
115+
- [ ] If a GitHub release is created, provide fallback instructions for local installation from source.
116116

117117
<!-- General considerations -->
118118

119119
- [ ] Each upload to an external service (DockerHub, GHCR, PyPI) must be modelled as a standalone job, independent from other upload jobs.
120-
- [ ] If an upload job fails, the release is still considered successful
120+
- [ ] If an upload job fails, the release is still considered successful.
121121
- [ ] If a GitHub release is created, the body must document the usage of successfully uploaded artifacts, as specified above.
122122
- [ ] If an upload job fails and a GitHub release is created, issue a corresponding warning message in the GitHub release.
123123
- [ ] If the credentials for an external service are missing, treat this like an upload failure. Adapt the GitHub release body warning accordingly.

0 commit comments

Comments
 (0)