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

Resolve race condition between check for conflicts and discourse update #187

Open
jdkandersson opened this issue Jul 13, 2023 · 0 comments

Comments

@jdkandersson
Copy link
Contributor

The action checks for conflicts between git docs and discourse. However, taking into account the need to run the conflict detection check for every topic, potential rate limits and potentially large documentation, there could be on the order of minutes between the conflict check being run and the documentation actually being updated. This means that there is a window of time when there could be a community contribution that gets overridden.

There are some ideas to resolve this:

  • Mark the documentation topics as a draft before running the check so that other changes cannot be made in the meantime
  • Record the version of a topic that was current as of the conflict check and check that there were no changes after all the updates were made. If there were any changes, roll back the updates that were made automatically and fail the action
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

No branches or pull requests

1 participant