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] Processing changed files does not include full git history #2749

Closed
BernieWhite opened this issue Feb 3, 2025 · 0 comments · Fixed by #2756
Closed

[DOCS] Processing changed files does not include full git history #2749

BernieWhite opened this issue Feb 3, 2025 · 0 comments · Fixed by #2756
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@BernieWhite
Copy link
Member

URL

https://microsoft.github.io/PSRule/v3/creating-your-pipeline/

How could the documentation be improved?

To compare changed files full git history must be fetched. Both GitHub Actions and Azure Pipelines to a shallow fetch be default.

The instructions and examples need to be updated to include this as a required step for processing changes files only to work.

GitHub Actions:

- uses: actions/checkout@v4
  with:
    fetch-depth: 0

Azure Pipelines

  # Checkout the repository
  - checkout: self
    fetchDepth: 0

Additional context

Discussed here: #1465 (comment)

@BernieWhite BernieWhite added the documentation Improvements or additions to documentation label Feb 3, 2025
@BernieWhite BernieWhite self-assigned this Feb 6, 2025
@BernieWhite BernieWhite added this to the v3.0.0 milestone Feb 6, 2025
@BernieWhite BernieWhite mentioned this issue Feb 6, 2025
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant