Merge pull request #362 from Qovery/feat/deployment_restrictions

feat: adding deployment restriction doc

website/docs/using-qovery/configuration/application.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2023-12-19"
+last_modified_on: "2023-12-28"
 title: "Application"
 description: "Learn how to configure your Application on Qovery"
 ---
@@ -385,6 +385,10 @@ You can edit the existing ports or declare new ones by specifying:
 
 To know more about how to configure your Liveness and Readiness probes, have a look at [the health-checks section][docs.using-qovery.configuration.application-health-checks]
 
+### Deployment Restrictions
+
+This section allows to specify which changes on your repository should trigger an auto-deploy (if enabled). To know more about how to configure your Deployment Restrictions, have a look at the [deployment restrictions section][docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy].
+
 ### Domains
 
 Within this section you can customize the domain used to reach your application. 
@@ -558,6 +562,7 @@ In the application overview, click on the `3 dots` button and remove the applica
 [docs.using-qovery.configuration.organization.git-repository-access]: /docs/using-qovery/configuration/organization/git-repository-access/
 [docs.using-qovery.configuration.project]: /docs/using-qovery/configuration/project/
 [docs.using-qovery.configuration.service-health-checks]: /docs/using-qovery/configuration/service-health-checks/
+[docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy]: /docs/using-qovery/deployment/deploying-with-auto-deploy/#filtering-commits-triggering-the-auto-deploy
 [docs.using-qovery.deployment.image-mirroring#why-unique-image-tags-are-necessary]: /docs/using-qovery/deployment/image-mirroring/#why-unique-image-tags-are-necessary
 [docs.using-qovery.deployment.logs#live-logs]: /docs/using-qovery/deployment/logs/#live-logs
 [docs.using-qovery.deployment]: /docs/using-qovery/deployment/

website/docs/using-qovery/configuration/application.md.erb

@@ -373,6 +373,10 @@ You can edit the existing ports or declare new ones by specifying:
 
 To know more about how to configure your Liveness and Readiness probes, have a look at [the health-checks section][docs.using-qovery.configuration.application-health-checks]
 
+### Deployment Restrictions
+
+This section allows to specify which changes on your repository should trigger an auto-deploy (if enabled). To know more about how to configure your Deployment Restrictions, have a look at the [deployment restrictions section][docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy].
+
 ### Domains
 
 <%= configure_domains("application") %>

website/docs/using-qovery/configuration/cronjob.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2023-09-27"
+last_modified_on: "2023-12-28"
 title: "Cronjob"
 description: "Learn how to configure your Cronjob on Qovery"
 ---
@@ -281,6 +281,9 @@ Please note that in this section you configure the CPU allocated by the cluster
 
 To know more about how to configure your Liveness and Readiness probes, have a look at [the health-checks section][docs.using-qovery.configuration.application-health-checks]
 
+### Deployment Restrictions
+
+This section allows to specify which changes on your repository should trigger an auto-deploy (if enabled). To know more about how to configure your Deployment Restrictions, have a look at the [deployment restrictions section][docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy].
 
 ## Environment Variable
 
@@ -346,6 +349,7 @@ In the overview, click on the `3 dots` button and remove the job. Note: the same
 [docs.using-qovery.configuration.environment]: /docs/using-qovery/configuration/environment/
 [docs.using-qovery.configuration.organization.container-registry]: /docs/using-qovery/configuration/organization/container-registry/
 [docs.using-qovery.configuration.organization.git-repository-access]: /docs/using-qovery/configuration/organization/git-repository-access/
+[docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy]: /docs/using-qovery/deployment/deploying-with-auto-deploy/#filtering-commits-triggering-the-auto-deploy
 [docs.using-qovery.deployment.logs#live-logs]: /docs/using-qovery/deployment/logs/#live-logs
 [docs.using-qovery.deployment]: /docs/using-qovery/deployment/
 [guides.advanced.monorepository]: /guides/advanced/monorepository/

website/docs/using-qovery/configuration/cronjob.md.erb

@@ -269,6 +269,9 @@ Please note that in this section you configure the CPU allocated by the cluster
 
 To know more about how to configure your Liveness and Readiness probes, have a look at [the health-checks section][docs.using-qovery.configuration.application-health-checks]
 
+### Deployment Restrictions
+
+This section allows to specify which changes on your repository should trigger an auto-deploy (if enabled). To know more about how to configure your Deployment Restrictions, have a look at the [deployment restrictions section][docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy].
 
 ## Environment Variable
 

website/docs/using-qovery/configuration/lifecycle-job.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2023-09-27"
+last_modified_on: "2023-12-28"
 title: "Lifecycle Job"
 description: "Learn how to configure your Lifecycle job on Qovery"
 ---
@@ -307,6 +307,9 @@ Please note that in this section you configure the CPU allocated by the cluster
 
 To know more about how to configure your Liveness and Readiness probes, have a look at [the health-checks section][docs.using-qovery.configuration.application-health-checks]
 
+### Deployment Restrictions
+
+This section allows to specify which changes on your repository should trigger an auto-deploy (if enabled). To know more about how to configure your Deployment Restrictions, have a look at the [deployment restrictions section][docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy].
 
 ## Environment Variable
 
@@ -451,6 +454,7 @@ In the overview, click on the `3 dots` button and remove the job. Note: the same
 [docs.using-qovery.configuration.environment]: /docs/using-qovery/configuration/environment/
 [docs.using-qovery.configuration.organization.container-registry]: /docs/using-qovery/configuration/organization/container-registry/
 [docs.using-qovery.configuration.organization.git-repository-access]: /docs/using-qovery/configuration/organization/git-repository-access/
+[docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy]: /docs/using-qovery/deployment/deploying-with-auto-deploy/#filtering-commits-triggering-the-auto-deploy
 [docs.using-qovery.deployment.logs#live-logs]: /docs/using-qovery/deployment/logs/#live-logs
 [docs.using-qovery.deployment]: /docs/using-qovery/deployment/
 [guides.advanced.monorepository]: /guides/advanced/monorepository/

website/docs/using-qovery/configuration/lifecycle-job.md.erb

@@ -295,6 +295,9 @@ Please note that in this section you configure the CPU allocated by the cluster
 
 To know more about how to configure your Liveness and Readiness probes, have a look at [the health-checks section][docs.using-qovery.configuration.application-health-checks]
 
+### Deployment Restrictions
+
+This section allows to specify which changes on your repository should trigger an auto-deploy (if enabled). To know more about how to configure your Deployment Restrictions, have a look at the [deployment restrictions section][docs.using-qovery.deployment.deploying-with-auto-deploy#filtering-commits-triggering-the-auto-deploy].
 
 ## Environment Variable
 

website/docs/using-qovery/deployment/deploying-with-auto-deploy.md

@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2023-09-27"
+last_modified_on: "2023-12-28"
 title: "Deploying with the auto-deploy feature"
 description: "Learn how to deploy with the auto-deploy feature"
 ---
@@ -35,6 +35,24 @@ It can also be activated on the first step of the service creation flow
 
 Once this flag is activated, every new commit pushed on the branch of the application will trigger an automatic deployment of the new version.
 
+### Filtering commits triggering the auto-deploy
+
+By default every new commit pushed on the branch will trigger a deployment of the application. You can use the `Deployment restrictions` feature to include or exclude certain files or folders from the feature and avoid un-necessary deployments (like a change on the README file).
+
+To add a new restriction, go into the `Deployment restrictions` section of your application settings.
+
+<p align="center">
+  <img src="/img/deployment/deployment_restrictions.png" alt="Deployment restrictions" />
+</p>
+
+When adding a new restriction, two modes can be selected:
+
+- EXCLUDE: commits on the file or folder defined in the "Value" field will be ignored
+- MATCH: only commits on the file or folder defined in the "Value" field will trigger a deployment
+
+Note: 
+- "Value" should contain the full file path and can't start with `/`
+- Wildcards are not supported in the "Value" field (you can specify "my-prefix*" to exclude commits on files starting with "my-prefix")
 
 ## Auto-deploy and container images
 

website/docs/using-qovery/deployment/deploying-with-auto-deploy.md.erb

@@ -26,6 +26,24 @@ It can also be activated on the first step of the service creation flow
 
 Once this flag is activated, every new commit pushed on the branch of the application will trigger an automatic deployment of the new version.
 
+### Filtering commits triggering the auto-deploy
+
+By default every new commit pushed on the branch will trigger a deployment of the application. You can use the `Deployment restrictions` feature to include or exclude certain files or folders from the feature and avoid un-necessary deployments (like a change on the README file).
+
+To add a new restriction, go into the `Deployment restrictions` section of your application settings.
+
+<p align="center">
+  <img src="/img/deployment/deployment_restrictions.png" alt="Deployment restrictions" />
+</p>
+
+When adding a new restriction, two modes can be selected:
+
+- EXCLUDE: commits on the file or folder defined in the "Value" field will be ignored
+- MATCH: only commits on the file or folder defined in the "Value" field will trigger a deployment
+
+Note: 
+- "Value" should contain the full file path and can't start with `/`
+- Wildcards are not supported in the "Value" field (you can specify "my-prefix*" to exclude commits on files starting with "my-prefix")
 
 ## Auto-deploy and container images
 

website/guides/advanced/helm-chart.md

@@ -1,11 +1,14 @@
 ---
-last_modified_on: "2023-12-20"
+last_modified_on: "2023-12-28"
 $schema: "/.meta/.schemas/guides.json"
 title: Helm Charts
 description: Learn how to deploy Helm charts with Qovery
 author_github: https://github.com/evoxmusic
 tags: ["type: guide", "technology: helm"]
 ---
+
+import Jump from '@site/src/components/Jump';
+
 import Steps from '@site/src/components/Steps';
 import Assumptions from '@site/src/components/Assumptions';
 import Alert from '@site/src/components/Alert';
@@ -40,6 +43,26 @@ Helm Charts is an advanced way to deploy your applications on Qovery. If you are
 
 Do you need more examples? Do you have any questions? Feel free to ask on our [Community forum][urls.qovery_forum].
 
+<Jump to="/docs/using-qovery/configuration/advanced-settings/">Advanced settings</Jump>
+<Jump to="/docs/using-qovery/configuration/application-health-checks/">Application health checks</Jump>
+<Jump to="/docs/using-qovery/configuration/application/">Application</Jump>
+<Jump to="/docs/using-qovery/configuration/cloud-service-provider/">Cloud service provider</Jump>
+<Jump to="/docs/using-qovery/configuration/cluster-advanced-settings/">Cluster advanced settings</Jump>
+<Jump to="/docs/using-qovery/configuration/clusters/">Clusters</Jump>
+<Jump to="/docs/using-qovery/configuration/cronjob/">Cronjob</Jump>
+<Jump to="/docs/using-qovery/configuration/database/">Database</Jump>
+<Jump to="/docs/using-qovery/configuration/deployment-rule/">Deployment rule</Jump>
+<Jump to="/docs/using-qovery/configuration/environment-variable/">Environment variable</Jump>
+<Jump to="/docs/using-qovery/configuration/environment/">Environment</Jump>
+<Jump to="/docs/using-qovery/configuration/helm/">Helm</Jump>
+<Jump to="/docs/using-qovery/configuration/lifecycle-job/">Lifecycle job</Jump>
+<Jump to="/docs/using-qovery/configuration/object-storage/">Object storage</Jump>
+<Jump to="/docs/using-qovery/configuration/organization/">Organization</Jump>
+<Jump to="/docs/using-qovery/configuration/project/">Project</Jump>
+<Jump to="/docs/using-qovery/configuration/provider/">Provider</Jump>
+<Jump to="/docs/using-qovery/configuration/service-health-checks/">Service health checks</Jump>
+<Jump to="/docs/using-qovery/configuration/user-account/">User account</Jump>
+
 
 [guides.getting-started]: /guides/getting-started/
 [guides.tutorial.how-to-deploy-helm-charts]: /guides/tutorial/how-to-deploy-helm-charts/