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

ci: add update-docs workflow #258

Merged
merged 5 commits into from
Nov 1, 2023
Merged

Conversation

Shurtu-gal
Copy link
Contributor

Description

  • The given PR adds a new workflow responsible for generating docs and creating PR with them when there is a commit with docs: prefix.

Related issue(s)
Fixes #242

use commits instead of tags as they are not vulnerable to any bad actors activity (removal of tag, or recreating tag that points to code that sneaks out the api keys)

Co-authored-by: Animesh Kumar <[email protected]>
Co-authored-by: Animesh Kumar <[email protected]>
Copy link
Contributor

@AnimeshKumar923 AnimeshKumar923 left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

I remembered the suggestion made by Lukasz in my PR a long time ago so thought that it should apply here as well. 😁

Rest of the code I'm not an expert so I leave it to other maintainers.

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

Left some comments, thanks a lot for this contribution 🍻

Also please add failure handling https://github.com/derberg/website-asyncapi/blob/refackdsrfssd/.github/workflows/regenerate-meetings-and-videos.yml#L49

.github/workflows/global-replicator.yml Outdated Show resolved Hide resolved
.github/workflows/global-replicator.yml Outdated Show resolved Hide resolved
.github/workflows/update-docs-on-docs-commit.yml Outdated Show resolved Hide resolved
.github/workflows/update-docs-on-docs-commit.yml Outdated Show resolved Hide resolved
.github/workflows/update-docs-on-docs-commit.yml Outdated Show resolved Hide resolved
.github/workflows/update-docs-on-docs-commit.yml Outdated Show resolved Hide resolved
@Shurtu-gal Shurtu-gal requested a review from derberg October 31, 2023 20:23
@Shurtu-gal
Copy link
Contributor Author

All the required changed are done @derberg.

Copy link
Member

@KhudaDad414 KhudaDad414 left a comment

Choose a reason for hiding this comment

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

LGTM!

@Shurtu-gal
Copy link
Contributor Author

/rtm

@asyncapi-bot asyncapi-bot merged commit 1654555 into asyncapi:master Nov 1, 2023
8 checks passed
@Shurtu-gal Shurtu-gal deleted the ci/docs branch November 1, 2023 13:58
@derberg
Copy link
Member

derberg commented Nov 7, 2023

just tried it, works like a charm, all repos that had its own copy, now have the global version

one tiny issue: readme is not updated https://github.com/asyncapi/.github 😄

@Shurtu-gal
Copy link
Contributor Author

one tiny issue: readme is not updated https://github.com/asyncapi/.github 😄

I will update the README and send a new PR. 😸

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

new global workflow for docs update
5 participants