From 30dd8a1fbf39ab3cb0229470dfa28e3b54ab2fb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Mond=C3=A9jar?= Date: Sat, 28 Oct 2023 20:24:55 +0200 Subject: [PATCH] Use permanent README icons links in releases (#9788) * Ensure permanent release README links * Minor change --- .github/workflows/publish.yml | 11 ++++++++--- package.json | 3 +-- .../strip-theme-links.js} | 4 +++- 3 files changed, 12 insertions(+), 6 deletions(-) rename scripts/{build/strip-theme-link.js => release/strip-theme-links.js} (78%) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4184494e..a481a1de 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -48,10 +48,15 @@ jobs: key: ${{ runner.os }}-node-${{ hashFiles('**/package.json') }} restore-keys: | ${{ runner.os }}-node- + - name: Get release version + id: get-version + run: | + export PACKAGE_VERSION=$(cat package.json | grep 'version' | sed 's/[ \",:]//g' | sed 's/version//') + echo "version=$PACKAGE_VERSION" >> $GITHUB_OUTPUT - name: Install dependencies run: npm i - name: Replace CDN theme image links from README - run: npm run strip-theme-link + run: node ./scripts/release/strip-theme-links.js "${{ steps.get-version.outputs.version }}" - name: Update SDK Typescript definitions run: node ./scripts/release/update-sdk-ts-defs.js - name: Build NodeJS package @@ -74,9 +79,9 @@ jobs: id: get-version run: | export PACKAGE_VERSION=$(cat package.json | grep 'version' | sed 's/[ \",:]//g' | sed 's/version//') - echo "::set-output name=version::$PACKAGE_VERSION" + echo "version=$PACKAGE_VERSION" >> $GITHUB_OUTPUT - name: Replace CDN theme image links from README - run: npm run strip-theme-link + run: node ./scripts/release/strip-theme-links.js "${{ steps.get-version.outputs.version }}" - name: Configure GIT credentials run: | git config user.name "${GITHUB_ACTOR}" diff --git a/package.json b/package.json index 3d303203..f60d4873 100644 --- a/package.json +++ b/package.json @@ -123,8 +123,7 @@ "pretest": "npm run prepublishOnly", "posttest": "npm run postpublish", "get-filename": "node scripts/get-filename.js", - "add-icon-data": "node scripts/add-icon-data.js", - "strip-theme-link": "node scripts/build/strip-theme-link.js" + "add-icon-data": "node scripts/add-icon-data.js" }, "engines": { "node": ">=0.12.18" diff --git a/scripts/build/strip-theme-link.js b/scripts/release/strip-theme-links.js similarity index 78% rename from scripts/build/strip-theme-link.js rename to scripts/release/strip-theme-links.js index cc8ab7ef..ca81e48d 100644 --- a/scripts/build/strip-theme-link.js +++ b/scripts/release/strip-theme-links.js @@ -7,6 +7,8 @@ import path from 'node:path'; import { writeFile, readFile } from 'node:fs/promises'; import { getDirnameFromImportMeta } from '../../sdk.mjs'; +const LINKS_BRANCH = process.argv[2] || 'develop'; + const __dirname = getDirnameFromImportMeta(import.meta.url); const rootDir = path.resolve(__dirname, '..', '..'); @@ -17,6 +19,6 @@ await writeFile( readmeFile, readme.replace( /https:\/\/cdn.simpleicons.org\/(.+)\/000\/fff/g, - 'https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/$1.svg', + `https://raw.githubusercontent.com/simple-icons/simple-icons/${LINKS_BRANCH}/icons/$1.svg`, ), );