learningequality / learningequality/ricecooker

Address cheffing script arguments for deploy and publish

Open
#414 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs P0 - critical TAG: tech update / debt
Dominant language
Python
Stars
31
Forks
77
Avg merge
5d 4h
Merged PRs (30d)
3

Description

  • ricecooker version: develop branch

Summary

It appears that --deploy no longer does anything. It is also a prerequisite for also passing --publish. On Studio, we re-architected how the deploy process functions to utilize change events. Publishing already uses the same change event mechanism. The change event mechanism would require polling of Studio in order to determine if those change events are applied.

Additionally, --deploy maps to stage in the code, and is confusing because there was at one point a --stage arg that is now deprecated and is the default behavior.

Desired behavior

Reviewing a staged channel on Studio before deploying it sounds like the ideal workflow that we want to encourage, but we may wish to keep this ability within ricecooker. That means we either need to:

  • remove the arguments and their functionality, and update the documentation, or
  • update their functionality to function with changes made to Studio, allowing these to process the operations in change events

Reference: https://github.com/learningequality/studio/pull/3997

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the cheffing script argument handling for --deploy, --publish, and the deprecated --stage option, then read the referenced Studio change-event redesign. Define whether the work removes these arguments and updates documentation or restores their behavior through change events; completion should include a documented, working workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.