Release Web Ideation Milestone

[matthewctechnology]

Summary

Release Web Ideation Milestone

Description

Finalize ideate web milestone deliverable, update web app and documentation, validate end-to-end flow, and mark as complete for review by stakeholders.

Proposal

• Update README to reflect web milestone (setup, codespaces, browser usage, developer FAQ)
• Review and summarize what is complete, confirm tests and lint pass
• Tag/label web milestone and close related issues

Example

# ideate Web App
## How to run the server, browse via Codespaces, and get an idea

Criteria

• Given milestone label is applied, when all acceptance criteria and definition of done are satisfied, then README is up to date for developer and user and Project board advances to next phase

Manual

Create Issue to Represent Milestone End

1. Browse GitHub → Repository → Issues
2. Create Issue for Release
3. Add Issue to Milestone

Bump Version, Tag, and Push

1. Create Issue branch based on main

   git switch main && git pull origin main:main && git switch -c stacked-#`

2. Go to ideate and activate the environment

cd /workspaces/stacked/ideate && source .ideate/bin/activate

3. Run the script for version type

   .scripts/version.sh minor

Close Milestone

1. Browse GitHub → Repository → Issues → Milestones
2. Select Milestone
3. Close Milestone

Create Release

1. Browse GitHub → Releases → Draft a new release
2. Select the latest tag (e.g., v0.2.0)
3. Name the release after the milestone
4. Add release notes referencing the milestone and issues

Tests

1. Run cd /workspaces/stacked/ideate && source .ideate/bin/activate

• Activates environment (.ideate)

2. Run pylint ideate && pytest ideate/tests

• Lints without errors
• Tests without failures
• Tests pass

3. Board changes

• All milestone issues are completed/tested/linted

4. Apply milestone complete label/tag

• Milestone complete

[matthewctechnology]

Design

Straightforward release by running the version script for ideate. Then GitHub UI changes with PR, Release, Milestones, etc.

Summary

Release Web Ideation Milestone

Description

Finalize ideate web milestone deliverable, update web app and documentation, validate end-to-end flow, and mark as complete for review by stakeholders.

Changes

• Update README to reflect web milestone (setup, codespaces, browser usage, developer FAQ)
• Review and summarize what is complete, confirm tests and lint pass
• Tag/label web milestone and close related issues

Criteria

• Given milestone label is applied, when all acceptance criteria and definition of done are satisfied, then README is up to date for developer and user and Project board advances to next phase

Manual

Create Issue to Represent Milestone End

1. Browse GitHub → Repository → Issues
2. Create Issue for Release
3. Add Issue to Milestone

Bump Version, Tag, and Push

1. Create Issue branch based on main

   git switch main && git pull origin main:main && git switch -c stacked-#`

2. Go to ideate and activate the environment

cd /workspaces/stacked/ideate && source .ideate/bin/activate

3. Run the script for version type

   .scripts/version.sh minor

Close Milestone

1. Browse GitHub → Repository → Issues → Milestones
2. Select Milestone
3. Close Milestone

Create Release

1. Browse GitHub → Releases → Draft a new release
2. Select the latest tag (e.g., v0.1.0)
3. Name the release after the milestone
4. Add release notes referencing the milestone and issues

Tests

1. Run cd /workspaces/stacked/ideate && source .ideate/bin/activate

• Activates environment (.ideate)

2. Run pylint ideate && pytest ideate/tests

• Lint without errors
• Tests without failures
• Tests pass

3. Board changes

• All milestone issues are completed/tested/linted

4. Apply milestone complete label/tag

• Milestone complete

[matthewctechnology]

Deployed 🚀

stacked-prod succeeded in 2m 47s 🟢 ☑️

[matthewctechnology]

Delivered 🎁

Documents and Tags ideate v.0.2.0 for Release.

Tests

Ideates with topic option via Web Page 🟢 ☑️

1. View README and run pip install -r .ideate/requirements.txt

• Dependencies installed as per updated README ✔️

2. Run cd /workspaces/stacked/ideate && source .ideate/bin/activate

• Activates environment (.ideate) ✔️

3. Run pylint ideate && pytest tests

• Lints without errors✔️
• Tests units/interfaces without failures✔️
• Tests end-to-end without failures ✔️

4. Run cd /workspaces/stacked && uvicorn ideate.api.ideate:app --reload

• Starts backend app✔️

5. Run cd /workspaces/stacked/ideate && streamlit run web/ideate.py

• Starts frontend app✔️

6. Submit without topic in browser

• Outputs an intelligent idea e.g. <AI Idea>✔️

7. Select topic in browser

• Shows topics Adventure, Art, ...✔️
• Shows selected topic: Art✔️

8. Submit with topic in browser

• Outputs an intelligent idea e.g. Art Idea: <AI Idea>✔️

9. Select fallback in browser

• Shows fallback option selected ✔️

10. Submit with fallback in browser

• Outputs an intelligent idea e.g. <Fallback Idea>✔️