hugo/commands/deploy.go

// Copyright 2019 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package commands

import (
	"context"

	"github.com/gohugoio/hugo/deploy"
	"github.com/spf13/cobra"
)

var _ cmder = (*deployCmd)(nil)

// deployCmd supports deploying sites to Cloud providers.
type deployCmd struct {
	hugoBuilderCommon
	*baseCmd
}

// TODO: In addition to the "deploy" command, consider adding a "--deploy"
// flag for the default command; this would build the site and then deploy it.
// It's not obvious how to do this; would all of the deploy-specific flags
// have to exist at the top level as well?

// TODO:  The output files change every time "hugo" is executed, it looks
// like because of map order randomization. This means that you can
// run "hugo && hugo deploy" again and again and upload new stuff every time. Is
// this intended?

func newDeployCmd() *deployCmd {
	cc := &deployCmd{}

	cc.baseCmd = newBaseCmd(&cobra.Command{
		Use:   "deploy",
		Short: "Deploy your site to a Cloud provider.",
		// TODO: improve Long docstring.
		// TODO: update real documentation. Is it in ../docs/ or in hugoDocs?
		Long: `Deploy your site to a Cloud provider.`,

		RunE: func(cmd *cobra.Command, args []string) error {
			cfgInit := func(c *commandeer) error {
				return nil
			}
			comm, err := initializeConfig(true, false, &cc.hugoBuilderCommon, cc, cfgInit)
			if err != nil {
				return err
			}
			deployer, err := deploy.New(comm.Cfg, comm.hugo.PathSpec.PublishFs)
			if err != nil {
				return err
			}
			return deployer.Deploy(context.Background())
		},
	})

	cc.cmd.Flags().String("target", "default", "target deployment from deployments section in config file")
	cc.cmd.Flags().Bool("confirm", false, "ask for confirmation before making changes to the target")
	cc.cmd.Flags().Bool("dryRun", false, "dry run")
	cc.cmd.Flags().Bool("force", false, "force upload of all files")
	cc.cmd.Flags().Bool("invalidateCDN", true, "invalidate the CDN cache via the cloudFrontDistributionID listed in the deployment target")
	cc.cmd.Flags().Int("maxDeletes", 256, "maximum # of files to delete, or -1 to disable")

	return cc
}