Guide to Code Update and Deployment in the Processing and Intelligence Module via GitHub Actions

This workflow ensures that updated code is properly tested, deployed, and communicated to the team, maintaining traceability and organization throughout the process. This is a typical procedure for teams using continuous integration (CI/CD) and deployment automation, with a strong focus on transparency and validation.

Prerequisites for Updating

Before starting the update, make sure the following items are configured:

✅ Git integration completed see the Git integration document.
✅ Access to the repository and permissions to make commits and run workflows.
✅ Local development environment configured, including:

• Git installed.
• Project dependencies installed (requirements.txt or environment.yml).
• Access to the Transformation and Intelligence Module properly configured.

Update Steps

Code Update

1. Create a new branch to modify the code:

git checkout -b minha-nova-feature

2. Make the necessary changes to the code.
3. Test the changes to make sure everything is working correctly.
4. Document all changes made.

Sending Changes to GitHub

1. Add and commit the changes in Git:

git add .
git commit -m "Descrição das alterações realizadas"

2. Push the changes to the remote repository:

git push origin minha-nova-feature

3. Create a Pull Request (PR) on GitHub and request a review (at least 1 reviewer)
4. After review and approval, merge into the main branch.

Running the Workflow in GitHub Actions

After merging into the main branch, you'll need to run the deploy workflow.

1. Access the repository on GitHub.
2. Go to the "Actions" tab.
3. Select the "Deploy Intel Project" workflow.
4. Click "Run workflow" and fill in the following fields:
   1. environment: Select the environment (stg, prd).
   2. cluster_type: Select the cluster type (cluster-intelli, cluster-process).
   3. customer_name: Derive the customer name from the Intelligence module URL.
   4. repository_name: Enter the repository name.
5. Click "Run workflow" to start the process.

Post-Deploy Verification

After the workflow runs, it's essential to verify that the updates were correctly reflected in the intelligence module.

1. Access the transformation or intelligence module.
2. Confirm that the changes were applied correctly.
3. Run tests to make sure everything is working as expected.
4. Document the test results and any issues found.

Documenting the Changes

After updating and validating, it's essential to record the changes to ensure traceability.

📌 Follow the steps below:

1. Document the changes in the GitHub repository.
2. Update the card in Jira with the following details:
3. Description of what was updated.
4. Confirmation that the workflow was run.
5. Post-update test results.

Communicating with the Team

📢 Keeping the team informed about changes is essential for alignment.

1. Send a notification to the team.
2. Include details about:
   • What was changed.
   • Test results.
   • Actions required from the team, if any.

Conclusion

By following this guide, we ensure that updates are made in a controlled, secure, and efficient way. The deployment process in the Intelligence Module via GitHub Actions helps maintain traceability and minimize production errors.