At Clayton, we're committed to helping you build robust, scalable, and secure solutions on Salesforce. That's why we're excited to announce our new Well-Architected Managed Policies!
Salesforce published almost 1 year ago the latest release of the Salesforce Well-Architected Framework. The framework helps diagnose and solve architectural issues and provides prescriptive guidance, patterns to follow, and anti-patterns to avoid.
You might have noticed that in Clayton, all issues are now decorated with some new tags that correspond, in fact, to the Well-Architected taxonomy, as you can see in the screenshots below:
These tags are already extremely useful for diagnosing issues for those familiar with the framework, but we are going to take a more fundamental step towards helping you embrace the Well-Architected framework.
This step is retiring the Classical Managed Policies in favour of the new Well-Architected Managed Policies.
The Power of the Salesforce Well-Architected Framework
If you do not know the Salesforce Well-Architected framework, there is an official website dedicated to it, and we encourage you to visit: https://architect.salesforce.com/well-architected/overview
You can also watch some of the videos on our YouTube channel that talk about it:
What's New with Well-Architected Managed Policies
Clayton's Well-Architected Managed Policies are designed to streamline the process of evaluating code against the Salesforce Well-Architected Framework. These policies provide a structured approach to assess the quality and compliance of code with the framework's principles, making it easier for development teams to maintain alignment with Salesforce standards, as you can see in the screenshots below:
The new policies map to Salesforce's Well-Architected behaviours (how a healthy system should act) and are sorted by priority: Secure, Compliant, Reliable, Intentional, Automated, Engaging, Resilient, and Composable.
Benefits of migrating to Well-Architected Managed Policies
Equipping your developers with the Well-Architected Framework empowers them to build robust and scalable solutions on Salesforce. This benefits your current projects and positions your team for success in the ever-growing Salesforce ecosystem, making them more valuable assets. We believe that making Clayton more aligned with this framework will greatly help all development teams implement such a framework.
Migrating from Classical to Well-Architected Managed Policies
To start leveraging Clayton's Well-Architected Managed Policies, you will be offered in-app tools to perform the following steps:
Read the current document and learn more about the Well-Architected framework
Install the new set of Well-Architected Managed Policies in your Clayton Workspace
Once installed the new set of Well-Architected Managed Policies the Classical Managed Policies will be disabled (new projects can not use them anymore)
Migrate, at your own pace, one project at a time in your Clayton Workspace
All dismissed issues will be preserved
A new scan with the new policies will be triggered automatically on the HEAD of the project default branch
Uninstall the Classical Managed Policies from your Clayton Workspace
Migration process timeline
We have planned three phases:
Awareness, duration 1 month; if you are reading this document for the first time, you are here
Installation, duration 1 month. Clayton workspaces created before May 2024 will be provisioned with the new Well-Architected Managed Policies. You will have 30 days to pick the right moment to install them and automatically retire the Classical Managed Policies (which will not be selectable in new projects).
Migration, duration max 2 months. The sooner you install the Well-Architected Managed Policies (phase 2), the more time you will have to migrate your projects and, overall, the sooner you will get new rules and updates.
This timeline is indicative; overall, we will always be available to help you.
Conclusion
The introduction of new code review policies in Clayton marks a significant step towards ensuring compliance with the Salesforce Well-Architected Framework.
Embrace Clayton's new code review policies to streamline development processes and maintain alignment with industry best practices.
Need Help?
If you need further assistance or have any questions, feel free to contact our customer support team. Our experts are always here to help with any inquiries or concerns you may have.
FAQs
What are Well-Architected Managed Policies, and why migrate?
What are Well-Architected Managed Policies, and why migrate?
Clayton's Well-Architected Managed Policies are a new set of code review policies designed to streamline the process of evaluating code against the Salesforce Well-Architected Framework. This framework helps ensure your code is secure, scalable, and reliable.
Migration is mandatory and will allow you to build future-proof solutions and grow better engineering talent.
How does the migration process work?
How does the migration process work?
The migration is self-paced and consists of these steps (all managed within Clayton Workspace):
Learn about Well-Architected: this document provides an overview.
Well-Architected Managed Policies installation: this activates the new policies in your Clayton Workspace and retires the Classical Managed Policies.
Migrate Projects: move projects from Classical to Well-Architected Managed Policies one by one. (Dismissed issues and metrics are preserved.)
How long will the migration process for one project be?
How long will the migration process for one project be?
It depends on project by project, but essentially, it will perform a new baseline scan of the whole project. It should take as long as the first scan you did once you connected the project the first time.
What if I have only custom policies?
What if I have only custom policies?
Installing the Well-Architected Managed Policies allows you to keep your custom policies and still benefit from Clayton's rules catalogue updates.
Will this affect my reporting (e.g. outstanding issues, policy name, severity levels)?
Will this affect my reporting (e.g. outstanding issues, policy name, severity levels)?
Reports grouping metrics by policy will be grouped differently after the migration. The total number of detected issues won't change, just their aggregation at the policy level.
However, the severity levels of the outstanding issues may change according to the configuration of the new Well-Architected Framework policies.
Does adopting these policies cover all Well-Architected Framework anti-patterns?
Does adopting these policies cover all Well-Architected Framework anti-patterns?
Clayton is committed to keeping policies aligned with the framework as much as possible. However, the framework is extensive, and Clayton currently focuses on your codebase.