Skip to content

Update docIndex for manual runs#38694

Merged
JimSuplizio merged 1 commit into
Azure:mainfrom
JimSuplizio:UpdateDocIndexForManualRuns
Nov 25, 2024
Merged

Update docIndex for manual runs#38694
JimSuplizio merged 1 commit into
Azure:mainfrom
JimSuplizio:UpdateDocIndexForManualRuns

Conversation

@JimSuplizio
Copy link
Copy Markdown
Contributor

@JimSuplizio JimSuplizio commented Nov 25, 2024

This PR only updates the manual run conditions which were completely backwards. When running manually they wouldn't update main unless a variable was set and would always kick off the daily run which is only supposed to be kicked off during the scheduled run. The daily branch updates kick off a docs run against the daily branch which is created/updated when scheduled runs publish daily libraries. On the docs side, when the run against the daily branch completes, it nukes the branch and renames it to "daily/-[ci-succeeded|ci-failed"]. Unless we're specifically testing something related to kicking off the daily runs, it should only ever be run from the scheduled doc index runs. Multiple daily runs can cause issues on the docs with the way the success/failure branch is created.

UpdateMain and ForceDailyUpdate are both template parameters. UpdateMain defaults to true and ForceDailyUpdate defaults to false.

I also moved the verify required metadata json members before running anything because if any of these are borked, any one of the steps running afterwards could fail.

With these changes:

  • Scheduled runs will still update the main and daily branches and kick off the daily run.
  • Manual runs will run update main unless UpdateMain is set to true (which is the default)
  • Manual runs will not update the daily branch and kick off the daily run unless ForceDailyUpdate is set to true but the default is false. The Daily runs should only really be being kicked off during the scheduled run which is at the end of the day UTC.

Testing the changes:

@JimSuplizio JimSuplizio merged commit 07be039 into Azure:main Nov 25, 2024
Copy link
Copy Markdown
Member

@danieljurek danieljurek left a comment

Choose a reason for hiding this comment

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

docindex schedule run is correct. LGTM 👍

l0lawrence pushed a commit to l0lawrence/azure-sdk-for-python that referenced this pull request Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants