Skip to content

Conversation

@cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Dec 8, 2025

rename default branch from 17 to main

Summary by Sourcery

Update repository references and CI configuration to reflect the rename to java-api-17 and the new main default branch.

Enhancements:

  • Update README files and package metadata to point to the renamed java-api-17 repository and main branch.
  • Add explicit mypy[python2] dependency to the java-api-stubs installation instructions.

CI:

  • Adjust GitHub Actions workflows to trigger on the main branch instead of the 17 branch.
  • Remove the dedicated pre-commit autoupdate branch configuration.

rename default branch from 17 to main
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 8, 2025

Reviewer's Guide

Updates repository metadata and documentation to reflect the rename from java-api to java-api-17 and the default branch change from 17 to main, including CI, pre-commit, and installation instructions.

File-Level Changes

Change Details Files
Update installation and documentation links in README files to point to the renamed repository and new default branch.
  • Change pip install commands in java-api-stubs and java-api READMEs to use the java-api-17 repository and correct subdirectories
  • Add an explicit mypy dependency in the java-api-stubs README install example
  • Update all README reference links (CODE_OF_CONDUCT, CONTRIBUTING, LICENSE, contributors, project links) from java-api/java-17 to java-api-17/main and correct repo paths
java-api-stubs/README.md
README.md
java-api/README.md
Update project metadata URLs to reference the new repository name.
  • Change Homepage, Source, and Tracker URLs in java-api-stubs pyproject.toml to the java-api-17 repository
  • Change url and project_urls (Source, Tracker) in java-api/setup.cfg to the java-api-17 repository
java-api-stubs/pyproject.toml
java-api/setup.cfg
Align CI and tooling configuration with the new default branch name.
  • Update GitHub Actions workflows to trigger on the main branch instead of 17
  • Remove the pre-commit CI autoupdate_branch override that referenced branch 17
.github/workflows/ci.yml
.github/workflows/pr-build.yml
.pre-commit-config.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • In the root README, the [java-api-stubs] link still points to github.com/ignition-devs/java-api/tree/main/java-api-stubs instead of the renamed java-api-17 repository, which will likely lead to a broken or outdated link.
  • The added "mypy[python2]==0.971" in the python3 -m pip install example for java-api-stubs may be surprising for users installing only the stubs; consider documenting why it is required there or moving it into project configuration (e.g., extras/requirements) rather than the README install snippet.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the root README, the `[java-api-stubs]` link still points to `github.com/ignition-devs/java-api/tree/main/java-api-stubs` instead of the renamed `java-api-17` repository, which will likely lead to a broken or outdated link.
- The added `"mypy[python2]==0.971"` in the `python3 -m pip install` example for `java-api-stubs` may be surprising for users installing only the stubs; consider documenting why it is required there or moving it into project configuration (e.g., extras/requirements) rather than the README install snippet.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@cesarcoatl cesarcoatl merged commit 69cf455 into main Dec 8, 2025
5 checks passed
@cesarcoatl cesarcoatl deleted the chore/rename-repo branch December 8, 2025 20:58
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.

2 participants