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: make the install paths easier to use #303

Merged
merged 1 commit into from
Oct 16, 2024
Merged

docs: make the install paths easier to use #303

merged 1 commit into from
Oct 16, 2024

Conversation

cardoe
Copy link
Contributor

@cardoe cardoe commented Sep 16, 2024

Attempt to make the install paths easier to use by sticking to the deploy repo checkout.

@cardoe cardoe requested a review from a team September 16, 2024 16:46
@cardoe
Copy link
Contributor Author

cardoe commented Sep 16, 2024

@skrobul any suggestions other than prefixing with that cd command each time?

@cardoe cardoe force-pushed the deploy-doc branch 4 times, most recently from ecc2d91 to ea461aa Compare September 18, 2024 20:43
Copy link
Collaborator

@skrobul skrobul left a comment

Choose a reason for hiding this comment

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

@skrobul any suggestions other than prefixing with that cd command each time?

I think the previous version with pushd/popd was actually fine, it did not work during our deploy because Saving the Environment Config section used cd and did not have instruction to go back to the main understack repository.

When it other suggestions, the only other one which might be viable is something like this:

instead of saying:

./scripts/gitops-secrets-gen.sh ${UC_DEPLOY}/my-k3s.env
pushd "${UC_DEPLOY}"
git add secrets/my-k3s
git commit -m "my-k3s: secrets generation"
popd

say:

./scripts/gitops-secrets-gen.sh ${UC_DEPLOY}/my-k3s.env
(
  cd "${UC_DEPLOY}"
  git add secrets/my-k3s
  git commit -m "my-k3s: secrets generation"
)

In other words, cd inside the () subshell is scoped only to that subshell.

@cardoe
Copy link
Contributor Author

cardoe commented Oct 15, 2024

How about that change @skrobul ?

@cardoe cardoe requested a review from skrobul October 15, 2024 21:54
docs/deploy-guide/gitops-install.md Outdated Show resolved Hide resolved
docs/deploy-guide/gitops-install.md Outdated Show resolved Hide resolved
Attempt to make the install paths easier to use by sticking to the
deploy repo checkout.
@cardoe cardoe added this pull request to the merge queue Oct 16, 2024
Merged via the queue into main with commit d38fd90 Oct 16, 2024
15 checks passed
@cardoe cardoe deleted the deploy-doc branch October 16, 2024 15:11
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.

2 participants