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.

Sign up for GitHub

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

integration-docs: Update Github Actions for new doc format. #32781

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

integration-docs: Update Github Actions for new doc format. #32781

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
integration-docs: Update Github Actions for new doc format. 
Part of #29592.
  • Loading branch information
@Niloth-p
Niloth-p committed Dec 19, 2024
commit 2c24ea3779c9d67fafa8a849c4753a4aaafdb0ac
27 changes: 22 additions & 5 deletions templates/zerver/integrations/github-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
It's easy to send Zulip messages from GitHub Actions! This is useful:
# Zulip GitHub Actions integration

* If you want to report the success or failure of an Action to Zulip.
* If you want to send output from your actions to Zulip.
It's easy to send Zulip messages from GitHub Actions!

Instructions are available [here](https://github.com/zulip/github-actions-zulip#readme).
{start_tabs}

See also the [GitHub integration](/integrations/doc/github).
1. {!create-a-generic-bot.md!}

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Removed the "Note down the bot's email address and API key." line that was appended to this instruction.

1. To send Zulip notifications whenever your workflow runs, add the
`zulip/github-actions-zulip/send-message@v1` action to your GitHub
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This was previously in 2 separate instructions, that has now been clubbed together, as they don't make much sense separately.
We introduce the action that needs to be added, and the values with which it needs to be configured in the same instruction.

Actions workflow file, and set the input values as specified in the
[README][README] of the [Zulip GitHub Actions repository][repo].

{end_tabs}

### Related documentation

* [Zulip GitHub Actions repository][repo]

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Since the link to the repo was added into the second instruction (in the last update), this link has been edited to re-use it, by adding the 'repo' ref link.

* [Configuring the Zulip Send Message Action][README]

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Configuring the Action -> Configuring the Zulip Send Message Action

* [GitHub integration](/integrations/doc/github)

[README]: https://github.com/zulip/github-actions-zulip/blob/main/send-message/README.md
[repo]: https://github.com/zulip/github-actions-zulip
Loading