Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
63bff8a86d
|
No files matched your search
@@ -4,6 +4,8 @@ CircleCI orb for QQQ framework projects.
|
|||||||
|
|
||||||
For centralized pipeline ownership, see [standardized manifest-driven pipelines](docs/GENERATED-PIPELINES.md).
|
For centralized pipeline ownership, see [standardized manifest-driven pipelines](docs/GENERATED-PIPELINES.md).
|
||||||
The initial QBit profile uses a small `.qqq-ci.yml` and a setup entry point; existing direct job callers remain supported.
|
The initial QBit profile uses a small `.qqq-ci.yml` and a setup entry point; existing direct job callers remain supported.
|
||||||
|
For centrally managed patch adoption and exact-version rollback, see
|
||||||
|
[managed patch updates](docs/managed-patch-updates.md).
|
||||||
|
|
||||||
**For:** Teams using CircleCI to build, test, and publish QQQ applications
|
**For:** Teams using CircleCI to build, test, and publish QQQ applications
|
||||||
**Status:** Stable (v0.6.x)
|
**Status:** Stable (v0.6.x)
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# Managed patch updates
|
||||||
|
|
||||||
|
The canonical caller and manifest accept either an exact stable version such as
|
||||||
|
`0.8.0` or a quoted minor track such as `"0.8"`. CircleCI resolves a minor track
|
||||||
|
to its latest published patch. A major-only version, `latest`, `volatile`, and
|
||||||
|
wildcards are rejected. The caller import, setup parameter, and manifest must
|
||||||
|
still agree exactly.
|
||||||
|
|
||||||
|
Use a minor track after qualifying that release line. Future patch fixes then
|
||||||
|
arrive on the repository's next pipeline without a version-bump PR or an extra
|
||||||
|
fleet-wide build. Existing exact pins remain supported and are not changed by
|
||||||
|
publishing this capability. YAML minor versions must be quoted to remain strings.
|
||||||
|
|
||||||
|
The central batch tool applies the same update to all supplied checkouts:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python3 tools/rollout_version.py --orb-version 0.8 --write /path/to/repo1 /path/to/repo2
|
||||||
|
```
|
||||||
|
|
||||||
|
This changes only the two canonical CI declarations. Publication policies,
|
||||||
|
contexts, branch/tag filters, and profile options stay unchanged. Normal source
|
||||||
|
and publication checks still run when a pipeline is triggered; this setting does
|
||||||
|
not skip tests. GitHub reusable-worker commit pins are separate and unchanged.
|
||||||
|
|
||||||
|
Automatic patch adoption trades exact-version reproducibility for centrally
|
||||||
|
managed fixes. Keep patch releases backward compatible, qualify central changes
|
||||||
|
before production publication, and use an exact stable pin for a canary or
|
||||||
|
rollback. For example, the same tool can move a consumer from `0.8` back to
|
||||||
|
`0.8.0`. Historical pipeline reruns can resolve a newer patch; choose an exact
|
||||||
|
pin when reproducing an earlier run. Setup and continuation each resolve their
|
||||||
|
orb imports, so patch compatibility also matters when publication overlaps a run.
|
||||||
|
|
||||||
|
Changing minor tracks is an explicit migration. Do not use this feature to push
|
||||||
|
breaking changes into a patch release or to bypass repository checks.
|
||||||
|
|
||||||
|
Reference: [CircleCI orb semantic versioning](https://circleci.com/docs/orbs/use/orb-concepts/).
|
||||||
|
|
||||||
@@ -89,8 +89,8 @@ def load_manifest(path, setup_version):
|
|||||||
allowed += ("java_version",)
|
allowed += ("java_version",)
|
||||||
mapping(data, allowed, "manifest")
|
mapping(data, allowed, "manifest")
|
||||||
version = data.get("orb_version")
|
version = data.get("orb_version")
|
||||||
if not isinstance(version, str) or not re.fullmatch(r"(?:\d+\.\d+\.\d+|dev:[A-Za-z0-9_-]+)", version):
|
if not isinstance(version, str) or not re.fullmatch(r"(?:\d+\.\d+(?:\.\d+)?|dev:[A-Za-z0-9_-]+)", version):
|
||||||
raise ManifestError("orb_version must be an explicit stable or development version")
|
raise ManifestError("orb_version must be a quoted minor track, exact stable pin, or development version")
|
||||||
if version != setup_version:
|
if version != setup_version:
|
||||||
raise ManifestError("Manifest orb_version must match the setup job orb_version")
|
raise ManifestError("Manifest orb_version must match the setup job orb_version")
|
||||||
default_branch = data.get("default_branch")
|
default_branch = data.get("default_branch")
|
||||||
|
|||||||
@@ -89,8 +89,8 @@ def load_manifest(path, setup_version):
|
|||||||
allowed += ("java_version",)
|
allowed += ("java_version",)
|
||||||
mapping(data, allowed, "manifest")
|
mapping(data, allowed, "manifest")
|
||||||
version = data.get("orb_version")
|
version = data.get("orb_version")
|
||||||
if not isinstance(version, str) or not re.fullmatch(r"(?:\d+\.\d+\.\d+|dev:[A-Za-z0-9_-]+)", version):
|
if not isinstance(version, str) or not re.fullmatch(r"(?:\d+\.\d+(?:\.\d+)?|dev:[A-Za-z0-9_-]+)", version):
|
||||||
raise ManifestError("orb_version must be an explicit stable or development version")
|
raise ManifestError("orb_version must be a quoted minor track, exact stable pin, or development version")
|
||||||
if version != setup_version:
|
if version != setup_version:
|
||||||
raise ManifestError("Manifest orb_version must match the setup job orb_version")
|
raise ManifestError("Manifest orb_version must match the setup job orb_version")
|
||||||
default_branch = data.get("default_branch")
|
default_branch = data.get("default_branch")
|
||||||
|
|||||||
@@ -109,8 +109,8 @@ def validate(config_raw, manifest_raw, setup_version):
|
|||||||
if not isinstance(manifest, dict):
|
if not isinstance(manifest, dict):
|
||||||
raise StandardError("Manifest must be a mapping")
|
raise StandardError("Manifest must be a mapping")
|
||||||
version = manifest.get("orb_version")
|
version = manifest.get("orb_version")
|
||||||
if not isinstance(version, str) or not re.fullmatch(r"(?:\d+\.\d+\.\d+|dev:[A-Za-z0-9_-]+)", version):
|
if not isinstance(version, str) or not re.fullmatch(r"(?:\d+\.\d+(?:\.\d+)?|dev:[A-Za-z0-9_-]+)", version):
|
||||||
raise StandardError("Manifest must pin an explicit orb version")
|
raise StandardError("Manifest must select a quoted minor track, exact stable pin, or development version")
|
||||||
if version != setup_version:
|
if version != setup_version:
|
||||||
raise StandardError("Manifest and running setup orb versions differ")
|
raise StandardError("Manifest and running setup orb versions differ")
|
||||||
publishing = manifest.get("publish", {})
|
publishing = manifest.get("publish", {})
|
||||||
|
|||||||
@@ -241,6 +241,15 @@ class PipelineTests(unittest.TestCase):
|
|||||||
self.assertTrue(options["check_middleware_api_versions"])
|
self.assertTrue(options["check_middleware_api_versions"])
|
||||||
self.assertEqual(options["java_version"], "17")
|
self.assertEqual(options["java_version"], "17")
|
||||||
|
|
||||||
|
def test_minor_track_reaches_continuation_without_changing_jobs(self):
|
||||||
|
expected = self.render()
|
||||||
|
expected['orbs']['qqq-orb'] = 'kingsrook/qqq-orb@0.7'
|
||||||
|
self.write_manifest(orb_version='0.7')
|
||||||
|
self.assertEqual(expected, self.render(QQQ_CI_ORB_VERSION='0.7'))
|
||||||
|
if PACKED:
|
||||||
|
self.assertEqual(expected, self.render(packed=True, QQQ_CI_ORB_VERSION='0.7'))
|
||||||
|
self.render(ok=False, QQQ_CI_ORB_VERSION='0.8')
|
||||||
|
|
||||||
def test_branch_matrix(self):
|
def test_branch_matrix(self):
|
||||||
for branch, workflow in [("develop", "publish_snapshot"), ("release/1.0", "publish_release_candidate"),
|
for branch, workflow in [("develop", "publish_snapshot"), ("release/1.0", "publish_release_candidate"),
|
||||||
("main", "test_only"), ("hotfix/fix", "test_only"),
|
("main", "test_only"), ("hotfix/fix", "test_only"),
|
||||||
|
|||||||
@@ -68,6 +68,30 @@ class RolloutTests(unittest.TestCase):
|
|||||||
self.assertFalse(rollout.rollout([root], '0.7.11', write=True)[0]['changed'])
|
self.assertFalse(rollout.rollout([root], '0.7.11', write=True)[0]['changed'])
|
||||||
self.assertEqual(applied, self.contents(root))
|
self.assertEqual(applied, self.contents(root))
|
||||||
|
|
||||||
|
def test_managed_patch_track_and_exact_pin_rollback_preserve_every_profile(self):
|
||||||
|
roots = [self.checkout(profile, profile=profile, default_branch='main')
|
||||||
|
for profile in rollout.standard.PROFILE_PARAMETERS]
|
||||||
|
originals = [yaml.safe_load((root / '.qqq-ci.yml').read_text()) for root in roots]
|
||||||
|
rollout.rollout(roots, '0.7', write=True)
|
||||||
|
for root, original in zip(roots, originals):
|
||||||
|
self.assertEqual({**original, 'orb_version': '0.7'},
|
||||||
|
yaml.safe_load((root / '.qqq-ci.yml').read_text()))
|
||||||
|
rollout.standard.validate(*(data.decode() for data in self.contents(root)), '0.7')
|
||||||
|
rollout.pipeline.load_manifest(root / '.qqq-ci.yml', '0.7')
|
||||||
|
with self.assertRaises(ValueError):
|
||||||
|
rollout.pipeline.load_manifest(root / '.qqq-ci.yml', '0.8')
|
||||||
|
self.assertTrue(all(not r['changed'] for r in rollout.rollout(roots, '0.7', write=True)))
|
||||||
|
rollout.rollout(roots, '0.7.4', write=True)
|
||||||
|
for root, original in zip(roots, originals):
|
||||||
|
self.assertEqual(original, yaml.safe_load((root / '.qqq-ci.yml').read_text()))
|
||||||
|
|
||||||
|
def test_unquoted_track_is_rejected_as_numeric_yaml(self):
|
||||||
|
root = self.checkout('numeric')
|
||||||
|
manifest = root / '.qqq-ci.yml'
|
||||||
|
manifest.write_text(manifest.read_text().replace('0.7.4', '0.7'))
|
||||||
|
with self.assertRaises(ValueError):
|
||||||
|
rollout.pipeline.load_manifest(manifest, '0.7')
|
||||||
|
|
||||||
def test_one_custom_caller_rejects_entire_batch_before_any_write(self):
|
def test_one_custom_caller_rejects_entire_batch_before_any_write(self):
|
||||||
good = self.checkout('good')
|
good = self.checkout('good')
|
||||||
bad = self.checkout('bad')
|
bad = self.checkout('bad')
|
||||||
@@ -97,7 +121,7 @@ class RolloutTests(unittest.TestCase):
|
|||||||
def test_invalid_target_and_duplicate_checkout_are_rejected(self):
|
def test_invalid_target_and_duplicate_checkout_are_rejected(self):
|
||||||
root = self.checkout('qbit')
|
root = self.checkout('qbit')
|
||||||
before = self.contents(root)
|
before = self.contents(root)
|
||||||
for version in ['latest', 'dev:test', '0.7', '0.7.11\n']:
|
for version in ['latest', 'volatile', 'dev:test', '0', '0.7.*', '0.7.11\n']:
|
||||||
with self.assertRaises(ValueError):
|
with self.assertRaises(ValueError):
|
||||||
rollout.rollout([root], version, write=True)
|
rollout.rollout([root], version, write=True)
|
||||||
with self.assertRaises(ValueError):
|
with self.assertRaises(ValueError):
|
||||||
|
|||||||
@@ -56,8 +56,8 @@ def plan(checkout, version):
|
|||||||
|
|
||||||
|
|
||||||
def rollout(checkouts, version, write=False):
|
def rollout(checkouts, version, write=False):
|
||||||
if not re.fullmatch(r'\d+\.\d+\.\d+', version):
|
if not re.fullmatch(r'\d+\.\d+(?:\.\d+)?', version):
|
||||||
raise ValueError('Fleet upgrades require an explicit stable orb version')
|
raise ValueError('Fleet upgrades require a stable minor track or exact patch version')
|
||||||
# Validate the entire batch before writing any repository.
|
# Validate the entire batch before writing any repository.
|
||||||
plans = [plan(path, version) for path in checkouts]
|
plans = [plan(path, version) for path in checkouts]
|
||||||
if len({item['checkout'] for item in plans}) != len(plans):
|
if len({item['checkout'] for item in plans}) != len(plans):
|
||||||
|
|||||||
Reference in new issue
Block a user