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

mediawiki: prevent mwdeploy from upgrading extensions configured to checkout a specific commit #3876

Closed
wants to merge 10 commits into from

Conversation

redbluegreenhat
Copy link
Member

https://github.com/miraheze/mediawiki-repos supports configuring an extension to checkout a specific commit. However, if the extension is upgraded by mwdeploy, such as during --upgrade-world, then it will just pull the latest commit from the configured branch, which is not desired behavior. Puppet will restore the extension to the commit configured in mediawiki-repos, but by then the rsync has already happened.

This pull request aims to fix that by creating a file with the name of the extension on /var/local/mwdeploy, which if mwdeploy sees while upgrading an extension, will tell the script to not attempt to upgrade. This file is created automatically by Puppet, and removed automatically when the commit parameter for that extension is removed from mediawiki-repos

Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

For the purposes of mwdeploy, we don't actually care about the contents of the file, but it doesn't hurt to explain what the file is about
@redbluegreenhat redbluegreenhat marked this pull request as ready for review July 5, 2024 17:47
@Universal-Omega
Copy link
Sponsor Member

I think using git to check if a commit is checked out would be better than a file? Also we should also add tests here.

Check commit and GitHub actions for more details
@redbluegreenhat
Copy link
Member Author

I think using git to check if a commit is checked out would be better than a file? Also we should also add tests here.

Puppet won't touch the extension if the commit parameter is removed in mediawiki-repos as long as the extension exists. So I think there's no way to differentiate then between an extension configured to checkout a specific commit to one that used to be, but is no longer configured to do so without doing this. I'm probably wrong tho

I'll work on the tests

@Universal-Omega
Copy link
Sponsor Member

I think using git to check if a commit is checked out would be better than a file? Also we should also add tests here.

Puppet won't touch the extension if the commit parameter is removed in mediawiki-repos as long as the extension exists. So I think there's no way to differentiate then between an extension configured to checkout a specific commit to one that used to be, but is no longer configured to do so without doing this. I'm probably wrong tho

I'll work on the tests

I don't know what you mean? If you use git to check it doesn't rely on puppet it uses the current value and check for something like a "Detached HEAD" state.

@Universal-Omega
Copy link
Sponsor Member

Universal-Omega commented Jul 5, 2024

IE use something like the command git symbolic-ref -q HEAD and return True or False based on exit code in a new function, is_detached_head, use that function to filter out extensions & skins from get_valid_extensions and get_valid_skins

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants