Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Docs: Deployer 7 Updates #2677

Closed
wants to merge 12 commits into from
Closed

Docs: Deployer 7 Updates #2677

wants to merge 12 commits into from

Conversation

jasperf
Copy link

@jasperf jasperf commented Oct 5, 2021

Deployer 7 Docs

Pull requests has become a more general update to documentation to explain how to work with the latest Deployer 7. So the older remarks:

Added some documentation for new Deployer 7 version. Documentation on yaml file usage, configuration and others will be added here in the days ahead if they are useful to Deployer.

Did do $ php bin/docgen and writable.md got adjusted. Not sure if changing chgrp to acl was needed, but leaving it for now

have been surpassed, This pull request will likely contain more updates than just a few to configuration and yaml.md

@jasperf jasperf changed the title Docs Configuration & Yaml Docs: Configuration & Yaml Oct 5, 2021
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
@@ -1 +1,47 @@
# Config
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is about configuration in general. Using get/set. Global config and hosts.


## Application

the name of your application is the first item to start with. The domain name of the application is a standard choice:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should go to recipe documentation in docs/recopes/common.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could move it over. Is there need to keep Deployer 6 and 7 settings for common.php?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, only v7

docs/config.md Outdated

## PHP FPM Version

To set the appropriate PHP FPM version you add a line starting with `php_fpm_version` followed by the version needed. Example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think it’s from common recipe.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it is from https://github.com/deployphp/deployer/blob/master/contrib/php-fpm.php . I could remove it as it is already at docs/contrib/php-fpm.md

@@ -43,7 +43,7 @@ One of:
- acl

```php title="Default value"
'chgrp'
'acl'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct.

docs/yaml.md Outdated

To be added

## Laravel PHP Example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let’s try to describe yaml config not binding to specific framework.

jasperf and others added 6 commits October 7, 2021 07:37
Co-authored-by: Daniel Kudwien <daniel@netzstrategen.com>
Co-authored-by: Daniel Kudwien <daniel@netzstrategen.com>
Co-authored-by: Daniel Kudwien <daniel@netzstrategen.com>
Co-authored-by: Daniel Kudwien <daniel@netzstrategen.com>
@jasperf jasperf changed the title Docs: Configuration & Yaml Docs: Deployer 7 Updates Oct 7, 2021
@antonmedv
Copy link
Member

What’s the status of this PR?

@jasperf
Copy link
Author

jasperf commented Oct 23, 2021

What’s the status of this PR?

I asked for a config stub/ start from you. Also asked whether moving the Laravel example to a separate file is okay or not. So not quite done..

- npm:run:prod
- deploy:publish
- php-fpm:reload
npm:run:prod:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can add something like this somewhere :

hosts:
  prod:
    remote_user: forge
    hostname: 'domain.com'
    deploy_path: '~/{{hostname}}'
    labels:
        npm_build_script: prod
  staging:
    remote_user: forge
    hostname: 'staging.domain.com'
    deploy_path: '~/{{hostname}}'
    labels:
        npm_build_script: dev
...

npm:run:dev:
    select: 'npm_build_script=dev'
    script:
        - 'cd {{release_or_current_path}} && npm run dev'

npm:run:prod:
    select: 'npm_build_script=prod'
    script:
       - 'cd {{release_or_current_path}} && npm run prod'
hosts:
  prod:
    remote_user: forge
    hostname: 'domain.com'
    deploy_path: '~/{{hostname}}'
  staging:
    remote_user: forge
    hostname: 'staging.domain.com'
    deploy_path: '~/{{hostname}}'
...

npm:run:dev:
    select: '__host__=prod'
    script:
        - 'cd {{release_or_current_path}} && npm run dev'

npm:run:prod:
    select: '__host__=staging'
    script:
       - 'cd {{release_or_current_path}} && npm run prod'

@antonmedv
Copy link
Member

The branch is really outdated, sorry it took me too long to review the changes. Now I cant merge it, please recreate pr.

@antonmedv antonmedv closed this Mar 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants