Skip to content

README: firmware is also published on the push to master - #10

Merged
Jiu-xiao merged 1 commit into
devfrom
docs/firmware-on-master
Oct 5, 2026
Merged

Jiu-xiao merged 1 commit into
devfrom
docs/firmware-on-master

Conversation

@Jiu-xiao

@Jiu-xiao Jiu-xiao commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Follows xrobot-org/XRobot#108: bsp-stm32-ci.yml publishes the firmware on the push to master (tagging the next patch version, v1.0.0 first) as well as on a v* tag push. Takes effect when v1 moves at the next release.

Summary by Sourcery

Documentation:

  • Update the README in Chinese and English to document firmware publication on pushes to master, in addition to version tag pushes.

bsp-stm32-ci.yml (XRobot #108) publishes the firmware on the push to master with the next patch tag, in addition to a v tag push.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @Jiu-xiao, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 5 days and 11 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Oct 5, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

README documentation now matches the shared bsp-stm32-ci.yml workflow: firmware is published both for pushes to master, which receive the next patch-version tag, and for explicit v* tag pushes.

Flow diagram for firmware publication triggers

flowchart LR
    PushMaster[Push to master] --> PatchTag[Tag next patch version]
    PushTag[Push v* tag] --> Publish[Publish firmware]
    PatchTag --> Publish
    Publish --> Artifact[Firmware artifact]
Loading

File-Level Changes

Change Details Files
Update firmware publishing documentation to reflect the shared CI workflow’s master-branch release behavior.
  • Document publishing on pushes to master, including creation of the next patch-version tag.
  • Retain and clarify publishing behavior for pushes of v* tags.
  • Apply the behavior update consistently to the Chinese and English README sections.
README.md

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

@Jiu-xiao
Jiu-xiao merged commit 66176a6 into dev Oct 5, 2026
5 checks passed
@Jiu-xiao
Jiu-xiao deleted the docs/firmware-on-master branch October 5, 2026 01:07
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.

1 participant