install

pip install git+https://github.com/lewagon/myriad

uninstall

pip uninstall -y myriad

aliases

alias myr="myriad $@"

local run

if running myriad locally, the content repositories such as data-meta and data-solutions should follow the $HOME/code/$GITHUB_ORG/$REPOSITORY location pattern

code environment & parameters

myriad gha + test myriad gha

git commit GIT_USER_NAME + GIT_USER_EMAIL git config --global user.name $GIT_USER_NAME git config --global user.email $GIT_USER_EMAIL github-actions + [email protected]

git push GIT_PUSH_TOKEN repo + workflow

myriad gha

gh create GH_API_CREATE_TOKEN lewagon-data admin access with scope: admin:org + repo + workflow

test myriad gha

gh delete GH_API_DELETE_TOKEN lewagon-data admin access with scope: delete_repo + admin:org + repo + workflow

setup

copy .env.sample to .env and provide a valid gh personal token with repo read access

🚨 the command assumes that the following repos live in the same directory:

• utils
• data-meta
• data-solutions
• fullstack-meta
• fullstack-solutions

usage

challenge generation

myr gen                       # generate the data-myriad directory of individual repos
myr gen -c fullstack          # generate fullstack-myriad

myr unicity                   # sanity check for dot syllabus challenges gh repo names unicity
myr unicity -p                # list gh repo names along with challenge path

myr synchronized              # sanity check between meta syllabus, dot syllabus and look alike syllabus

myr ver                       # sanity check between conf and myriad repos

meta repo

myr list                      # list the content of the data syllabus
myr list -c fullstack         # list the content of the web syllabus

myr meta                      # generate meta directories and default files in individual solutions
myr meta -c fullstack         # generate meta directories for web syllabus
                              # add `.lewagon/metadata.yml` containing `challenge_output: lewagon-web/ruby-stupid-coaching`
                              # does not override `challenge_output` if it exists
                              # sanity check verifies the unicity of the gh repo names

myr meta --force              # overwrite web repo names with values from CHALLENGE_RENAMING

myr stub                      # generate program syllabus from data meta for the student clone tool

syllabus exploration

python -m wagon_myriad.exploration.syllabus_parser          # parse data syllabus
python -m wagon_myriad.exploration.verify_challenges        # verify data challenges

tests

individual tests:

python -m wagon_myriad.github.context                       # list challenges impacted by commits in current branch in ../../data-solutions vs origin/master
python -m wagon_myriad.models.syllabus.cloned_syllabus      # cloned meta repo syllabus loader
python -m wagon_myriad.models.syllabus.dot_syllabus         # dot syllabus loader
python -m wagon_myriad.models.syllabus.look_alike_syllabus  # look alike syllabus loader

python ../wagon_common/wagon_common/helpers/gh/url.py       # github repo helper

gha

pr on branch name containing --verbose will output additional process info pr on branch name containing --myriad-force will force the generation of all the challenges pr on branch name containing --myriad-overwrite-a7db5e4 will overwrite the individual repo history with initial commit from a7db5e4

the overwrite option will fail if the commit goes back in history to a point where a challenge path as determined in the HEAD by the .lewagon metadata is no longer valid

commits created with user name github-actions and email [email protected]

force generate or resync the myriad challenges

create a PR that adds to the content the gha/templates/myriad-prod-gen.yml GHA as .github/workflows/myriad-prod-gen.yml

use a branch name containing --myriad-force, for example force-gen--myriad-force--verbose if you also want verbose info level in the GHA

the PR does not need to be merged, the GHA will run as soon as the PR is created and will start to generate or resync the challenges

supported challenge patterns

new rule:

• any directory containing a .lewagon/metadata.yml metadata file is published as a challenge

legacy rule:

• 01-Staff/01-Steff/01-Stiff/some/content/there.md
• 01-Staff/01-Steff/Optional-Stiff/some/content/there.md
• 01-Staff/01-Steff/Recap/some/content/there.md
• 01-Staff/01-Steff/some/content/there.md

challengify ignore files

myriad handles the global content repo challengify .syncignore and .challengifyignore files:

• duplicates them to the per challenge temporary sync repo before the sync to the myriad challenge occurs
• edits the content of the file to remove the relative path to the challenge from the rules

goal

create a sync process for individual challenges from data-solutions to individual myriad repositories

• have a library of independant challenge repositories of solutions (that are used by challengify to generate student readable solutions and challenges)
• the challenge repositories correspond to a version of a challenge
• the challenge repositories are indexed by modules of a program
• the program modules index the challenge repositories by branch as currently, which allows to create test programs for a batch for the evolutions of the challenges or lectures
• a challenge version evolves when its composition changes enough that it impacts the performance of the students