<commit_before>+++
title = "Plan Settings"
description = "Define basic metadata about your artifact with plan settings"
gh_repo = "habitat"

[menu]
  [menu.habitat]
    title = "Plan Settings"
    identifier = "habitat/reference/plan-settings"
    parent = "habitat/reference"
+++

Habitat reserves some names for internal use. You can set all of these values in your plan and use them as variables in your Habitat code.

For example:

```bash plan.sh
# Set the packag name
pkg_name=two-tier-app
# Call the package by name
${pkg_name}
```

```powershell plan.ps1
# Set the packag name
pkg_name=two-tier-app
# Call the package by name
${"pkg_name"}
```

## General Settings

FORMAT:
setting
: Short definition. How to use. How habitat uses. If required other settings. Type: String, array, boolean,etc. Default: if any. Optional/Required

pkg_name
: Sets the name of the package. Can contain upper and lowercase letters, numbers, dashes, and underscores. By default, Chef Habitat uses `pkg_name`, `pkg_origin`, and `pkg_version` to create the fully-qualified package name. Type: string. _Required_.

{{< foundation_tabs tabs-id="bash-powershell-panel" >}}
  {{< foundation_tab active="true" panel-link="bash-panel" tab-text="Bash">}}
  {{< foundation_tab panel-link="powershell-panel" tab-text="Powershell" >}}
{{< /foundation_tabs >}}

{{< foundation_tabs_panels tabs-id="bash-powershell-panel" >}}
  {{< foundation_tabs_panel active="true" panel-id="bash-panel" >}}
  ```bash
  pkg_name=zlib
  ```
  {{< /foundation_tabs_panel >}}

  {{< foundation_tabs_panel panel-id="powershell-panel" >}}
  ```powershell
  $pkg_name="zlib"
  ```
  {{< /foundation_tabs_panel >}}
{{< /foundation_tabs_panels >}}

pkg_origin
: The name of the origin for this package. Can contain upper and lowercase letters, numbers, dashes, and underscores. The `HAB_ORIGIN` environment variable overrides the `pkg_origin` Type: string. _Required_.

{{< foundation_tabs tabs-id="bash-powershell-panel1" >}}
  {{< foundation_tab active="true" panel-link="bash-panel1" tab-text="Bash">}}
  {{< foundation_tab panel-link="powershell-panel1" tab-text="Powershell" >}}
{{< /foundation_tabs >}}

{{< foundation_tabs_panels tabs-id="bash-powershell-panel1" >}}
  {{< foundation_tabs_panel active="true" panel-id="bash-panel1" >}}
  ```bash
  pkg_origin=Habitat
  ```
  {{< /foundation_tabs_panel >}}

  {{< foundation_tabs_panel panel-id="powershell-panel1" >}}
  ```powershell
  $pkg_origin="Habitat"
  ```
  {{< /foundation_tabs_panel >}}
{{< /foundation_tabs_panels >}}

pkg_version
: Sets the version of the package By default, Chef Habitat uses `pkg_name`, `pkg_origin`, and `pkg_version` to create the fully-qualified package name. You can set the value through the `pkg_version()` function. Type: string. _Required_.

{{< foundation_tabs tabs-id="bash-powershell-panel2" >}}
  {{< foundation_tab active="true" panel-link="bash-panel2" tab-text="Bash">}}
  {{< foundation_tab panel-link="powershell-panel2" tab-text="Powershell" >}}
{{< /foundation_tabs >}}

{{< foundation_tabs_panels tabs-id="bash-powershell-panel2" >}}
  {{< foundation_tabs_panel active="true" panel-id="bash-panel2" >}}
  ```bash
  pkg_version=1.2.8
  ```
  {{< /foundation_tabs_panel >}}

  {{< foundation_tabs_panel panel-id="powershell-panel2" >}}
  ```powershell
  $pkg_version="1.2.8"
  ```
  {{< /foundation_tabs_panel >}}
{{< /foundation_tabs_panels >}}

pkg_maintainer
: The name and email address of the package maintainer. Type: string._Optional_.
<commit_msg>Update plan_settings.md<commit_after>+++
title = "Plan Settings"
description = "Define basic metadata about your artifact with plan settings"
gh_repo = "habitat"

[menu]
  [menu.habitat]
    title = "Plan Settings"
    identifier = "habitat/reference/plan-settings"
    parent = "habitat/reference"
