You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# :warning: This repository is moving to the [githubexporter](https://github.com/githubexporter) organisation at [githubexporter/github-exporter](https://github.com/githubexporter/github-exporter):warning:
2
+
3
+
Timeline of changes:
4
+
* 22/05/2023 - All current images are available in the new Docker Hub organisation at https://hub.docker.com/r/githubexporter/github-exporter
5
+
* 27/05/2023 - GitHub repository will be migrated to https://github.com/githubexporter/github-exporter
6
+
* 27/05/2023 - Any new images will be pushed to the `githubexporter` Docker Hub repository only
7
+
* 30/08/2023 - The `infinityworks/github-exporter` Docker Hub repository will be deprecated
2
8
3
9
# Prometheus GitHub Exporter
4
10
@@ -11,7 +17,7 @@ This exporter is setup to take input from environment variables. All variables a
11
17
*`ORGS` If supplied, the exporter will enumerate all repositories for that organization. Expected in the format "org1, org2".
12
18
*`REPOS` If supplied, The repos you wish to monitor, expected in the format "user/repo1, user/repo2". Can be across different Github users/orgs.
13
19
*`USERS` If supplied, the exporter will enumerate all repositories for that users. Expected in
14
-
the format "user1, user2".
20
+
the format "user1, user2".
15
21
*`GITHUB_TOKEN` If supplied, enables the user to supply a github authentication token that allows the API to be queried more often. Optional, but recommended.
16
22
*`GITHUB_TOKEN_FILE` If supplied _instead of_`GITHUB_TOKEN`, enables the user to supply a path to a file containing a github authentication token that allows the API to be queried more often. Optional, but recommended.
17
23
*`API_URL` Github API URL, shouldn't need to change this. Defaults to `https://api.github.com`
@@ -24,7 +30,7 @@ the format "user1, user2".
24
30
25
31
Run manually from Docker Hub:
26
32
```
27
-
docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" infinityworks/github-exporter
33
+
docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" githubexporter/github-exporter
28
34
```
29
35
30
36
Build a docker image:
@@ -43,7 +49,7 @@ github-exporter:
43
49
- 9171
44
50
ports:
45
51
- 9171:9171
46
-
image: infinityworks/github-exporter:latest
52
+
image: githubexporter/github-exporter:latest
47
53
environment:
48
54
- REPOS=<REPOS you want to monitor>
49
55
- GITHUB_TOKEN=<your github api token>
@@ -57,7 +63,7 @@ An example of these metrics can be found in the `METRICS.md` markdown file in th
57
63
58
64
## Tests
59
65
60
-
There is a set of blackbox behavioural tests which validate metrics endpoint in the `test` directory.
66
+
There is a set of blackbox behavioural tests which validate metrics endpoint in the `test` directory.
61
67
Run as follows
62
68
63
69
```bash
@@ -67,7 +73,7 @@ make test
67
73
## Version Release Procedure
68
74
Once a new pull request has been merged into `master` the following script should be executed locally. The script will trigger a new image build in docker hub with the new image having the tag `release-<version>`. The version is taken from the `VERSION` file and must follow semantic versioning. For more information see [semver.org](https://semver.org/).
69
75
70
-
Prior to running the following command ensure the number has been increased to desired version in `VERSION`:
76
+
Prior to running the following command ensure the number has been increased to desired version in `VERSION`:
0 commit comments