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

correct documentation to reflect removal of --windows arg from plan init #6641

Merged
merged 1 commit into from Jun 13, 2019

Conversation

@mwrock
Copy link
Contributor

commented Jun 10, 2019

Signed-off-by: mwrock matt@mattwrock.com

@mwrock mwrock requested a review from raskchanky as a code owner Jun 10, 2019

@chef-expeditor

This comment has been minimized.

Copy link

commented Jun 10, 2019

Hello mwrock! Thanks for the pull request!

Here is what will happen next:

  1. Your PR will be reviewed by the maintainers.
  2. If everything looks good, one of them will approve it, and your PR will be merged.

Thank you for contributing!


p Using <code>hab plan init</code> will result in a new directory located at <code>/path/to/repo/habitat</code> on your workstation. A <code>plan.ps1</code> file will be created and the <code>$pkg_name</code> variable in it will be set to the name of the parent directory. Also, any environment variables that you have previouly set (such as <code>HAB_ORIGIN</code>) will be used to populate the respective <code>$pkg_*</code> variables. Because you specified the <code>--windows</code> argument, your plan is a <code>.ps1</code> file with Powershell syntax, if you had not used the <code>--windows</code> argument, a plan.sh bash file would have been generated.
p Using <code>hab plan init</code> will result in a new directory located at <code>/path/to/repo/habitat</code> on your workstation. A <code>plan.ps1</code> file will be created and the <code>$pkg_name</code> variable in it will be set to the name of the parent directory. Also, any environment variables that you have previouly set (such as <code>HAB_ORIGIN</code>) will be used to populate the respective <code>$pkg_*</code> variables.

This comment has been minimized.

Copy link
@scotthain

scotthain Jun 13, 2019

Contributor

Should this be C:\plan\to\repo\habitat ?

s/previouly/previously

This comment has been minimized.

Copy link
@mwrock

mwrock Jun 13, 2019

Author Contributor

it should probably be <path_to_repo>/habitat since C:\plan\to\repo\habitat feels too literal. Will change.

This comment has been minimized.

Copy link
@mwrock

mwrock Jun 13, 2019

Author Contributor

actually in this particular case, we can just say C:\contosouniversity\habitat since that is exactly what it will be if they are following the tutorial.

```

this generates a `plan.ps1` with proper Powershell variables, arrays, hashtables and functions.
will result in a new `habitat` directory located at `/path/to/<reponame>/habitat`. A plan file will be created and the `pkg_name` variable will be set to _\<reponame\>_. Also, any environment variables that you have previouly set (such as `HAB_ORIGIN`) will be used to populate the respective `pkg_*` variables.

This comment has been minimized.

Copy link
@scotthain

scotthain Jun 13, 2019

Contributor

Should this also say (or C:\path\to\<reponame>\habitat on windows) ?

This comment has been minimized.

Copy link
@mwrock

mwrock Jun 13, 2019

Author Contributor

same as above

This comment has been minimized.

Copy link
@mwrock

mwrock Jun 13, 2019

Author Contributor

actually this one should remain as is because above on line 60 in the code example we have $ cd /path/to/<reponame>. This partial can be applied to either platform so we stay away from c:\.

correct documentation to reflect removal of --windows arg from plan init
Signed-off-by: mwrock <matt@mattwrock.com>

@mwrock mwrock force-pushed the init_docs branch from 1c66fed to aaa9ce4 Jun 13, 2019

@davidMcneil
Copy link
Contributor

left a comment

Looks good.

I was searching the codebase for --windows and found this. Should that for loop be removed now?

@mwrock

This comment has been minimized.

Copy link
Contributor Author

commented Jun 13, 2019

It should @davidMcneil but that is for hab studio not hab plan init. I just created #6658 to track that.

@mwrock mwrock merged commit 1966aa9 into master Jun 13, 2019

5 checks passed

DCO This commit has a DCO Signed-off-by
Details
buildkite/habitat-sh-habitat-master-verify Build #2360 passed (53 minutes, 34 seconds)
Details
buildkite/habitat-sh-habitat-master-website Build #2730 passed (29 seconds)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
expeditor/config-validation Validated your Expeditor config file
Details

@mwrock mwrock deleted the init_docs branch Jun 13, 2019

chef-ci added a commit that referenced this pull request Jun 13, 2019

Update CHANGELOG.md with details from pull request #6641
Obvious fix; these changes are the result of automation not creative thinking.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.