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

add .worktrees/ to .gitignore #4885

Conversation

rursprung
Copy link
Contributor

the .worktrees/ folder is used in the guide for manual backporting as the location where to create the worktree for the backport branch.

as this is inside of the repository the folder will be reported as an untracked file. to avoid this, i've now added it to .gitignore.

though it might be better to create the worktree outside of the repository, the documentation on it doesn't comment explicitly on using it inside of the main worktree, however none of the examples do that.

Signed-off-by: Ralph Ursprung [email protected]

Description

see commit message. feel free to use this PR to instead discuss whether the worktrees shouldn't be managed outside of the repo instead (= changing the message for manual backports and maybe also the scripts for the automated backports if they also use this path).

Issues Resolved

n/a

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

the `.worktrees/` folder is used in the guide for manual backporting as
the location where to create the worktree for the backport branch.

as this is inside of the repository the folder will be reported as an
untracked file. to avoid this, i've now added it to `.gitignore`.

though it might be better to create the worktree outside of the
repository, the documentation on it doesn't comment explicitly on using
it inside of the main worktree, however none of the examples do that.

Signed-off-by: Ralph Ursprung <[email protected]>
@rursprung rursprung requested review from a team and reta as code owners October 24, 2022 12:58
@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@rursprung
Copy link
Contributor Author

Gradle Check (Jenkins) Run Completed with:

* **RESULT:** UNSTABLE ❌

* **URL:** https://build.ci.opensearch.org/job/gradle-check/5347/

* **CommitID:** [a800f6b](https://github.com/opensearch-project/OpenSearch/commit/a800f6b725075c9c808a5f9672348b1d0d9e08cd)

and another false reject... 😞

@andrross
Copy link
Member

Maybe we should just change the instructions here? Seems like using worktrees outside the repository is the more normal practice.

@andrross
Copy link
Member

PR to change the backport instructions here: VachaShah/backport#5

@rursprung
Copy link
Contributor Author

superseded by the changes done to the backport suggestions => no longer needed

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