Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

examples: replace the all docker-compose.yml with compose.yaml #71006

Merged
merged 2 commits into from
Oct 29, 2024

Conversation

Marukome0743
Copy link
Contributor

Summary

Rename docker compose file to compose.yaml.
Update docker compose command.

Description

According to official manuals,

The default path for a Compose file is compose.yaml (preferred) or compose.yml that is placed in the working directory. Compose also supports docker-compose.yaml and docker-compose.yml for backwards compatibility of earlier versions. If both files exist, Compose prefers the canonical compose.yaml.

Adding or Updating Examples

x-ref: The Compose file
x-ref: docker-compose vs docker compose

@ijjk ijjk added the examples Issue was opened via the examples template. label Oct 9, 2024
@ijjk
Copy link
Member

ijjk commented Oct 9, 2024

Allow CI Workflow Run

  • approve CI run for commit: 11f0fc2

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@Marukome0743 Marukome0743 force-pushed the compose.yaml branch 6 times, most recently from 59585ea to 3c2e9d8 Compare October 28, 2024 01:32
@ijjk ijjk merged commit 8f0d583 into vercel:canary Oct 29, 2024
38 checks passed
@Marukome0743 Marukome0743 deleted the compose.yaml branch October 30, 2024 00:22
kdy1 pushed a commit that referenced this pull request Oct 30, 2024
…71006)

# Summary
Rename docker compose file to `compose.yaml`.
Update docker compose command.

## Description
According to [official
manuals](https://docs.docker.com/compose/intro/compose-application-model/#the-compose-file),

> The default path for a Compose file is `compose.yaml` (preferred) or
`compose.yml` that is placed in the working directory. Compose also
supports `docker-compose.yaml` and `docker-compose.yml` for backwards
compatibility of earlier versions. If both files exist, Compose prefers
the canonical `compose.yaml`.

### Adding or Updating Examples

- [x] The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- [x] Make sure the linting passes by running `pnpm build && pnpm lint`.
See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

x-ref: [The Compose
file](https://docs.docker.com/compose/intro/compose-application-model/#the-compose-file)
x-ref: [docker-compose vs docker
compose](https://docs.docker.com/compose/releases/migrate/#docker-compose-vs-docker-compose)

Co-authored-by: JJ Kasper <jj@jjsweb.site>
stipsan pushed a commit to sanity-io/next.js that referenced this pull request Nov 6, 2024
…ercel#71006)

# Summary
Rename docker compose file to `compose.yaml`.
Update docker compose command.

## Description
According to [official
manuals](https://docs.docker.com/compose/intro/compose-application-model/#the-compose-file),

> The default path for a Compose file is `compose.yaml` (preferred) or
`compose.yml` that is placed in the working directory. Compose also
supports `docker-compose.yaml` and `docker-compose.yml` for backwards
compatibility of earlier versions. If both files exist, Compose prefers
the canonical `compose.yaml`.

### Adding or Updating Examples

- [x] The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- [x] Make sure the linting passes by running `pnpm build && pnpm lint`.
See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

x-ref: [The Compose
file](https://docs.docker.com/compose/intro/compose-application-model/#the-compose-file)
x-ref: [docker-compose vs docker
compose](https://docs.docker.com/compose/releases/migrate/#docker-compose-vs-docker-compose)

Co-authored-by: JJ Kasper <jj@jjsweb.site>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 13, 2024
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
examples Issue was opened via the examples template. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants