Merge pull request #187 from da-ar/gh-171/main/release-prep

0.3.0 Release Prep

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.3.0]
 
 - [(GH-144)](https://github.com/puppetlabs/pdkgo/issues/144) Implement `pct build` CLI command
 

README.md

@@ -19,6 +19,11 @@
     * [pct-config.yml](#pct-configyml)
   * [Templating Language](#templating-language)
 * [Overriding Template Defaults](#overriding-template-defaults)
+  * [User level configuration](#user-level-configuration)
+  * [Workspace configuration](#workspace-configuration)
+* [Sharing Templates](#sharing-templates)
+  * [pct build](#pct-build)
+  * [Installing template packages](#installing-template-packages)
 * [Request a feature](#request-a-feature)
 * [Reporting Problems](#reporting-problems)
 
@@ -368,6 +373,27 @@ If you specify an `--outputdir` that location is your workspace.
 
 The configuration specified in a workspace `pct.yml` will override any configuration found within the user level configuration at `$HOME/.pdk/pct.yml`
 
+## Sharing Templates
+
+After you've written your own template you may wish to share it with other members of your team or the wider Puppet community. Work is underway to improve this initial functionality.
+
+### pct build
+
+This command will attempt to package the current working directory. You can change the directory to pack by providing `--sourcedir`.
+
+``` bash
+pct build [--sourcedir <dir>][--targetdir <dir>]
+```
+
+The `build` command will ensure that the directory that you are attempting to package will produce a valid Puppet Content Template by looking for a `pct-config.yml` and a `content` directory.
+
+The resulting `tar.gz` package will be created by default in `$cwd/pkg`. You can change the directory the package is created in by providing `--targetdir`.
+
+### Installing template packages
+
+Packages created using the `build` command can be installed by extracting the `tar.gz` into  the **Default Template Location**.
+
+
 ## Requesting a feature
 
 Open a new feature request in our [Github discussion](https://github.com/puppetlabs/pdkgo/issues/new) page.

cmd/root/root.go

@@ -43,8 +43,8 @@ func InitLogger() {
 func CreateRootCommand() *cobra.Command {
 	tmp := &cobra.Command{
 		Use:   "pct",
-		Short: "pdk - Puppet Development Kit",
-		Long:  `Puppet development tooling, content creation, and testing framework`,
+		Short: "pct - Puppet Content Templater",
+		Long:  `Puppet Content Templater (PCT) - Create a range of Puppet content from templates`,
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 		},
 	}

cmd/version/version.go

@@ -36,7 +36,7 @@ func Format(version, buildDate string, commit string) string {
 		commit = strings.TrimSpace(commit[:len(commit)-length])
 	}
 
-	return fmt.Sprintf("pdk %s %s %s\npdk-ruby 2.2.0\n\n%s",
+	return fmt.Sprintf("pct %s %s %s\n\n%s",
 		version, commit, dateStr, changelogURL(version))
 }