yardmaster 0.1.0__tar.gz

yardmaster-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

yardmaster-0.1.0/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.4
+Name: yardmaster
+Version: 0.1.0
+Summary: Flatcar Container Linux Release Management Tool
+Author-email: Flatcar Team <flatcar-linux-user@googlegroups.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/flatcar/yardmaster
+Project-URL: Documentation, https://github.com/flatcar/yardmaster/docs
+Project-URL: Repository, https://github.com/flatcar/yardmaster
+Project-URL: Issues, https://github.com/flatcar/yardmaster/issues
+Keywords: flatcar,release,automation,linux,containers
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Operating System
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: python-jenkins>=1.8.0
+Requires-Dist: gitpython>=3.1.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: tabulate>=0.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.11.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: sphinx>=7.0.0; extra == "dev"
+Requires-Dist: sphinx-autobuild>=2024.0.0; extra == "dev"
+Requires-Dist: shibuya>=2024.0.0; extra == "dev"
+Requires-Dist: types-requests>=2.31.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.0; extra == "dev"
+Requires-Dist: types-tabulate>=0.9.0; extra == "dev"
+Dynamic: license-file
+
+# Yardmaster
+
+Yardmaster is a release management tool for Flatcar Container Linux. It automates release orchestration across multiple channels (Alpha, Beta, Stable, LTS) and provides commands to prepare, validate, and tag releases.
+
+## Requirements
+
+- Python 3.10+
+- `uv` for environment and dependency management
+
+## Setup
+
+```bash
+# Install dependencies
+make dev-install
+
+# Copy and edit the config file
+cp .yardmaster.yaml.sample .yardmaster.yaml
+# Edit .yardmaster.yaml with your values
+```
+
+### Required environment variables
+
+The config template references these env vars:
+
+- `JENKINS_USER` and `JENKINS_TOKEN` for Jenkins
+- `GPG_KEY_ID` if GPG signing is enabled
+
+Export them before running release commands.
+
+## Release workflow
+
+```bash
+# 1. Initialize release state from a GitHub issue
+yardmaster release init https://github.com/flatcar/Flatcar/issues/1234
+
+# 2. Check status
+yardmaster status
+
+# 3. Run pre-release steps (tagging, branching, Jenkins builds)
+yardmaster release run --pre
+
+# 4. Run post-release steps
+yardmaster release run --post
+
+# 5. Mark release as done
+yardmaster release complete
+```
+
+Use `--dry-run` on any step to preview without making changes.
+
+Useful options:
+
+- `--dry-run`: show actions without executing them
+- `--skip-jenkins`: skip triggering Jenkins builds
+- `--skip-issue-check`: skip GitHub issue title verification
+- `--force`: force tag creation if it already exists
+- `-v`: verbose logging
+
+### Retag
+
+Retag a channel mid-release:
+
+```bash
+yardmaster retag alpha
+```
+
+### Status
+
+View configured channels, planned releases, and release state:
+
+```bash
+yardmaster status
+yardmaster status --show-sdk
+yardmaster status --json
+```
+
+### SDK
+
+Determine SDK versions for upcoming releases:
+
+```bash
+yardmaster sdk determine alpha:3800.0.0
+```
+
+### Jenkins
+
+Trigger a Jenkins PR build:
+
+```bash
+yardmaster jenkins pr-build --dry-run flatcar scripts 1234
+```
+
+## Development
+
+```bash
+make dev-install   # install dev dependencies
+make test          # run tests
+make lint          # lint
+make format        # auto-format
+make type-check    # mypy
+make check         # all of the above
+make fix           # auto-fix formatting + lint
+make all           # fix + check + build
+make clean         # remove build artifacts
+make help          # list all targets
+```
+
+## Notes
+
+- Default config path: `.yardmaster.yaml`
+- Sample config: `.yardmaster.yaml.sample`
+- Workspace default: `~/.yardmaster/workspace`
+- Logs default: `~/.yardmaster/yardmaster.log`
+
+## Troubleshooting
+
+If you see `Config file not found`, copy the sample config:
+
+```bash
+cp .yardmaster.yaml.sample .yardmaster.yaml
+```
+
+Then edit it with your values.
+
+## Configuration
+
+Yardmaster looks for `.yardmaster.yaml` in the current directory by default. You can override this with:
+
+- **`YARDMASTER_CONFIG`** environment variable:
+
+  ```bash
+  export YARDMASTER_CONFIG=~/my-project/.yardmaster.yaml
+  yardmaster status
+  ```
+
+- **`-c` flag** (takes precedence over the env var):
+
+  ```bash
+  yardmaster -c /path/to/config.yaml status
+  ```

