Edit an App
Change Request Management in Scoutflo
Last updated
Change Request Management in Scoutflo
Last updated
Change Request Management feature that simplifies the process of editing and managing applications deployed on our platform. This guide provides a detailed walkthrough of how to use this feature effectively, ensuring that you can navigate the Change Request (CR) process with ease.
The Change Request Management feature allows users to modify existing applications, commit changes, and raise change requests for review and approval. This structured approach ensures that all modifications are tracked and managed efficiently, helping collaboration and maintaining security for any changes happening to applications.
Streamlined Editing: Easily edit application configurations without directly affecting the main branch.
Version Control: Utilize branches to manage changes and ensure stability in your deployments.
Collaboration: Raise change requests for team review, ensuring all modifications are approved before deployment.
Navigate to 'My Apps':
Start on the My Apps screen where all your deployed applications are displayed. This is your central hub for managing applications.
Select an Application:
Locate the application you wish to edit and click on the Actions button located in the right corner of each listed app. This button provides access to various options related to that specific application.
Click on the “Edit” Button:
After selecting an application, click on the Edit button (labeled as "Edit App"). This action will redirect you to a section displaying all configuration files associated with that app.
Branch Selection:
You will see a dropdown menu showing all branches available in your GitHub repository. Select a branch from this list to view its current state. This allows you to see how your files differ from those in the main branch.
Important Note: If you are currently on the main branch, the Commit Changes button will be disabled to prevent direct commits to this critical branch. A banner will notify you: “You cannot commit directly to your Main branch; please select a new branch to make commits.”
Viewing Configuration Files:
Upon selecting a branch, you will see all YAML files representing the current state of your application as fetched from your GitHub repository.
Editing Files:
Click on any file where you want to make changes. Initially, you will be in Read-only mode, which prevents any modifications.
To enable editing, click on the Edit button located at the top right corner next to ‘Compare Diff’. This action switches you into Edit mode, allowing you to modify the file contents.
Auto-Save Feature:
As you make changes, they are automatically saved every time you add or remove content. You can switch between files without losing any entered data.
If you click on ‘Compare Diff’ while editing, your progress will still be auto-saved.
Undoing Changes:
If you make a mistake during editing, use 'Reset' button to undo recent changes.
Resetting Changes:
A “Reset” icon is available beside the 'Edit' button. Clicking this icon opens a confirmation modal warning that all progress will be lost if confirmed. If you proceed, it will reset all changes and revert to the default states of all files.
Toast Notifications:
After making changes, a toast notification will confirm that your changes have been saved successfully (e.g., “Your changes are saved successfully.”).
Raise Change Request Button:
Once you have made and saved your changes, click on the Raise Change Request button.
If no changes have been made when this button is clicked, an error toast will inform you that changes are required before raising a CR.
Filling Required Fields:
The Raise Change Request button will remain inactive until you fill in both the ‘Branch Name’ and ‘Commit Message’, which are mandatory fields for raising a CR.
After filling in these details, form validation checks ensure compliance with GitHub rules before submission.
Submitting Your Change Request:
When you click on the Raise Change Request button, a loader appears while your request is being processed.
If successful, the modal closes without retaining any filled data, and a toast notification confirms that your CR has been created.
In case of failure while raising the CR, an error toast is displayed, allowing you to make necessary adjustments and retry.
Redirection After Success:
Upon successful submission of a CR, users are redirected to the CR screen where they can view details of their request.
Change Request Overview:
Users can see an overview of their CRs with details such as ID, title, description, status, creation date, and last updated date.
User Information Display:
The overview section includes information about who requested the change (name, email, avatar) and who is reviewing it.
GitHub Pull Request Information:
Details about linked GitHub pull requests (PR) are displayed alongside commits associated with the CR.
Approval Workflow:
Users can approve or reject CRs based on their review.
The merge button becomes active only after approval if the user is not the owner of the CR.
Merging Changes:
Once approved, clicking the merge button triggers the deployment workflow for the application.
CR History Tracking:
All merged CRs are saved in a history section for auditing purposes.
Declining CRs:
If a user declines a CR, all action buttons become disabled and its status updates accordingly.
Multiple Commits on Pending CRs:
If you select a branch where there is already a CR in ‘Pending review’ status, you can directly commit more changes to that branch within the same CR using the ‘Commit Changes’ button at the top right.
This feature allows users to refine their proposed changes without needing to create a new CR for each modification.
Process for Committing Additional Changes:
Make further edits as needed using the same editing process outlined previously.
Once satisfied with your additional changes, click on ‘Commit Changes’. This action updates the existing CR with all committed modifications.
Users can continue this process until they feel their changes are complete and ready for review.
Consolidated Review Before Merging:
All commits associated with a single CR can be reviewed together during the approval process, allowing reviewers to assess all modifications at once rather than piecemeal.
The Change Request Management feature in Scoutflo enhances collaboration and ensures that application modifications are systematically reviewed and approved before deployment. By following this guide step-by-step, users can effectively manage their applications while maintaining control over changes made within their environments. This structured approach not only improves workflow efficiency but also safeguards application integrity throughout the development lifecycle.
