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

refactor(workflows): replace secrets.TEAMS_GITHUB_PAT with fine grained org secret RO_FOT_FG_PAT. #5173

Merged
merged 1 commit into from
Nov 21, 2024

Conversation

kevin-dimichel
Copy link
Contributor

@kevin-dimichel kevin-dimichel commented Nov 21, 2024

What changes are proposed in this pull request?

Aloha is improving our use of Personal Access Tokens by moving them towards GitHub Organization secrets. These will be easier to manage (and update) when they expire).

The only reference of TEAMS_GITHUB_PAT is in .github/workflows/build-docs.yml. This workflow appears to only need read access to voxel51/fiftyone-teams, so use a fine grained PAT with only that permission.

How is this patch tested? If it is not, please explain why.

Will be tested in the action run https://github.com/voxel51/fiftyone/actions/runs/11960057931/job/33343225189

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • Chores
    • Updated workflow configuration for building documentation to support additional branch patterns.
    • Refined environment setup for build and publish jobs, enhancing workflow flexibility.

Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

Walkthrough

The pull request modifies the GitHub Actions workflow configuration in the .github/workflows/build-docs.yml file. It updates the event triggers to include specific branch patterns and paths, changes the token used for repository checkout, and corrects the environment specifications for the build and publish jobs. The publish job's execution conditions are also refined to ensure it only runs for certain tags.

Changes

File Change Summary
.github/workflows/build-docs.yml - Updated on section to include branch patterns docs-* and github-actions-* for triggers.
- Added requirements/** to paths in pull_request section.
- Changed checkout token from ${{ secrets.TEAMS_GITHUB_PAT }} to ${{ secrets.RO_FOT_FG_PAT }}.
- Corrected runs-on attribute from ubuntu-latest-m to ubuntu-latest for the build job.
- Modified publish job to run only for specific tag patterns and set runs-on to ubuntu-20.04.

Possibly related PRs

  • Teams integration #4386: The changes in this PR involve modifications to workflow files, specifically adding a new job in .github/workflows/pr.yml, which is related to the overall workflow configuration changes in the main PR.
  • chore(ci): AS-326 Conditional GitHub Actions #5104: This PR also modifies the .github/workflows/pr.yml file, introducing a new job and altering job dependencies, which connects it to the workflow changes made in the main PR.

Suggested labels

ci

Suggested reviewers

  • findtopher

Poem

In the garden of code, we hop and play,
With branches and triggers, we pave the way.
Docs build with care, on Ubuntu they thrive,
Publishing tags, keeping our workflows alive! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@kevin-dimichel kevin-dimichel requested review from benjaminpkane, swheaton and a team November 21, 2024 19:13
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
.github/workflows/build-docs.yml (2)

Line range hint 40-40: Fix invalid GitHub runner specification

The ubuntu-latest-m is not a valid GitHub-hosted runner. This should be changed to a valid option.

Apply this diff to fix the runner:

-    runs-on: ubuntu-latest-m
+    runs-on: ubuntu-latest

Line range hint 108-108: Consider updating to a newer Ubuntu version

The job is using ubuntu-20.04 which, while still supported, has an end-of-life approaching. Consider updating to ubuntu-latest or a newer LTS version for longer-term maintainability.

Apply this diff to update the runner:

-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7785ecd and 43d4e47.

📒 Files selected for processing (1)
  • .github/workflows/build-docs.yml (1 hunks)

.github/workflows/build-docs.yml Show resolved Hide resolved
Copy link
Contributor

@swheaton swheaton left a comment

Choose a reason for hiding this comment

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

good to know, thanks. yep its read only - it links in some of the Teams-specific folders so that autodoc of API includes those modules (e.g., fiftyone.management)

@kevin-dimichel kevin-dimichel merged commit f3604d5 into develop Nov 21, 2024
10 checks passed
@kevin-dimichel kevin-dimichel deleted the kevin/as-218-gh-org-secrets branch November 21, 2024 21:11
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.

4 participants