Skip to content

Deprecated, for removal with the v1.0 release #224

Open

Description

@safl

This is the list of everything deprecated in cijoe, complete up to and including 0.9.67. Everything on it is scheduled for removal with the v1.0 release, and is still in cijoe until then, as each entry's mark says. Each section names the version that deprecated what it lists, oldest first, so if you are on an older cijoe, the sections after your version are what stands between you and the latest one.

Updating is expected to be done by a coding agent, not by hand: give it this issue and the project that uses cijoe, and have it change the project for the version it updates to. Each entry names the old spelling exactly, and what replaces it, so the agent can find every use in the project's configs (*.toml), tasks (*.yaml) and scripts (*.py) and rewrite it.

Most old spellings still work until then, but not all of them say so. Each entry is marked with what happens when it is used with the latest cijoe:

  • warns: it works, and prints a warning on stderr, so running the project's tasks shows what is left to change;
  • logged: it works, and its warning is in the log only, seen with -l;
  • silent: it works, and nothing says it is deprecated, so only the search finds it;
  • no longer works: it already stopped working, without a fallback, before v1.0, so the project must change before it updates.

When something new is deprecated, add a section for its version, mark each entry, and move the version in the first sentence. Whoever then updates a project only has to read from the version they are on.

0.9.17: script entry points

  • worklet_entry and script_entry, now main (Script.NAMING_CONVENTION); silent

0.9.59: workflow, superseded by task

  • workflows/ package subdirectories, now tasks/ (Collector.LEGACY_CATEGORIES); logged
  • -w / --workflow on the CLI, now the task as a positional argument; warns
  • CIJOE_DEFAULT_WORKFLOW, now CIJOE_DEFAULT_TASK; warns
  • cijoe-workflow.yaml as the default task file, now cijoe-task.yaml; logged
  • [cijoe.workflow] fail_fast, now [cijoe.task] fail_fast; logged
  • workflow.state read as a fallback for task.state (cli.py and processing.py); silent
  • process_workflow_output, now process_task_output; silent
  • Workflow imported from cijoe.core.resources, now Task; silent
  • the example_workflow_ prefix accepted by cijoe -e; silent
  • task files with the .workflow suffix, now .yaml; no longer works: they are not collected as tasks, and the .workflow glob in package-data and the yamlfmt hook is all that is left of them

0.9.61: report options

  • -n / --no-report, now --report-skip; warns
  • -p / --produce-report, now --report-only; warns
  • -s / --skip-report, accepted and ignored, as the report is no longer opened unless asked for; warns

0.9.65: the linux package, and building QEMU from source (#226), to be removed at v1.0 with no replacement

  • linux.null_blk and cijoe.linux.null_blk; warns
  • linux.build_kdebs; warns
  • linux.sysinfo, now core.facts_gather; warns
  • the linux examples, example_task_build_kdebs and example_task_null_blk, and their configs; warns, through the scripts they run
  • qemu.build and qemu.install, and their example_task_build / example_config_build; warns

0.9.66: transport, superseded by target (#225), each warns

  • [cijoe.transport.<name>], now [cijoe.targets.<name>.ssh]
  • transport_name= on run(), put(), get(), close() and set_output_ident(), now target=
  • Cijoe.transports, now Cijoe.targets
  • core.wait_for_transport and its transport_name, now core.wait_for_target with the step's target:
  • transport for core.cmdrunner, core.put and core.get, now the step's target:
  • target_name for core.facts_gather and core.tools_check, now the step's target:
  • transport.SSH(config, output_path, <name>), now given the target's [cijoe.targets.<name>.ssh] table

0.9.67: fact gathering moved to cijoe.core.facts (#227)

  • the OS parsers (linux_nvme(), linux_pci(), freebsd_nvme() and the like) imported from cijoe.core.scripts.facts_gather, now from cijoe.core.facts.gathering; no longer works (gather and SECTIONS still import from the script, silent; their place is cijoe.core.facts)

Before v1.0, separately (#236): the logged entries should warn through cijoe.core.misc.deprecated(), which prints to stderr once per spelling, and the silent ones should warn at all, so that every deprecation has had a visible warning for at least one release before it is removed.

Activity

  1. changed the title [-]Remove deprecated spellings at v1.0[/-] [+]Deprecated, for removal with the v1.0 release[/+] on Oct 29, 2026
  2. added this to the v1.0.0 milestone on Oct 29, 2026
  3. added theissue type on Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions