פרסום מ-CI/CD

פרסמו גרסה חדשה של התוסף בכל פעם שאתם דוחפים תגית גרסה כמו v1.2.3, מ-GitHub Actions, מ-GitLab CI או מכל מערכת CI אחרת, עם טוקן לפרסום ששמור כסוד INGOT_PUBLISH_TOKEN.

בטא. ה-workflow מקבע את @ingotide/cli@0.1.0. אם בזמן הבטא החבילה עוד לא נמצאת ב-npm, פרסמו בינתיים מהמחשב שלכם (ראו את מדריך היוצרים) ושמרו את ה-workflow להמשך.

איך זה עובד: מעלים את הגרסה ב-ingot.json, עושים commit ודוחפים תגית תואמת. ה-CI בודק שהתגית תואמת למניפסט, מריץ ingot package (אותן בדיקות כמו בחנות), שומר את ה-.ingotx כ-artifact, ומריץ ingot publish --no-package עם הטוקן מהסוד. ב-CI לא צריך ingot login.

1. יצירת טוקן ל-CI

  1. פתחו את לוח בקרה › מפרסם (/dashboard/publisher).
  2. תחת טוקנים לפרסום, תנו לו שם לפי מערכת ה-CI והמאגר, למשל GitHub Actions acme/react-rules.
  3. בחרו תוקף. 90 או 180 ימים הם איזון טוב; תחליפו אותו לפני שהתוקף יפוג (שלב 5).
  4. לחצו על יצירת טוקן והעתיקו את הערך ingot_pub_…. הוא מוצג פעם אחת בלבד.

השתמשו בטוקן נפרד לכל מערכת CI או מאגר, אף פעם לא בזה שבמחשב הנייד, כדי שתוכלו לבטל אחד בלי לשבור את האחרים.

2. שמירת הטוקן כסוד

לעולם אל תעשו commit לטוקן, אל תדפיסו אותו בלוגים ואל תשימו אותו ב-ingot.json.

GitHub: במאגר, פתחו Settings › Secrets and variables › Actions › New repository secret. שם: INGOT_PUBLISH_TOKEN, ערך: הטוקן. או עם ה-CLI של GitHub:

gh secret set INGOT_PUBLISH_TOKEN --repo acme/react-rules

GitLab: פתחו Settings › CI/CD › Variables › Add variable. מפתח: INGOT_PUBLISH_TOKEN, ערך: הטוקן, וסמנו Mask variable ו-Protect variable. משתנים מוגנים מועברים רק לענפים ולתגיות מוגנים, אז הגנו גם על תגיות הגרסה תחת Settings › Repository › Protected tags (תבנית v*).

CI אחר: הוסיפו משתנה סביבה סודי בשם INGOT_PUBLISH_TOKEN. ה-CLI קורא אותו לבד.

3. הוספת ה-workflow

ingot init כבר כתב את הקובץ בשבילכם (--ci github, ברירת המחדל, או --ci gitlab). כדי להוסיף אותו לתוסף קיים, העתיקו אחד מהקבצים שלמטה.

GitHub Actions

.github/workflows/ingot-publish.yml:

name: Publish to the Ingot store

on:
  push:
    tags: ['v*.*.*']
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ingot-publish-${{ github.ref }}
  cancel-in-progress: false

jobs:
  publish:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 22

      - name: Check the tag matches ingot.json
        if: startsWith(github.ref, 'refs/tags/')
        run: |
          manifest_version=$(node -p "require('./ingot.json').version")
          if [ "v${manifest_version}" != "${GITHUB_REF_NAME}" ]; then
            echo "::error::Tag ${GITHUB_REF_NAME} does not match ingot.json version ${manifest_version}"
            exit 1
          fi

      - name: Validate and package
        run: npx --yes @ingotide/cli@0.1.0 package

      - name: Publish
        run: npx --yes @ingotide/cli@0.1.0 publish --no-package
        env:
          INGOT_PUBLISH_TOKEN: ${{ secrets.INGOT_PUBLISH_TOKEN }}

      - uses: actions/upload-artifact@v4
        with:
          name: ingotx
          path: '*.ingotx'
          if-no-files-found: error

ה-job רק קורא את המאגר (contents: read) ומעביר את הטוקן לשלב הפרסום בלבד.

GitLab CI

.gitlab-ci.yml:

stages:
  - package
  - publish

default:
  image: node:22-alpine

package:
  stage: package
  script:
    - npx --yes @ingotide/cli@0.1.0 package
  artifacts:
    paths:
      - '*.ingotx'
    expire_in: 1 week

publish:
  stage: publish
  needs: [package]
  rules:
    - if: '$CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+/'
  script:
    - test "v$(node -p "require('./ingot.json').version")" = "$CI_COMMIT_TAG" || (echo "Tag $CI_COMMIT_TAG does not match ingot.json" && exit 1)
    - npx --yes @ingotide/cli@0.1.0 publish --no-package

ה-job של package רץ בכל push, כך שמניפסט שבור מכשיל את ה-pipeline עוד לפני שמתייגים. publish רץ רק בתגיות גרסה.

כל CI אחר

אותן שלוש פקודות עובדות בכל מקום עם Node.js 22:

npx --yes @ingotide/cli@0.1.0 validate
npx --yes @ingotide/cli@0.1.0 package
INGOT_PUBLISH_TOKEN=*** npx --yes @ingotide/cli@0.1.0 publish --no-package

4. שחרור בדחיפת תגית

ingot version patch                          # or minor / major; updates ingot.json and CHANGELOG.md
git commit -am "v1.2.4"
git tag v1.2.4
git push --follow-tags

התגית חייבת להיות v ואחריה הגרסה המדויקת שב-ingot.json. גם גרסאות מוקדמות עובדות: ingot version 2.0.0-beta.1, תגית v2.0.0-beta.1. בדקו את הריצה ב-CI; הלוג מסתיים בדף החנות של הגרסה החדשה.

5. החלפת הטוקן לפני שהתוקף פג

לוח הבקרה מציג את התוקף של כל טוקן, וגם ingot whoami מדפיס אותו. לפני שהתוקף פג: צרו טוקן חדש, החליפו את הערך של הסוד, הריצו שוב את ה-workflow האחרון כדי לבדוק, ואז בטלו את הטוקן הישן. טוקן שבוטל או שפג תוקפו נכשל מיד עם invalid_token או token_expired, ושום דבר לא מתפרסם.

אם טוקן דלף, קודם בטלו אותו בלוח בקרה › מפרסם, ואז צרו טוקן חדש.

פתרון בעיות

השגיאה בלוגסיבה ופתרון
No publish token.הסוד לא מוגדר או לא מועבר לשלב. בדקו שהשם הוא בדיוק INGOT_PUBLISH_TOKEN; ב-GitLab, בדקו שהתגית מוגנת.
401 invalid_tokenהטוקן בוטל או הועתק לא נכון. צרו טוקן חדש ועדכנו את הסוד.
401 token_expiredצרו טוקן חדש ועדכנו את הסוד (שלב 5).
403 publisher_mismatchpublisher ב-ingot.json אינו המזהה שהטוקן שייך לו.
409 version_existsהגרסה הזו כבר פורסמה. העלו גרסה ודחפו תגית חדשה; תגית לא יכולה לפרסם גרסה מחדש.
409 version_not_newerהגרסה נמוכה מהאחרונה. השתמשו ב-ingot version patch.
Tag v1.2.3 does not match ingot.jsonתייגתם לפני שהעליתם גרסה. מחקו את התגית (git tag -d v1.2.3 && git push origin :v1.2.3), העלו גרסה, עשו commit ותייגו שוב.
400 invalid_manifest או invalid_contentsהלוג מפרט כל בעיה. הריצו ingot validate אצלכם ותקנו אותן.
429 rate_limitedיותר מ-30 העלאות בשעה. חכו ואז הריצו את ה-job שוב.
The registry must use https://INGOT_REGISTRY מצביע על כתובת http:// שאינה localhost. הסירו אותו כדי להשתמש בחנות.
npm ERR! 404 @ingotide/cliה-CLI עוד לא ב-npm (בטא). פרסמו בינתיים מהמחשב שלכם.