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: update examples to v4 #1311

Merged
merged 3 commits into from
Aug 14, 2024
Merged

Conversation

todgru
Copy link
Contributor

@todgru todgru commented Jan 26, 2024

Description

These changes update all markdown documentation to use the v4 versions of:

  • actions/cache@v4
  • actions/cache/save@v4
  • actions/cache/restore@v4
  • actions/checkout@v4

These changes do not update the .github/workflows. Those are addressed in: #1231

Motivation and Context

Up-to-date documentation improves developer happiness.

How Has This Been Tested?

Visual inspection of changes.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (add or update README or docs)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@todgru todgru requested a review from a team as a code owner January 26, 2024 22:15
Copy link

@LucasFA LucasFA left a comment

Choose a reason for hiding this comment

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

Other than the comment, I was actually surprised that it all was still version 3

@@ -55,10 +55,10 @@ Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/packa
```

Depending on the environment, huge packages might be pre-installed in the global cache folder.
With `actions/cache@v3` you can now exclude unwanted packages with [exclude pattern](https://github.com/actions/toolkit/tree/main/packages/glob#exclude-patterns)
With `actions/cache@v4` you can now exclude unwanted packages with [exclude pattern](https://github.com/actions/toolkit/tree/main/packages/glob#exclude-patterns)
Copy link

Choose a reason for hiding this comment

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

I would argue this could be documenting functionality from the prior version. I would just say "From action/cache@v3 onwards [...]"

@nebuk89
Copy link

nebuk89 commented Aug 14, 2024

Thank you for this! Let me get this read through today/tomorrow :)

Copy link

@nebuk89 nebuk89 left a comment

Choose a reason for hiding this comment

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

Thank you for updating all our old tags :) LGTM

@Link- Link- merged commit 81382a7 into actions:main Aug 14, 2024
14 checks passed
@Link-
Copy link
Member

Link- commented Aug 14, 2024

Thank you everyone 🙏

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.

5 participants