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

Update (ci): github action's artifact upgrade v4 #20500

Merged

Conversation

alleeclark
Copy link
Contributor

@alleeclark alleeclark commented Dec 16, 2024

What does this PR do?

  • Updates GitHub actions's artifacts from v3 to v4
  • Enable overwrite option on upload since dist packages has a placeholder uploaded on init followed by build packages. This version of upload restricts that -- see below in breaking changes
  • Set merge-multiple to true to so downloaded artifacts will get written into the same directory
  • Add https://developer.habana.ai to the ignore list for link checker. The developer blog redirects to intel's developer website. It receives client errors on the redirect and it reports as broken in link checker.

Why

We received the email below stating that we need to upgrade by January.

image

Here is the recommended upgrade guide that I followed.

Does this introduce breaking change?

  • In v4, Artifacts are immutable (unless deleted). So you must change each of the uploaded Artifacts to have a different name and filter the downloads by name to achieve the same effect:

    • Since we are only uploading one artifact, it is fine. If we introduce a list, we will need to modify the name.
  • According to Github after Jan 9th if we have not upgraded there will be issues running pipelines.

Test Plan

Before submitting - Was this **discussed/agreed** via a GitHub issue? (not for typos and docs) - [ ] Did you read the [contributor guideline](https://github.com/Lightning-AI/lightning/blob/master/.github/CONTRIBUTING.md), **Pull Request** section? - [ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together? - Did you make sure to **update the documentation** with your changes? (if necessary) - Did you write any **new necessary tests**? (not for typos and docs) - [ ] Did you verify new and **existing tests pass** locally with your changes? - Did you list all the **breaking changes** introduced by this pull request? - Did you **update the CHANGELOG**? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--20500.org.readthedocs.build/en/20500/

cc @Borda

@github-actions github-actions bot added docs Documentation related ci Continuous Integration package labels Dec 16, 2024
@alleeclark alleeclark self-assigned this Dec 16, 2024
@alleeclark alleeclark force-pushed the fix_allee_github_artifacts_upload_and_download_eol_v4 branch from 751664d to b485017 Compare December 16, 2024 19:19
@alleeclark alleeclark marked this pull request as ready for review December 16, 2024 19:56
Copy link
Contributor

github-actions bot commented Dec 16, 2024

⚡ Required checks status: All passing 🟢

Groups summary

🟢 fabric: Docs
Check ID Status
docs-make (fabric, doctest) success
docs-make (fabric, html) success

These checks are required after the changes to .github/workflows/docs-build.yml.

🟢 pytorch_lightning: Docs
Check ID Status
docs-make (pytorch, doctest) success
docs-make (pytorch, html) success

These checks are required after the changes to docs/source-pytorch/conf.py, .github/workflows/docs-build.yml.

🟢 install
Check ID Status
install-pkg (ubuntu-22.04, fabric, 3.9) success
install-pkg (ubuntu-22.04, fabric, 3.11) success
install-pkg (ubuntu-22.04, pytorch, 3.9) success
install-pkg (ubuntu-22.04, pytorch, 3.11) success
install-pkg (ubuntu-22.04, lightning, 3.9) success
install-pkg (ubuntu-22.04, lightning, 3.11) success
install-pkg (ubuntu-22.04, notset, 3.9) success
install-pkg (ubuntu-22.04, notset, 3.11) success
install-pkg (macOS-14, fabric, 3.9) success
install-pkg (macOS-14, fabric, 3.11) success
install-pkg (macOS-14, pytorch, 3.9) success
install-pkg (macOS-14, pytorch, 3.11) success
install-pkg (macOS-14, lightning, 3.9) success
install-pkg (macOS-14, lightning, 3.11) success
install-pkg (macOS-14, notset, 3.9) success
install-pkg (macOS-14, notset, 3.11) success
install-pkg (windows-2022, fabric, 3.9) success
install-pkg (windows-2022, fabric, 3.11) success
install-pkg (windows-2022, pytorch, 3.9) success
install-pkg (windows-2022, pytorch, 3.11) success
install-pkg (windows-2022, lightning, 3.9) success
install-pkg (windows-2022, lightning, 3.11) success
install-pkg (windows-2022, notset, 3.9) success
install-pkg (windows-2022, notset, 3.11) success

These checks are required after the changes to .github/workflows/_build-packages.yml, .github/workflows/ci-pkg-install.yml.


Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Dec 16, 2024
@alleeclark alleeclark force-pushed the fix_allee_github_artifacts_upload_and_download_eol_v4 branch from 4b47796 to 7ab9753 Compare December 17, 2024 00:28
@alleeclark alleeclark force-pushed the fix_allee_github_artifacts_upload_and_download_eol_v4 branch from 7ab9753 to 2afe620 Compare December 17, 2024 00:46
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

The direction is good, it just needs some more work with adding patterns and making unique uploads...
pls, have look what I gave done earlier this week for shared utils project: Lightning-AI/utilities#344

@Borda Borda changed the title Update (ci): github action's artifact upgrade due to EOL for versions less than 4 Update (ci): github action's artifact upgrade v4 Dec 17, 2024
@alleeclark
Copy link
Contributor Author

The direction is good, it just needs some more work with adding patterns and making unique uploads... pls, have look what I gave done earlier this week for shared utils project: Lightning-AI/utilities#344

Thanks. I reviewed the changes.

@alleeclark alleeclark merged commit 4c0eb3a into master Dec 17, 2024
58 checks passed
@alleeclark alleeclark deleted the fix_allee_github_artifacts_upload_and_download_eol_v4 branch December 17, 2024 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration docs Documentation related package pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants