-
Notifications
You must be signed in to change notification settings - Fork 99
docs(dr): propose changes to aliasfy package #1418
base: main
Are you sure you want to change the base?
Conversation
Add a DR proposing change to aliasfy package to eliminate redundancy
Reviewpad Report
|
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1418 +/- ##
=======================================
Coverage 46.80% 46.80%
=======================================
Files 70 70
Lines 2662 2662
Branches 302 302
=======================================
Hits 1246 1246
Misses 1414 1414
Partials 2 2 ☔ View full report in Codecov by Sentry. |
- If neither is found, an error will be thrown. | ||
|
||
|
||
- To ensure the changes do not disrupt exising users of the aliasfy feature, this enhanced aliasfy package feature has to be explictly enabled as 'aliasfyv2'in the sfdx-project.json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we do it the other way around? as in you need to specify V1 if you want to remain on the current thing, so that in the future we can just deprecate V1 without having to maintain this flag?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that idea, but that means if the users don't see the announcement, they might inadvertently deploy 'default' components into production.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @azlam-abdulsalam . We have to be backward compatible. I bet most of the org user :latest
image (like we at K).
I would suggest being more specific on the name of this enhancement as it provides certain features, not many - inheritance.
Options:
alisifiedInheritence
aliasfyInheritence
enableAlisifiedInheritence
enableAlisifyInheritence
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or may be better, we treat it as a default behaviour for all package? @ruslan-kurchenko @rody , if it sees an aliasified folder, it will start doing this behaviour across any source package
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@azlam-abdulsalam when you refer to all packages, do you mean that some repos would have like a core-crm source package folder and within that have specific dev, sit, uat alias packages inside that package?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@crazynammer that's correct, any packages can have env specific overrides, but at the same time, this idea of aliasified envs is conflicting with our notion of detaching tests from dedicated environments,
Great enhancement. We recently talked about it with the team as we started to accumulate so many env variables that we need to maintain. |
Nice!! |
This a a great idea! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea. We'll just have to keep track of all the toggles for aliasfyv2 in the documentation and any other items like this in the future roadmap.
- If neither is found, an error will be thrown. | ||
|
||
|
||
- To ensure the changes do not disrupt exising users of the aliasfy feature, this enhanced aliasfy package feature has to be explictly enabled as 'aliasfyv2'in the sfdx-project.json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@azlam-abdulsalam when you refer to all packages, do you mean that some repos would have like a core-crm source package folder and within that have specific dev, sit, uat alias packages inside that package?
Add a DR proposing change to aliasfy package to eliminate redundancy
Summary generated by Reviewpad on 09 Oct 23 02:47 UTC
This pull request proposes changes to the aliafy package in order to eliminate redundancy. The current implementation of aliasified packages introduces redundancy by duplicating the contents of the 'default' directory across multiple environment-specific directories. The proposed solution is to introduce a layer of inheritance for aliasified packages, where the contents in the 'default' directory will be merged with the contents in the
<alias>
directory if an alias is matched. By implementing this inheritance mechanism, the PR aims to reduce redundancy, simplify maintenance, and minimize the scope for errors.Checklist
All items have to be completed before a PR is merged