https://github.com/jmdotdev/ci-cd
This repository serves as a simple demonstration of Continuous Integration (CI) and Continuous Deployment (CD) using GitHub Actions and a Python script.
https://github.com/jmdotdev/ci-cd
github-actions python yaml-files
Last synced: 7 months ago
JSON representation
This repository serves as a simple demonstration of Continuous Integration (CI) and Continuous Deployment (CD) using GitHub Actions and a Python script.
- Host: GitHub
- URL: https://github.com/jmdotdev/ci-cd
- Owner: jmdotdev
- Created: 2024-01-03T13:07:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T07:44:29.000Z (over 1 year ago)
- Last Synced: 2025-01-25T11:42:55.684Z (8 months ago)
- Topics: github-actions, python, yaml-files
- Language: Python
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# CI/CD Example with GitHub Actions
This repository serves as a simple demonstration of Continuous Integration (CI) and Continuous Deployment (CD) using GitHub Actions and a Python script.
## Table of Contents
- [Overview](#overview)
- [Workflow](#workflow)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)
## Overview
The main goal of this project is to showcase how to set up a basic CI/CD pipeline using GitHub Actions. The repository contains a single Python script, `main.py`, which performs a basic operation. The CI/CD workflow is triggered automatically on each push to the main branch.
## Workflow
The CI/CD workflow in this project consists of the following steps:
1. **Build:** Checks out the code and sets up the Python environment.
2. **Test:** Runs unit tests on the Python script to ensure its functionality.
3. **Deploy:** If the tests pass, deploys the Python script or its artifacts. (Note: In this example, deployment is kept minimal.)
The workflow configuration is defined in the [`.github/workflows/main.yml`](.github/workflows/main.yml) file.
## Getting Started
To run this CI/CD example locally or integrate it into your own project, follow these steps:
1. **Clone the Repository:**
```bash
git clone https://github.com/your-username/CI-CD.git
cd CI-CD
```
2. **Run the Python Script:**
```bash
python main.py
```
3. **Explore GitHub Actions:**
- Open the [Actions tab](https://github.com/your-username/CI-CD/actions) in your GitHub repository to view CI/CD workflow runs.
- Review the workflow configuration in [`.github/workflows/main.yml`](.github/workflows/main.yml) to understand the pipeline.
4. **Customize as Needed:**
- Modify the workflow, script, or other components based on your project requirements.
## Contributing
If you find issues or have suggestions for improvements, feel free to open an issue or create a pull request. Contributions are welcome!
## License
This project is licensed under the [MIT License](LICENSE).
---