+++

Habitat reserves some names for internal use. You can set all of these values in your plan and use them as variables in your Habitat code.

For example:

```bash plan.sh
# Set the packag name
pkg_name=two-tier-app
# Call the package by name
${pkg_name}
```

```powershell plan.ps1
# Set the packag name
pkg_name=two-tier-app
# Call the package by name
${"pkg_name"}
```

## General Settings

FORMAT:
setting
: Short definition. How to use. How habitat uses. If required other settings. Type: String, array, boolean,etc. Default: if any. Optional/Required

pkg_name
: Sets the name of the package. Can contain upper and lowercase letters, numbers, dashes, and underscores. By default, Chef Habitat uses `pkg_name`, `pkg_origin`, and `pkg_version` to create the fully-qualified package name. Type: string. _Required_.

{{< foundation_tabs tabs-id="bash-powershell-panel" >}}
  {{< foundation_tab active="true" panel-link="bash-panel" tab-text="Bash">}}
  {{< foundation_tab panel-link="powershell-panel" tab-text="Powershell" >}}
{{< /foundation_tabs >}}

{{< foundation_tabs_panels tabs-id="bash-powershell-panel" >}}
  {{< foundation_tabs_panel active="true" panel-id="bash-panel" >}}
  ```bash
  pkg_name=zlib
  ```
  {{< /foundation_tabs_panel >}}

  {{< foundation_tabs_panel panel-id="powershell-panel" >}}
  ```powershell
  $pkg_name="zlib"
  ```
  {{< /foundation_tabs_panel >}}
{{< /foundation_tabs_panels >}}

pkg_origin
: The name of the origin for this package. Can contain upper and lowercase letters, numbers, dashes, and underscores. The `HAB_ORIGIN` environment variable overrides the `pkg_origin` Type: string. _Required_.

{{< foundation_tabs tabs-id="bash-powershell-panel1" >}}
  {{< foundation_tab active="true" panel-link="bash-panel1" tab-text="Bash">}}
  {{< foundation_tab panel-link="powershell-panel1" tab-text="Powershell" >}}
{{< /foundation_tabs >}}

{{< foundation_tabs_panels tabs-id="bash-powershell-panel1" >}}
  {{< foundation_tabs_panel active="true" panel-id="bash-panel1" >}}
  ```bash
  pkg_origin=Habitat
  ```
  {{< /foundation_tabs_panel >}}

  {{< foundation_tabs_panel panel-id="powershell-panel1" >}}
  ```powershell
  $pkg_origin="Habitat"
  ```
  {{< /foundation_tabs_panel >}}
{{< /foundation_tabs_panels >}}

pkg_version
: Sets the version of the package By default, Chef Habitat uses `pkg_name`, `pkg_origin`, and `pkg_version` to create the fully-qualified package name. You can set the value through the `pkg_version()` function. Type: string. _Required_.

{{< foundation_tabs tabs-id="bash-powershell-panel2" >}}
  {{< foundation_tab active="true" panel-link="bash-panel2" tab-text="Bash">}}
  {{< foundation_tab panel-link="powershell-panel2" tab-text="Powershell" >}}
{{< /foundation_tabs >}}

{{< foundation_tabs_panels tabs-id="bash-powershell-panel2" >}}
  {{< foundation_tabs_panel active="true" panel-id="bash-panel2" >}}
  ```bash
  pkg_version=1.2.8
  ```
  {{< /foundation_tabs_panel >}}

  {{< foundation_tabs_panel panel-id="powershell-panel2" >}}
  ```powershell
  $pkg_version="1.2.8"
  ```
  {{< /foundation_tabs_panel >}}
{{< /foundation_tabs_panels >}}

{{< note >}}
Habitat uses the guidelines of the semantic versioning specification to determine version order. Keep in mind that including a hyphen in your version indicates that the package is a pre-release that will be given lower precedence to other versions.
{{< /note >}}

pkg_maintainer
: The name and email address of the package maintainer. Type: string._Optional_.

{'fraction_non_alphanumeric': 0.14731226918342225, 'fraction_numerical': 0.005197647380659281, 'mean_word_length': 5.078137988362427, 'pattern_counts': {'":': 0, '<': 65, '<?xml version=': 0, '>': 65, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3868383', 'n_tokens_mistral': 2513, 'n_tokens_neox': 2383, 'n_words': 612}