From 170dc4bb86c9897a469c136614910c32581ace25 Mon Sep 17 00:00:00 2001 From: Jan Brasna <1784648+janbrasna@users.noreply.github.com> Date: Sat, 26 Apr 2025 01:15:07 +0200 Subject: [PATCH 1/4] Update branch wording and refresh examples & links --- src/SetupPage.js | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/SetupPage.js b/src/SetupPage.js index 0cfe1e3..4fc444a 100644 --- a/src/SetupPage.js +++ b/src/SetupPage.js @@ -200,16 +200,16 @@ class WhatIsIt extends React.Component {
It's a web service for visualizing the difference between code
- committed to master in your GitHub project compared to
- which code has been deployed in your dev, stage and/or production
- environment(s).
+ committed to the default branch of your GitHub project
+ compared to which code has been deployed in your dev, stage and/or
+ production environment(s).
For this to work you need to have your code in a{' '} public GitHub repository and the git SHA that is deployed on - your server(s) need to be publicly available. + your server(s) has to be publicly available.
The git SHA needs to be the content of the URL or it can be JSON that
@@ -226,17 +226,17 @@ class WhatIsIt extends React.Component {
Once you've typed in the GitHub organization, GitHub repository and at
least one of these URLs you can generated a table that shows what's
been deployed on the server(s) compared to what's available in the{' '}
- master branch.
+ default branch.
- It's just a Flask app and you - can install and run your own instance if you want to use this for your - private repositories. + It's just a Flask app + and you can install and run your own instance if you want to use this + for your private repositories.
); From 55f2fa4d3335cd40eb563305586787b4a22d8854 Mon Sep 17 00:00:00 2001 From: Jan Brasna <1784648+janbrasna@users.noreply.github.com> Date: Sat, 26 Apr 2025 01:36:02 +0200 Subject: [PATCH 2/4] Improve badge contrast and update commit header --- src/DeployPage.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/DeployPage.js b/src/DeployPage.js index 7061dfe..a8eb7a9 100644 --- a/src/DeployPage.js +++ b/src/DeployPage.js @@ -321,7 +321,7 @@ class DeployTable extends React.Component {{BORS_LOGIN}.{' '}
@@ -733,8 +733,8 @@ class BadgesAndUrls extends React.Component {
const fullUrl = `${protocol}//${host}${shortUrl}/${owner}/${repo}`;
const envs = deployInfo
.map((deploy) => deploy.name.toLowerCase())
- .join(',');
- const badgeUrl = `https://img.shields.io/badge/whatsdeployed-${envs}-green.svg`;
+ .join('/');
+ const badgeUrl = `https://img.shields.io/badge/whatsdeployed-${envs}-teal.svg`;
const badgeAlt = `What's deployed on ${envs}?`;
const markdown = `[](${fullUrl})`;
const restructuredText = `.. |whatsdeployed| image:: ${badgeUrl}\n :target: ${fullUrl}`;
From d32aa487c30265e72ea57906711871070af25deb Mon Sep 17 00:00:00 2001
From: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
Date: Sun, 27 Apr 2025 03:33:03 +0200
Subject: [PATCH 3/4] Improve setup language
---
src/SetupPage.js | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/SetupPage.js b/src/SetupPage.js
index 4fc444a..70a3f25 100644
--- a/src/SetupPage.js
+++ b/src/SetupPage.js
@@ -223,8 +223,8 @@ class WhatIsIt extends React.Component {
{`$ curl https://dev.example.com/deployed-version\n{"commit": "d16cc25d58252a2b7e6bb394cbefa76b147d64d3", "other": "stuff"}`}
- Once you've typed in the GitHub organization, GitHub repository and at - least one of these URLs you can generated a table that shows what's + Once you've typed in the GitHub organization, GitHub repository, and + at least one of these URLs, you can generate a table that shows what's been deployed on the server(s) compared to what's available in the{' '} default branch.
From 817b109de3c17136dae801d19d33700062e59880 Mon Sep 17 00:00:00 2001 From: Jan Brasna <1784648+janbrasna@users.noreply.github.com> Date: Sun, 27 Apr 2025 05:29:35 +0200 Subject: [PATCH 4/4] Update setup instructions --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 652c1f5..ae0159f 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,10 @@ What's deployed from a GitHub repo on various server environments? -This requires that you have 2 or more URLs that return a git sha that -references which git sha has been deployed. +This requires that you have a URL returning the git SHA of a commit +currently deployed in the environment. If this commit is present in your +default branch and the repository is public, you will get a shortlink showing +the state of individual deployments in relation to your commit history. ## Screenshots @@ -51,9 +53,9 @@ yarn start This will automatically open your browser to http://localhost:3000/ -To avoid hitting rate limits on GitHub's API you can go to +To avoid hitting rate limits on GitHub's API, you should go to your [Personal access tokens](https://github.com/settings/tokens) and generate -a token (without any scopes). How can you set: +a token (without any scopes). Then add it to the command or set it e.g.: ``` export GITHUB_AUTH_TOKEN=afefdf213840aeb8007310ab05fc33eda51a0652