ghe‐announce - elliottcarlson/ghe GitHub Wiki

This utility sets a banner at the top of every GitHub Enterprise page on the remote GitHub Enterprise server. You can use it to broadcast a message to your users.

Users will see an announcement similar to the below screenshot:

https://help.github.com/assets/images/enterprise/maintenance/maintenance-scheduled.png

Markdown and new lines are allowable as part of the announcement message.

As with all scripts being run from within GHE CLI, the ghe-host, ghe-ssh-port, and ghe-ssh-user are automatically set and do not need to be provided.

Get state of current announcement banner:

Response when none is set:

GHE> announce
There isn't an announcement message set.
GHE>

Response when an announcement has been set:

GHE> announce
The current message is: "This is the current announcement banner message."
GHE>

Set the announcement banner:

GHE> announce "A routine maintenance window has been scheduled for 5PM EST. Expected downtime 30 minutes."
Setting announcement banner...
The current message is: "A routine maintenance window has been scheduled for 5PM EST. Expected downtime 30 minutes."
GHE>

Clear the announcement banner:

GHE> announce -clear
Clearing announcement banner...
There isn't an announcement message set.
GHE>

Help

GHE> announce -h
usage: ghe-announce.py [-h] [-clear] [-ghe-host HOST] [-ghe-ssh-port PORT]
                       [-ghe-ssh-user USER] [-debug]
                       [ANNOUNCEMENT [ANNOUNCEMENT ...]]

Tool to manage Github Enterprises announcement banner.

positional arguments:
  ANNOUNCEMENT        the message to be set as the announcement banner

optional arguments:
  -h, --help          show this help message and exit
  -clear              clear the announcement banner from the GHE server.
  -ghe-host HOST      the hostname to your GitHub Enterprise server (default: value from `ghe-host` environment variable)
  -ghe-ssh-port PORT  the port to your GitHub Enterprise SSH server (default: 122, or value from `ghe-ssh-port` environment variable)
  -ghe-ssh-user USER  the user to use for SSH access to your GitHub Enterprise server (default: value from `ghe-ssh-user` environment variable)
  -debug              enable debug mode

To retrieve the current status of the announcement banner on the GHE server:
        GHE> announce

To set the announcement banner on the GHE server:
        GHE> announce Your announcement message

To clear the announcement banner on the GHE server:
        GHE> ghe announce -clear
GHE>
⚠️ **GitHub.com Fallback** ⚠️