mirror of https://github.com/zulip/zulip.git
integrations: Document default branch name updates.
53e59c8c09
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
parent
3cb66d59ac
commit
e5a818b869
|
@ -12,7 +12,7 @@ Get Zulip notifications for your Git repositories!
|
|||
|
||||
You can specify the branches that will be used for notifications by modifying
|
||||
the `commit_notice_destination` function. By default,
|
||||
pushes to the `master` and `test-post-receive` branches will result in a
|
||||
pushes to the `main`, `master`, and `test-post-receive` branches will result in a
|
||||
notification.
|
||||
|
||||
1. Symlink `/usr/local/share/zulip/integrations/git/zulip_git_config.py`
|
||||
|
@ -23,7 +23,7 @@ Get Zulip notifications for your Git repositories!
|
|||
|
||||
!!! tip ""
|
||||
|
||||
You can test the plugin without changing your `master` branch by
|
||||
You can test the plugin without changing your `main` branch by
|
||||
pushing to the `test-post-receive` branch.
|
||||
|
||||
{!congrats.md!}
|
||||
|
|
|
@ -8,7 +8,7 @@ Then:
|
|||
|
||||
1. {!download-python-bindings.md!}
|
||||
|
||||
2. Edit the `hg/.hgrc` configuration file for this master Mercurial
|
||||
2. Edit the `hg/.hgrc` configuration file for this default Mercurial
|
||||
repository and add the following sections, using the credentials for
|
||||
your Mercurial bot and setting the appropriate path to the integration
|
||||
hook if it installs in a different location on this system:
|
||||
|
@ -42,7 +42,7 @@ The Mercurial integration also supports:
|
|||
|
||||
If you’ve set up your repository to be [browsable via the web][1],
|
||||
add a `web_url` configuration option to the `zulip` section of your
|
||||
master `.hg/hgrc` to get changelog and revision links in your Zulip
|
||||
default `.hg/hgrc` to get changelog and revision links in your Zulip
|
||||
notifications:
|
||||
|
||||
[zulip]
|
||||
|
@ -59,7 +59,7 @@ notifications:
|
|||
By default, this integration will send Zulip notifications for
|
||||
changegroup events for all branches. If you’d prefer to only receive
|
||||
Zulip notifications for specified branches, add a `branches`
|
||||
configuration option to the `zulip` section of your master `.hg/hgrc`,
|
||||
configuration option to the `zulip` section of your default `.hg/hgrc`,
|
||||
containing a comma-separated list of the branches that should produce
|
||||
notifications:
|
||||
|
||||
|
@ -67,11 +67,11 @@ notifications:
|
|||
email = "hg-bot@example.com"
|
||||
api_key = "0123456789abcdefg"
|
||||
stream = "commits"
|
||||
branches = "prod,master"
|
||||
branches = "prod,default"
|
||||
|
||||
You can also exclude branches that you don’t want to cause
|
||||
notifications. To do so, add an `ignore_branches` configuration option
|
||||
to the `zulip` section of your master `.hg/hgrc`, containing a
|
||||
to the `zulip` section of your default `.hg/hgrc`, containing a
|
||||
comma-separated list of the branches that should be ignored:
|
||||
|
||||
[zulip]
|
||||
|
|
|
@ -22,14 +22,14 @@ in an OpenShift instance.
|
|||
what stream the notifications will be sent by modifying the
|
||||
`deployment_notice_destination` function in
|
||||
`zulip_openshift_config.py`. By default, deployments triggered by
|
||||
commits pushed to the `master` and `test-post-receive` branches will
|
||||
commits pushed to the `main`, `master`, and `test-post-receive` branches will
|
||||
result in a notification to stream `deployments`.
|
||||
|
||||
1. Save the file, and symlink
|
||||
`$OPENSHIFT_PYTHON_DIR/virtenv/share/zulip/integrations/openshift/post-receive`
|
||||
into the `~/app-root/repo/.openshift/action_hooks` directory.
|
||||
|
||||
1. Whenever you make a push to the `master` branch of your application’s
|
||||
1. Whenever you make a push to the `main` branch of your application’s
|
||||
repository (or whichever branch you configured above), or if you force
|
||||
a deployment, the Zulip OpenShift plugin will send an automated
|
||||
notification.
|
||||
|
@ -40,4 +40,4 @@ in an OpenShift instance.
|
|||
|
||||
### Testing
|
||||
|
||||
You can test the plugin without changing your `master` branch by pushing to the `test-post-receive` branch.
|
||||
You can test the plugin without changing your `main` branch by pushing to the `test-post-receive` branch.
|
||||
|
|
Loading…
Reference in New Issue