-
Notifications
You must be signed in to change notification settings - Fork 43
Add GitHub Actions CI/CD example for Flask app deployment #119
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
davmano
wants to merge
1
commit into
tungbq:main
Choose a base branch
from
davmano:feature/github-actions-flask
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
32 changes: 32 additions & 0 deletions
32
github-actions-flask-deploy/.github/workflows/flask-deploy.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: Flask CI/CD | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main ] | ||
|
|
||
| jobs: | ||
| build-and-deploy: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: '3.10' | ||
|
|
||
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install -r requirements.txt | ||
|
|
||
| - name: Run tests (placeholder) | ||
| run: | | ||
| echo "No tests defined." | ||
|
|
||
| - name: Deploy (placeholder) | ||
| run: | | ||
| echo "App would deploy here (e.g., to Heroku, Render, EC2, etc)" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # GitHub Actions CI/CD Example – Flask App | ||
|
|
||
| This example shows how to automate testing and deployment of a simple Flask application using GitHub Actions. | ||
|
|
||
| ## 📁 Structure | ||
|
|
||
| - `app.py`: Basic Flask web app | ||
| - `requirements.txt`: Dependencies | ||
| - `.github/workflows/flask-deploy.yml`: CI/CD pipeline | ||
|
|
||
| ## 🚀 GitHub Actions Workflow | ||
|
|
||
| Triggered on every push to `main`: | ||
|
|
||
| 1. Checkout code | ||
| 2. Set up Python | ||
| 3. Install dependencies | ||
| 4. (Placeholder) Run tests | ||
| 5. (Placeholder) Deploy app | ||
|
|
||
| ## 🔧 Deployment | ||
|
|
||
| This example includes a placeholder deploy step. You can customize it to: | ||
|
|
||
| - Deploy to EC2 via SSH | ||
| - Push to Heroku | ||
| - Use Docker + AWS ECS | ||
|
|
||
| ## ✅ Getting Started Locally | ||
|
|
||
| ```bash | ||
| pip install -r requirements.txt | ||
| python app.py | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| from flask import Flask | ||
|
|
||
| app = Flask(__name__) | ||
|
|
||
| @app.route('/') | ||
| def index(): | ||
| return "Hello From Github Actions CI/CD Pipeline!" | ||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| flask |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution @davmano, I appreciate your interested on this project. this PR looks good to me, just one comment about the auto trigger event.
This would trigger and run the pipeline every push on main even if it's not related to the
github-actions-flask-deployproject. Can you please add the filter on this push to only run when there has any change in thegithub-actions-flask-deployfolder only. Thanks.