As a Notify Dev, I need adequate build automation tooling so that I can define, implement, and document supporting scripts and tasks for each of Notify's projects.
WHY are we building?
Our current build automation tooling, make, is quite old having first appeared in 1976. While useable, a more modern build automation tool empowers devs with an expanded toolbox to take automation of menial tasks to the next level, and increase developer efficiency.
Poe the Poet's inherent options for documenting tasks provide us with a point of reference to easily understand what automations are available to us, and will serve as a great resource during onboarding of new developers.
WHAT are we building?
Integration of Poe the Poet into each of our projects as a replacement for make.
Documentation and Artifacts
Good docs, figma mockups, ADRs, screenshots etc.
Acceptance Criteria
Given Poe the Poet is adopted, when the opportunity arises to further automate developer workflows and improve efficiency, then developers have a modern set of tools available to them to achieve this goal.
[x] Make is replaced with Poe the Poet in each of our projects
[x] CI changes are tested and working
[x] Documentation is written to support developers through the transition and socialize the tool with the team
Parallelizable tasks
Admin
[x] The Poe the Poet dependency is added
[x] Tasks in our makefiles are implemented in pyproject.toml as poe tasks and adequately documented
[x] Calls to make tasks are replaced with calls to the equivalent poe task in our CI Files
[x] Any scripts external to our makefile, but that support make tasks, have been updated with poe in mind and tested
[x] CI changes are tested
API
[x] The Poe the Poet dependency is added
[ ] Tasks in our makefiles are implemented in pyproject.toml as poe tasks and adequately documented
[ ] Calls to make tasks are replaced with calls to the equivalent poe task in our CI Files
[ ] Any scripts external to our makefile, but that support make tasks, have been updated with poe in mind and tested
[ ] CI changes are tested
Document Download API
[x] The Poe the Poet dependency is added
[ ] Tasks in our makefiles are implemented in pyproject.toml as poe tasks and adequately documented
[ ] Calls to make tasks are replaced with calls to the equivalent poe task in our CI Files
[ ] Any scripts external to our makefile, but that support make tasks, have been updated with poe in mind and tested
[ ] CI changes are tested
Utils
[x] The Poe the Poet dependency is added
[ ] Tasks in our makefiles are implemented in pyproject.toml as poe tasks and adequately documented
[ ] Calls to make tasks are replaced with calls to the equivalent poe task in our CI Files
[ ] Any scripts external to our makefile, but that support make tasks, have been updated with poe in mind and tested
[ ] CI changes are tested
Lambdas
[ ] The Poe the Poet dependency is added
[ ] Tasks in our makefiles are implemented in pyproject.toml as poe tasks and adequately documented
[ ] Calls to make tasks are replaced with calls to the equivalent poe task in our CI Files
[ ] Any scripts external to our makefile, but that support make tasks, have been updated with poe in mind and tested
Description
As a Notify Dev, I need adequate build automation tooling so that I can define, implement, and document supporting scripts and tasks for each of Notify's projects.
WHY are we building? Our current build automation tooling,
make
, is quite old having first appeared in 1976. While useable, a more modern build automation tool empowers devs with an expanded toolbox to take automation of menial tasks to the next level, and increase developer efficiency. Poe the Poet's inherent options for documenting tasks provide us with a point of reference to easily understand what automations are available to us, and will serve as a great resource during onboarding of new developers.WHAT are we building? Integration of Poe the Poet into each of our projects as a replacement for
make
.Documentation and Artifacts
Good docs, figma mockups, ADRs, screenshots etc.
Acceptance Criteria
Given Poe the Poet is adopted, when the opportunity arises to further automate developer workflows and improve efficiency, then developers have a modern set of tools available to them to achieve this goal.
Make
is replaced withPoe the Poet
in each of our projectsParallelizable tasks
Admin
makefiles
are implemented inpyproject.toml
aspoe
tasks and adequately documentedmake
tasks are replaced with calls to the equivalentpoe
task in ourCI Files
makefile
, but that supportmake
tasks, have been updated withpoe
in mind and testedAPI
makefiles
are implemented inpyproject.toml
aspoe
tasks and adequately documentedmake
tasks are replaced with calls to the equivalentpoe
task in ourCI Files
makefile
, but that supportmake
tasks, have been updated withpoe
in mind and testedDocument Download API
makefiles
are implemented inpyproject.toml
aspoe
tasks and adequately documentedmake
tasks are replaced with calls to the equivalentpoe
task in ourCI Files
makefile
, but that supportmake
tasks, have been updated withpoe
in mind and testedUtils
makefiles
are implemented inpyproject.toml
aspoe
tasks and adequately documentedmake
tasks are replaced with calls to the equivalentpoe
task in ourCI Files
makefile
, but that supportmake
tasks, have been updated withpoe
in mind and testedLambdas
makefiles
are implemented inpyproject.toml
aspoe
tasks and adequately documentedmake
tasks are replaced with calls to the equivalentpoe
task in ourCI Files
makefile
, but that supportmake
tasks, have been updated withpoe
in mind and testedRelated Research Airtable records
QA Steps