Skip to content

Commit 970ae66

Browse files
author
Henry McConville
committed
Add repo migration notice
1 parent 239f9e2 commit 970ae66

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
[![Build Status](https://travis-ci.org/infinityworks/github-exporter.svg?branch=master)](https://travis-ci.org/infinityworks/github-exporter)
1+
# :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
28

39
# Prometheus GitHub Exporter
410

@@ -11,7 +17,7 @@ This exporter is setup to take input from environment variables. All variables a
1117
* `ORGS` If supplied, the exporter will enumerate all repositories for that organization. Expected in the format "org1, org2".
1218
* `REPOS` If supplied, The repos you wish to monitor, expected in the format "user/repo1, user/repo2". Can be across different Github users/orgs.
1319
* `USERS` If supplied, the exporter will enumerate all repositories for that users. Expected in
14-
the format "user1, user2".
20+
the format "user1, user2".
1521
* `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.
1622
* `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.
1723
* `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".
2430

2531
Run manually from Docker Hub:
2632
```
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
2834
```
2935

3036
Build a docker image:
@@ -43,7 +49,7 @@ github-exporter:
4349
- 9171
4450
ports:
4551
- 9171:9171
46-
image: infinityworks/github-exporter:latest
52+
image: githubexporter/github-exporter:latest
4753
environment:
4854
- REPOS=<REPOS you want to monitor>
4955
- 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
5763

5864
## Tests
5965

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.
6167
Run as follows
6268

6369
```bash
@@ -67,7 +73,7 @@ make test
6773
## Version Release Procedure
6874
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/).
6975

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`:
7177

7278
```bash
7379
./release-version.sh

release-version.sh

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ if ! [[ "$version" =~ ^[0-9.]+$ ]]; then
1919
exit 1
2020
fi
2121

22-
docker build -t infinityworks/github-exporter:latest -t infinityworks/github-exporter:$version .
22+
docker build -t infinityworks/github-exporter:latest -t infinityworks/github-exporter:$version -t githubexporter/github-exporter:latest -t githubexporter/github-exporter:$version .
2323
docker push infinityworks/github-exporter:latest
2424
docker push infinityworks/github-exporter:$version
25+
docker push githubexporter/github-exporter:latest
26+
docker push githubexporter/github-exporter:$version
2527

0 commit comments

Comments
 (0)