Skip to content

Docs: on-release.yml fails to publish doc when running concurrently #365

Closed
@ijemmy

Description

@ijemmy

Bug description

If there are several versions pushed to main at the same time, only one of them will succeed to publish doc.

image

This is because the checked-out version of gh-pages has already been outdated. (As it just got updated by another action) Thus, the command mike deploy --push --update-aliases "$VERSION" "$ALIAS" fails to push.

As a result, some version of the doc will be missing.

Expected Behavior

Multiple actions running around the same time should all work

Current Behavior

If multiple actions running around the same time, only the first one that push the new version of documentation will work.

Possible Solution

  1. Run git pull right before mike deploy.... But this will only reduce the window that this issue could happen
  2. Release manually instead of every time there's a merge in main to ensure that there is only 1 on-release action running at a time.

Steps to Reproduce

  1. Make an empty commit
  2. Push
  3. Make an empty commit
  4. Push again

Environment

N/A

Related issues, RFCs

N/A

Metadata

Metadata

Assignees

Labels

automationThis item relates to automationcompletedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions