chocolatey / chocolatey/choco

Running GenerateDocs.ps1 hangs indefinitely if choco.exe can't be found/used

Open
#3,033 0 comments 0 reactions 0 assignees View on GitHub
0 - Triaging Bug Build Automation
Dominant language
C#
Stars
11.5k
Forks
960
PR merge metrics
No merged PRs in 30d

Description

### Checklist

- [X] I have verified this is the correct repository for opening this issue.
- [X] I have verified no other issues exist related to my problem.
- [X] I have verified this is not an issue for a specific package.
- [X] I have verified this issue is not security related.

### What You Are Seeing?

Running `GenerateDocs.ps1` on my local machine after not having run `build.ps1` for a while or after having run `git clean` / removing the files from the code_drop folder that the build generates causes it to indefinitely hang while generating the command help documentation.

### What is Expected?

A clear error should be given and the script should early-exit, possibly cleaning up the half-generated docs files that it was able to make before the point it hangs at.

### How Did You Get This To Happen?

1. Remove the `code_drop` folder / run `git clean` to cleanup any build output files
2. Run `GenerateDocs.ps1`

### System Details

* Operating System: Win11
* Windows PowerShell version: 5.1 (GenerateDocs.ps1 #requires the Desktop edition, so it has to be 5.1)
* Chocolatey CLI Version: 1.3.0
* Terminal/Emulator: PowerShell

### Installed Packages

```bash
N/A
```

### Output Log

```bash
N/A
```

### Additional Context

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with GenerateDocs.ps1 and reproduce the hang after removing the code_drop folder or running git clean. Trace how the script checks for or uses choco.exe while generating command help documentation. Done means the script reports a clear error, exits instead of hanging, and addresses the partially generated documentation files as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.