Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alphagov/fourth-wall
Retired pull request and build status monitor
https://github.com/alphagov/fourth-wall
Last synced: about 1 month ago
JSON representation
Retired pull request and build status monitor
- Host: GitHub
- URL: https://github.com/alphagov/fourth-wall
- Owner: alphagov
- License: mit
- Archived: true
- Created: 2013-09-05T12:47:28.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2021-09-30T16:27:47.000Z (almost 3 years ago)
- Last Synced: 2024-04-10T22:25:59.499Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.31 MB
- Stars: 38
- Watchers: 88
- Forks: 36
- Open Issues: 9
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
# Retired and unmaintained
This project is retired and unmaintained. Do not use: it has known accessibility problems, and may have open security issues.
# Fourth Wall
[](https://travis-ci.org/alphagov/fourth-wall)
Pure client-side pull request and build status monitor for Github repositories.
## How to use
The project is hosted through Github pages:
`https://alphagov.github.io/fourth-wall/?token=_token_&gist=_gist_id_`
You will need to have a Github API token with access to the relevant
repositories if you don't already have one. To do that, visit
https://github.com/settings/tokens and create a new personal
access token. To use the `team` parameter you will need to give the token
the `read:org` permission.
The following query parameters are required:
- `token`: Your Github API token
At least one of:
- `gist`: ID of the Gist containing the list of repositories to monitor.
- `team`: Github organisation and team name to build the list of repositories in the form `{org}/{team}` (requires the [`read:org`](https://developer.github.com/v3/orgs/) permission).
- `team[]`: Given multiple times allows for more than one team to be used to build the list of repositories.
- `file`: URL of a file in a Github repo that contains the list of repositories.
Optional query parameters:
- `listinterval`: Update interval for the list of monitored repos in seconds (default: 900)
- `interval`: Update interval for monitored repos in seconds (default: 60)
- `filterusers`: Only show PRs from specific users, if set in config (default: false)
- `wiphandling`: Specify treatment for WIP PRs; those which have a `WIP`, `DO NOT
MERGE` or `REVIEW ONLY` tag in the title. By default these are shown in a reduced
manner. Set this param to:
- _`none`_: display WIP PR's like any other PRs
- _`small`_ or unset: show WIP PR's in a reduced manner *default behaviour*
- _`hide`_: hide WIP PR's completely
- `filterrepo`: Specify a repository name you wish to exclude from displayed PRs
- `filterrepo[]`: Given multiple times allows for more than one repository to be excluded
- `extra_scopes`: A comma separated list of extra scopes that your token requires
## Gist
If the `gist` parameter is used, the Gist should contain one or more JSON files with this syntax:
```json
[
{
"userName": "",
"repo": ""
}
]
```
You must make sure you set the language of the Gist to JSON as it will
default to Text, which will not work.
Optionally, the Gist can contain a JSON file named `users`, to list
users the team cares about. Fourth Wall can then display PRs
across your tracked apps opened by these users, if the `filterusers` param is set. Syntax:
```json
[
"username0",
"username1"
]
```
Optionally, entries may also contain ```"important": true``` to indicate that a
repository is important. This has an effect only when the `filterusers` param
is set: PRs on important repositories will always be displayed, even when they
weren't opened by one of the listed users.
If the Gist contains a file with the language set to `CSS`, it will be injected
into a `` block in the document head, so you can override the default
styling without having to fork this repo.
Examples:
* A simple list of repos for the [Performance Platform team](https://gist.github.com/abersager/6449384)
* A list of repos and custom CSS for the [Mainstream team](https://gist.github.com/norm/7248264)
* A list of repos, custom CSS and users for the [Core team](https://gist.github.com/issyl0/70cf0c8f3d0b1ccd2f6e)
## File
If the `file` parameter is used, the file should contain JSON with this syntax:
```json
[
{
"userName": "<username of the repo owner>",
"repo": "<repository name>"
}
]
```
If desired, `"owner"` can be as a synonym for `"userName"`, while `"name"` can
be used as a synonym for `"repo"`.
The value of the `file` parameter must refer to the file using a GitHub API
URL. For example, to point to `foo/bar.json` in the `alphagov/example` repo,
use `https://api.github.com/repos/alphagov/example/contents/foo/bar.json`.
Do not URL-encode the `file` parameter’s value:
`https://alphagov.github.io/fourth-wall/?token=_token_&file=https://api.github.com/repos/alphagov/example/contents/foo/repos.json`
## Support for other githubs
If you use github enterprise you must add the `baseUrl` to each repo object and
add a token for that hostname. The url parameter for the other hostname should
be of the form `<hostname>_token`.
An example enterprise repository.
```json
[
{
"baseUrl": "https://myhost.com/api/v3/repos",
"userName": "<username of the repo owner>",
"repo": "<repository name>"
}
]
```
To load repositories from a team on an enterprise instance you must prefix the
hostname to the team url parameter as with the token `<hostname>_team` (or
`<hostname>_team[]` for multiple teams).
## Security
The token used to access Github is visible in the URL bar of the browser used
to view Fourth Wall. This is potentially quite dangerous and you should be very
careful about Github access tokens. There are some pre-flight checks to help
with security but you should, at all times, be vigilant and discliplined.
Required scopes:
- `repo:status`
- `repo:deployment`
Optional scopes:
- `read:org` is required if you are using the `team` query parameter mentioned above.
- `repo` is needed if you need to give fourth-wall access to private repositories, this must be enabled using the `extra_scopes` query parameter documented above.
Any other allowed scopes on the token will cause Fourth Wall to be unusable
(due to an alert) until the token scopes have been fixed. This is a feature not a bug.
Additionally there is a pre-flight check which checks that if Fourth Wall is
being accessed remotely using HTTP. If Fourth Wall is being viewed remotely,
please always use HTTPS.