feat: added a link to the version-accurate help page

meza · Oct 25, 2022 · d68dcc2 · d68dcc2
1 parent 2ad0670
commit d68dcc2
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -81,6 +81,7 @@ jobs:
 
       - name: 🚀 Build & Release
         env:
+          HELP_URL: ${{github.server_url}}/${{github.repository}}/blob/${{github.sha}}/README.md
           CURSEFORGE_API_KEY: ${{ secrets.CURSEFORGE_API_KEY }}
           MODRINTH_API_KEY: ${{ secrets.MODRINTH_API_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/scripts/prepare.sh b/scripts/prepare.sh
@@ -3,14 +3,13 @@
 FILE=$1
 VERSION=$2
 
-echo "HELP URL: $HELP_URL"
-
 cat > "$FILE" <<EOF
 export const version = '$VERSION';
 EOF
 
 sed -i "s/\"version\": \"[0-9.]*\"/\"version\": \"$VERSION\"/" package.json
 sed -i "s|REPL_CURSEFORGE_API_KEY|$CURSEFORGE_API_KEY|" src/env.ts
 sed -i "s|REPL_MODRINTH_API_KEY|$MODRINTH_API_KEY|" src/env.ts
+sed -i "s|REPL_HELP_URL|$HELP_URL|" src/env.ts
 
 echo "Set version to $VERSION"
diff --git a/src/__snapshots__/mmm.test.ts.snap b/src/__snapshots__/mmm.test.ts.snap
@@ -14,6 +14,7 @@ Command {
   "_description": "Manages mods from Modrinth and Curseforge",
   "_enablePositionalOptions": false,
   "_events": {
+    "afterHelp": [Function],
     "option:config": [Function],
     "option:debug": [
       [Function],
@@ -25,7 +26,7 @@ Command {
     ],
     "option:version": [Function],
   },
-  "_eventsCount": 4,
+  "_eventsCount": 5,
   "_executableDir": null,
   "_executableFile": null,
   "_executableHandler": false,

diff --git a/src/env.ts b/src/env.ts
@@ -1,2 +1,3 @@
 export const curseForgeApiKey = process.env.CURSEFORGE_API_KEY || 'REPL_CURSEFORGE_API_KEY';
 export const modrinthApiKey = process.env.MODRINTH_API_KEY || 'REPL_MODRINTH_API_KEY';
+export const helpUrl = process.env.HELP_URL || 'REPL_HELP_URL';
diff --git a/src/mmm.ts b/src/mmm.ts
@@ -9,6 +9,7 @@ import { version } from './version.js';
 import { update } from './actions/update.js';
 import { initializeConfig } from './interactions/initializeConfig.js';
 import { Logger } from './lib/Logger.js';
+import { helpUrl } from './env.js';
 
 export const APP_NAME = 'Minecraft Mod Manager';
 export const APP_DESCRIPTION = 'Manages mods from Modrinth and Curseforge';
@@ -33,6 +34,7 @@ export const stop = (): never => {
 const commands = [];
 
 program.name(APP_NAME).version(version).description(APP_DESCRIPTION);
+program.addHelpText('after', '\nFor more information, visit: ' + helpUrl);
 
 program.on('option:quiet', () => {
   logger.flagQuiet();