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

XS✔ ◾ Fetch Depth Docs #543

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

muiriswoulfe
Copy link
Member

Summary

This change updates the documentation to include instructions on fetching Git history during the checkout process in Azure Pipelines. It also reorganizes some sections for clarity.

This addresses #542.

Documentation Updates:

  • README.md: Added a new section titled "Git History" with instructions on how to fetch Git history during the checkout step using actions/checkout with fetch-depth: 0.
  • docs/azure-pipelines-task.md: Added a similar "Git History" section with instructions for both YAML pipelines and classic pipelines, including details on disabling 'Shallow fetch'.

Reorganization:

  • docs/azure-pipelines-task.md: Moved the "Always Close Comment" section to follow the new "Git History" section and made minor text adjustments for clarity.

@muiriswoulfe muiriswoulfe added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 18, 2024
@muiriswoulfe muiriswoulfe self-assigned this Sep 18, 2024
@muiriswoulfe muiriswoulfe requested a review from a team as a code owner September 18, 2024 16:27
Copy link
Contributor

PR Metrics

Thanks for keeping your pull request small.
Thanks for adding tests.

Lines
Product Code -
Test Code -
Subtotal -
Ignored Code 40
Total 40

Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs!

@github-actions github-actions bot changed the title Initial commit XS✔ ◾ Initial commit Sep 18, 2024
@muiriswoulfe muiriswoulfe changed the title XS✔ ◾ Initial commit XS✔ ◾ Fetch Depth Docs Sep 18, 2024
@muiriswoulfe muiriswoulfe linked an issue Sep 18, 2024 that may be closed by this pull request
@muiriswoulfe muiriswoulfe enabled auto-merge (squash) September 18, 2024 18:15
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Checkout action requirement is missing from the docs
1 participant