yardmaster-0.1.0/README.md

@@ -0,0 +1,140 @@
+# Yardmaster
+
+Yardmaster is a release management tool for Flatcar Container Linux. It automates release orchestration across multiple channels (Alpha, Beta, Stable, LTS) and provides commands to prepare, validate, and tag releases.
+
+## Requirements
+
+- Python 3.10+
+- `uv` for environment and dependency management
+
+## Setup
+
+```bash
+# Install dependencies
+make dev-install
+
+# Copy and edit the config file
+cp .yardmaster.yaml.sample .yardmaster.yaml
+# Edit .yardmaster.yaml with your values
+```
+
+### Required environment variables
+
+The config template references these env vars:
+
+- `JENKINS_USER` and `JENKINS_TOKEN` for Jenkins
+- `GPG_KEY_ID` if GPG signing is enabled
+
+Export them before running release commands.
+
+## Release workflow
+
+```bash
+# 1. Initialize release state from a GitHub issue
+yardmaster release init https://github.com/flatcar/Flatcar/issues/1234
+
+# 2. Check status
+yardmaster status
+
+# 3. Run pre-release steps (tagging, branching, Jenkins builds)
+yardmaster release run --pre
+
+# 4. Run post-release steps
+yardmaster release run --post
+
+# 5. Mark release as done
+yardmaster release complete
+```
+
+Use `--dry-run` on any step to preview without making changes.
+
+Useful options:
+
+- `--dry-run`: show actions without executing them
+- `--skip-jenkins`: skip triggering Jenkins builds
+- `--skip-issue-check`: skip GitHub issue title verification
+- `--force`: force tag creation if it already exists
+- `-v`: verbose logging
+
+### Retag
+
+Retag a channel mid-release:
+
+```bash
+yardmaster retag alpha
+```
+
+### Status
+
+View configured channels, planned releases, and release state:
+
+```bash
+yardmaster status
+yardmaster status --show-sdk
+yardmaster status --json
+```
+
+### SDK
+
+Determine SDK versions for upcoming releases:
+
+```bash
+yardmaster sdk determine alpha:3800.0.0
+```
+
+### Jenkins
+
+Trigger a Jenkins PR build:
+
+```bash
+yardmaster jenkins pr-build --dry-run flatcar scripts 1234
+```
+
+## Development
+
+```bash
+make dev-install   # install dev dependencies
+make test          # run tests
+make lint          # lint
+make format        # auto-format
+make type-check    # mypy
+make check         # all of the above
+make fix           # auto-fix formatting + lint
+make all           # fix + check + build
+make clean         # remove build artifacts
+make help          # list all targets
+```
+
+## Notes
+
+- Default config path: `.yardmaster.yaml`
+- Sample config: `.yardmaster.yaml.sample`
+- Workspace default: `~/.yardmaster/workspace`
+- Logs default: `~/.yardmaster/yardmaster.log`
+
+## Troubleshooting
+
+If you see `Config file not found`, copy the sample config:
+
+```bash
+cp .yardmaster.yaml.sample .yardmaster.yaml
+```
+
+Then edit it with your values.
+
+## Configuration
+
+Yardmaster looks for `.yardmaster.yaml` in the current directory by default. You can override this with:
+
+- **`YARDMASTER_CONFIG`** environment variable:
+
+  ```bash
+  export YARDMASTER_CONFIG=~/my-project/.yardmaster.yaml
+  yardmaster status
+  ```
+
+- **`-c` flag** (takes precedence over the env var):
+
+  ```bash
+  yardmaster -c /path/to/config.yaml status
+  ```

yardmaster-0.1.0/pyproject.toml

@@ -0,0 +1,93 @@
+[project]
+name = "yardmaster"
+version = "0.1.0"
+description = "Flatcar Container Linux Release Management Tool"
+authors = [
+    {name = "Flatcar Team", email = "flatcar-linux-user@googlegroups.com"}
+]
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+keywords = ["flatcar", "release", "automation", "linux", "containers"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: System :: Operating System",
+]
+
+dependencies = [
+    "click>=8.1.0",
+    "requests>=2.31.0",
+    "pyyaml>=6.0",
+    "rich>=13.0.0",
+    "python-jenkins>=1.8.0",
+    "gitpython>=3.1.0",
+    "pydantic>=2.0.0",
+    "tabulate>=0.9.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "pytest-mock>=3.11.0",
+    "ruff>=0.1.0",
+    "mypy>=1.5.0",
+    "sphinx>=7.0.0",
+    "sphinx-autobuild>=2024.0.0",
+    "shibuya>=2024.0.0",
+    "types-requests>=2.31.0",
+    "types-PyYAML>=6.0.0",
+    "types-tabulate>=0.9.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/flatcar/yardmaster"
+Documentation = "https://github.com/flatcar/yardmaster/docs"
+Repository = "https://github.com/flatcar/yardmaster"
+Issues = "https://github.com/flatcar/yardmaster/issues"
+
+[project.scripts]
+yardmaster = "yardmaster.cli:cli"
+
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["yardmaster*"]
+exclude = ["tests*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[dependency-groups]
+dev = [
+    "build>=1.4.2",
+]

yardmaster-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yardmaster-0.1.0/tests/test_jenkins.py

@@ -0,0 +1,17 @@
+from yardmaster.services.jenkins import JenkinsService
+
+
+def test_build_job_url_nested_path() -> None:
+    svc = JenkinsService(url="http://jenkins.example", username=None, token=None)
+    url = svc._build_job_url("container/release")
+    assert url == "http://jenkins.example/job/container/job/release/buildWithParameters"
+
+
+def test_build_pr_version_uses_channel_from_minor() -> None:
+    version = JenkinsService._build_pr_version("3600.1.0", "flatcar-master")
+    assert version == "beta-3600.1.101-flatcar-master"
+
+
+def test_build_pr_version_uses_main_channel() -> None:
+    version = JenkinsService._build_pr_version("3600.2.0", "main")
+    assert version == "main-3600.2.101-main"

yardmaster-0.1.0/tests/test_release.py

@@ -0,0 +1,38 @@
+from pathlib import Path
+
+import pytest
+
+from yardmaster.config import Config
+from yardmaster.core.release import ReleaseManager
+
+
+def test_parse_specs() -> None:
+    specs = ReleaseManager.parse_specs(["alpha:3800.0.0", "beta:3795.1.0"])
+    assert specs[0].channel.value == "alpha"
+    assert str(specs[0].version) == "3800.0.0"
+    assert specs[1].channel.value == "beta"
+
+
+def test_validate_unique_channels(tmp_path: Path) -> None:
+    scripts_dir = tmp_path / "scripts"
+    scripts_dir.mkdir()
+    cfg_text = tmp_path / ".yardmaster.yaml"
+    cfg_text.write_text(
+        f"""repositories:
+  scripts: https://example.invalid/scripts.git
+  coreos_overlay: https://example.invalid/coreos-overlay.git
+  portage_stable: https://example.invalid/portage-stable.git
+paths:
+  scripts: {scripts_dir}
+jenkins:
+  url: http://example.invalid:8080
+channels:
+  alpha:
+    release_url: https://alpha.example.invalid
+"""
+    )
+    cfg = Config.load(cfg_text)
+    mgr = ReleaseManager(cfg)
+    specs = mgr.parse_specs(["alpha:3800.0.0", "alpha:3800.0.1"])
+    with pytest.raises(RuntimeError):
+        mgr.validate(specs)