diff --git a/DEVOPS.md b/DEVOPS.md new file mode 100644 index 0000000..9c513d3 --- /dev/null +++ b/DEVOPS.md @@ -0,0 +1,30 @@ +# DevOps Manual πŸ› οΈ + +The `rflow` tool comes with a dedicated `scripts` folder and pipeline configurations for Azure DevOps and GitHub Actions, facilitating its integration into your DevOps pipelines. + +### Setting Up the `scripts` Folder + +The `scripts` folder, located within the `rflow` repository, is designed to be placed directly into the root of your project for automating versioning processes. + +1. **Locate the `scripts` Folder**: Find the `scripts` folder in the `rflow` repository. +2. **Place the `scripts` Folder in Your Project**: Simply copy this folder into the root directory of your project where `rflow` is to be used. + +### Using Pipeline Configurations + +`rflow` provides ready-to-use pipeline files for Azure and GitHub Actions in the `pipelines` folder. These files are prepared for immediate implementation. + +#### For Azure DevOps + +- **Pipeline File**: `azure-rflow.yml` +- **Implementation** : + - Place `azure-rflow.yml` in your Azure DevOps pipeline configuration to integrate `rflow` into your Azure pipelines. + +#### For GitHub Actions + +- **Pipeline File**: `github-rflow.yml` +- **Implementation** : + - Add `github-rflow.yml` to the `.github/workflows` directory of your GitHub repository to integrate `rflow` with your GitHub Actions workflows. + +### Integrating `rflow` into CI/CD + +Integrate `rflow` into your Continuous Integration and Continuous Deployment (CI/CD) processes by using the provided scripts and pipeline files. This integration ensures a smooth and automated process for managing releases and version control in your development cycle. \ No newline at end of file diff --git a/MANUAL.md b/MANUAL.md index ecd03c6..330dd69 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -1,7 +1,3 @@ -Certainly! I'll revise the `rflow` CLI Tool User Manual to remove references to manually checking the `version.info` file, simplifying the process for users. - ---- - # `rflow` CLI Tool User Manual πŸ“˜ Welcome to the `rflow` CLI Tool! This tool automates various tasks in your software version management process. Below are instructions for using the different features available in `rflow`. diff --git a/README.md b/README.md index e6c7659..96a9770 100644 --- a/README.md +++ b/README.md @@ -44,36 +44,9 @@ Ensure you have `pytest` and `pytest-mock` installed in your environment. For detailed instructions on how to use `rflow`, please refer to the [MANUAL.md](MANUAL.md) file in this repository. It provides comprehensive guidance on utilizing all the features of `rflow`. -## DevOps Settings πŸ› οΈ +## πŸ› οΈ DevOps Manual -The `rflow` tool comes with a dedicated `scripts` folder and pipeline configurations for Azure DevOps and GitHub Actions, facilitating its integration into your DevOps pipelines. - -### Setting Up the `scripts` Folder - -The `scripts` folder, located within the `rflow` repository, is designed to be placed directly into the root of your project for automating versioning processes. - -1. **Locate the `scripts` Folder**: Find the `scripts` folder in the `rflow` repository. -2. **Place the `scripts` Folder in Your Project**: Simply copy this folder into the root directory of your project where `rflow` is to be used. - -### Using Pipeline Configurations - -`rflow` provides ready-to-use pipeline files for Azure and GitHub Actions in the `pipelines` folder. These files are prepared for immediate implementation. - -#### For Azure DevOps - -- **Pipeline File**: `azure-rflow.yml` -- **Implementation** : - - Place `azure-rflow.yml` in your Azure DevOps pipeline configuration to integrate `rflow` into your Azure pipelines. - -#### For GitHub Actions - -- **Pipeline File**: `github-rflow.yml` -- **Implementation** : - - Add `github-rflow.yml` to the `.github/workflows` directory of your GitHub repository to integrate `rflow` with your GitHub Actions workflows. - -### Integrating `rflow` into CI/CD - -Integrate `rflow` into your Continuous Integration and Continuous Deployment (CI/CD) processes by using the provided scripts and pipeline files. This integration ensures a smooth and automated process for managing releases and version control in your development cycle. +For detailed instructions on how to automatize versioning with `rflow`, please refer to the [DEVOPS.md](DEVOPS.md) file in this repository. It explains how to prepare your project for a fully automated versioning experience. # πŸ—ΊοΈ Development Roadmap