Skip to content

Commit

Permalink
Merge branch 'main' into prebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanstephens authored Aug 14, 2024
2 parents 5aeb649 + 8ab1507 commit 230a086
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,14 @@ jobs:
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
cname: docs.defang.io


- name: Notify Slack of Action Failures
uses: ravsamhq/[email protected]
if: ${{ always() && github.ref_name == 'main' }}
with:
status: ${{ job.status }}
notify_when: "failure"
notification_title: "{workflow} is failing"
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_NOTIFIER_WEBHOOK_URL }}
22 changes: 22 additions & 0 deletions docs/concepts/projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Projects
description: A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yml` file.
sidebar_position: 200
---

# Projects

A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yaml` file.

## Project Names

The _project name_ can be defined in the compose file with [the `name` property](https://docs.docker.com/compose/compose-file/04-version-and-name/#name-top-level-element), otherwise the base name of the project directory will be used.

The project name may then be used when performing project-wide operations such as listing services, tailing logs, or deprovisioning. For example:
```
defang services --project-name <project-name>
defang tail --project-name <project-name>
defang compose down --project-name <project-name>
```

By default `defang` will use the project name from the `compose.yaml` file in the working directory. The [`--project-name` CLI flag](/docs/cli/defang) may be used when running `defang` from outside the working directory.

0 comments on commit 230a086

Please sign in to comment.