sprint-5-complete

New Features

• GuideFrame code walkthrough script created and featured in the repo and on youtube (links in README).
• Docs site now hosted on GitHub pages with workflow configured for publishing.
• Tutors demo updated in line with magento demo where functions in use are named.
• Template repo script changed to use magento script.
• New GuideFrame demos directory added and accounted for in workflows.
• README reworked to point to docs, template repo and useful resources.

What's Changed

• task(GUIDEFRAME-45): create GuideFrame code walkthrough by @chipspeak in #29
• task(GUIDEFRAME-47): Manually create new PyPi release by @chipspeak in #30
• task(GUIDEFRAME-46): create github pages docs site by @chipspeak in #31
• task(GUIDEFRAME-46): updating docs workflows by @chipspeak in #32
• task(GUIDEFRAME-52): adding docs to site by @chipspeak in #40
• task(GUIDEFRAME-54): update code snippet headings in docs by @chipspeak in #41
• task(GUIDEFRAME-55): updated tutors demo by @chipspeak in #42
• task(GUIDEFRAME-56): moved demos to new dirs by @chipspeak in #43
• task(GUIDEFRAME-57): update code walkthrough by @chipspeak in #44
• task(GUIDEFRAME-58): extensive README update. by @chipspeak in #45
• fix(GUIDEFRAME-59): typo in README by @chipspeak in #46

Full Changelog: sprint-4-complete...sprint-5-complete

sprint-4-complete

New Features

• Project now published in PyPi.
• Template repository created which uses the new GuideFrame package and the tutors test as a user starting point.
• Added instructions to this repository on usage.
• Created a workflow to publish to PyPi on new version number tags.
• This workflow can also be manually triggered.

What's Changed

• task(GUIDEFRAME-40): reconfigure project for pypi by @chipspeak in #24
• task(GUIDEFRAME-41): add publish to pypi action by @chipspeak in #25
• fix(GUIDEFRAME-43): add permissions to publish action by @chipspeak in #26
• fix(GUIDEFRAME-43): add permissions to publish action by @chipspeak in #27
• task(GUIDEFRAME-42): create guideframe template repo by @chipspeak in #28

Full Changelog: sprint-3-complete...sprint-4-complete

sprint-3-complete

New Features:

• Added functionality to parse a markdown file for the step audio.
• Refactored core logic to remove as much from GuideFrame scripts as possible.
• Added randomised video file name using script name + random uuid.
• Added additional selenium functions.
• New selenium test script to check selenium functionality via Magneto test site.
• New GuideFrame script using the same Magneto test site.
• Core logic files now include "guideframe" prefix to aid legibility.
• Reorganised directory structure (moved selenium test + demo scripts to specific directory).
• Workflow file (tutors-test) now uses wildcard to avoid hard coded video file names.

What's Changed

• GUIDEFRAME-25 by @chipspeak in #14
• GUIDEFRAME-31 by @chipspeak in #15
• task(GUIDEFRAME-32): added new sel funcs + test script by @chipspeak in #17
• task(GUIDEFRAME-34): Added guideframe demo of selenium functions by @chipspeak in #18
• task(GUIDEFRAME-35): Use random UUID + script name for file by @chipspeak in #19
• task(GUIDEFRAME-36): Rename files to include GuideFrame in name by @chipspeak in #20
• fix(GUIDEFRAME-37): Adjust output name in workflow by @chipspeak in #21
• task(GUIDEFRAME-33): Reorganise directory structure by @chipspeak in #22
• task(GUIDEFRAME-38): Reconfigure test into workflow by @chipspeak in #23

Full Changelog: sprint-2-complete...sprint-3-complete

sprint-2-complete

This release serves as a snapshot of GuideFrame as of the completion of implementation Sprint 1.

New Features:

• GitHub action renders a video on push and stores it as an artefact.
• Script now takes args for OS for workflow or workstation
• GuideFrame steps functionality moved to single, parameterised function.

What's Changed

• task(GUIDEFRAME-27): implementing GuideFrame render as CI/CD workflow
• fix(GUIDEFRAME-30): manually set window size if maximise fails by @chipspeak in #13
• task(GUIDEFRAME-13): created template function for steps by @chipspeak in #12

Full Changelog: sprint-1-complete...sprint-2-complete

sprint-1-complete

This release serves as a snapshot of GuideFrame as of the completion of implementation Sprint 1.

Current Features:

• Functional selenium walkthrough of tutors as outlined in tutors_test.py.
• Functional recording of walkthrough in video segments via video.py functions.
• Functional audio creation via gTTS functions within audio.py.
• Functional assembly of all above elements via assembly.py.

What's Changed

• task(GUIDEFRAME-5): testing branch link to Jira by @chipspeak in #1
• GUIDEFRAME-6 by @chipspeak in #2
• task(GUIDEFRAME-6): added gTTS implementation in advance of assembly … by @chipspeak in #3
• GUIDEFRAME-7 by @chipspeak in #4
• GUIDEFRAME-9 by @chipspeak in #5
• task(GUIDEFRAME-11): refactored FFMPEG section to use wrapper by @chipspeak in #6
• task(GUIDEFRAME-10): implemented video assembly logic by @chipspeak in #7
• GUIDEFRAME-12 Create tutors demo by @chipspeak in #8
• task(GUIDEFRAME-15): selenium functionality moved to separate script by @chipspeak in #9

New Contributors

• @chipspeak made their first contribution in #1

Full Changelog: https://github.com/chipspeak/final_project/commits/sprint-1-complete