add oop i did it again

state-alchemists · Nov 4, 2023 · d0842db · d0842db
1 parent b232271
commit d0842db
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/zrb/android-chrome-192x192.png)
 
-[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
+[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [💃 Oops, I did it Again](https://github.com/state-alchemists/zrb/blob/main/docs/oops-i-did-it-again/README.md)| [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
 
 Zrb is a [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) automation [tool](https://en.wikipedia.org/wiki/Programming_tool) and [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) platform. Once installed, Zrb will help you automate day-to-day tasks, generate projects and applications, and even deploy your applications to Kubernetes with a few commands.
 

diff --git a/docs/README.md b/docs/README.md
@@ -5,6 +5,7 @@
 - [Configurations](configurations.md)
 - [Tutorials](tutorials/README.md)
 - [Troubleshooting](troubleshooting/README.md)
-- [For contributors](for-contributors.md)
-- [For maintainers](for-maintainers.md)
+- [Oops, I Did it Again: Most Common Mistakes When Working with Zrb](oops-i-did-it-again/README.md)
+- [Contributor Guide](contributor-guide.md)
+- [Maintainer Guide](maintainer-guide.md)
 - [FAQ](faq/README.md)
diff --git a/docs/for-contributors.md → docs/contributor-guide.md b/docs/for-contributors.md → docs/contributor-guide.md
@@ -1,6 +1,6 @@
 🔖 [Table of Contents](README.md)
 
-# For contributors
+# Contributor Guide
 
 
 As contributors, there are some things you can do:

diff --git a/docs/for-maintainers.md → docs/maintainer-guide.md b/docs/for-maintainers.md → docs/maintainer-guide.md
@@ -1,6 +1,6 @@
 🔖 [Table of Contents](README.md)
 
-# For maintainers
+# Maintainer Guide
 
 
 To publish Zrb, you need a `Pypi` account:

diff --git a/docs/oops-i-did-it-again/README.md b/docs/oops-i-did-it-again/README.md
@@ -0,0 +1,3 @@
+# Oops, I did it again: Most Common Mistakes When Working with Zrb
+
+Collection of
diff --git a/src/zrb/task/docker_compose_task.py b/src/zrb/task/docker_compose_task.py
@@ -150,6 +150,8 @@ def __init__(
         self._compose_runtime_file = self._get_compose_runtime_file(
             self._compose_template_file
         )
+        # Flag to make mark whether service config and compose environments
+        # has been added to this task's envs and env_files
         self._is_additional_env_added = False
 
     def copy(self) -> TDockerComposeTask:
@@ -164,6 +166,12 @@ async def run(self, *args, **kwargs: Any) -> CmdResult:
         return result
 
     def _get_all_envs(self) -> Mapping[str, Env]:
+        '''
+        This method override BaseTask's _get_all_envs.
+        Whenever _get_all_envs is called, we want to make sure that:
+        - Service config's envs and env_files are included
+        - Any environment defined in docker compose file is also included
+        '''
         if self._is_additional_env_added:
             return super()._get_all_envs()
         self._is_additional_env_added = True
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Oops, I did it again: Most Common Mistakes When Working with Zrb

		Collection of