Auto: [आरएफसी] लेबल विन्यास को सरल बनाएं

को निर्मित 6 जुल॰ 2019 · 17टिप्पणियाँ · स्रोत: intuit/auto

क्या आपका फीचर अनुरोध किसी समस्या से संबंधित है?

पर काम करने की प्रक्रिया के दौरान ऑटोबोट मैं से निपटने / पार्स करने / ऑटो के लेबल विन्यास सेटअप groking के साथ संघर्ष किया है।

यहां तक कि जब मैंने ऑटो का उपयोग करना शुरू किया, तो जो मैं चाहता था उसके व्यवहार को उपलब्ध कॉन्फ़िगरेशन में मैप करना थोड़ा मुश्किल था।

नीचे मैं कुछ ऐसे व्यवहारों की रूपरेखा तैयार करूँगा जो मुझे लगता है कि इसे और अधिक जटिल बनाते हैं जितना कि इसकी आवश्यकता है:

लेबल परिभाषाएं एक स्ट्रिंग या ऑब्जेक्ट हो सकती हैं। यह आशुलिपि के लिए मदद करता है, लेकिन मानसिक रूप से मानचित्र बनाने के लिए इसे थोड़ा कठिन बनाता है (और इसके लिए टूलिंग का निर्माण करता है)। वस्तुओं का एक नाम हो सकता है, लेकिन यह वैकल्पिक है (यदि यह परिभाषित नहीं है तो कुंजी से खींचना)। यह टूलींग को थोड़ा कठिन बनाता है।
labels और skipReleaseLabels । में एक लेबल labels में भी है कि skipReleaseLabels एक रिलीज को छोड़ देगा। इसलिए यदि आप एक ऐसा दस्तावेज़ीकरण लेबल चाहते हैं जो रिलीज़ नहीं करता है, तो उसे दो स्थानों पर जोड़ने की आवश्यकता है। साथ ही, जब आप major , minor , या patch को skipReleaseLabels अनुभाग में जोड़ते हैं तो क्या होता है? और फिर skip-release लेबल है जो skipReleaseLabels ।
चेंजलॉग टाइटल को लेबल में जोड़ा जा सकता है, लेकिन यह बिल्कुल स्पष्ट नहीं है कि वे किस क्रम में मिसाल लेते हैं। यदि minor और documentation दोनों लेबल मौजूद हैं, तो कौन सा चेंजलॉग शीर्षक मिसाल लेता है?

आप जो समाधान चाहते हैं उसका वर्णन करें

मैं यह प्रस्तावित करना चाहता हूं कि हम लेबल की परिभाषा को बहुत सरल करते हैं और किसी भी कोने के मामलों को स्पष्ट रूप से दस्तावेज करते हैं। यह सिर्फ एक सुझाव है।

{
  labels: [
    {
      name: 'Breaking change',
      releaseType: 'major',
      description: 'A non-backwards compatible change'
      changelogTitle: 'Breaking changes',
      color: '#FFF000'
    },
    {
      name: 'Feature',
      releaseType: 'minor',
      description: 'A new capability'
      changelogTitle: 'Improvements',
      color: '#FAA00A'
    }, 
    {
      name: 'Bug fix',
      releaseType: 'patch',
      description: 'A bug fix'
      changelogTitle: 'Bug fixes',
      color: '#FAA00A'
    },
    {
      name: 'Skip Release',
      releaseType: 'skip',
      description: "Ensures a release doesn't happen",
      // changelog title not valid for skip releases
      // changelogTitle: '',
      color: '#FAA00A'
    },
    {
      name: 'Documentation',
      releaseType: 'none',
      description: 'Used to denote documentation changes',
      changelogTitle: 'Documentation updates',
      color: '#C8C8C8'
    }
  ]
}

तर्क

name और releaseType आवश्यक हैं
releaseType को major | minor | patch | skip | none रूप में परिभाषित किया गया है। इसे और तीन श्रेणियों में घटाया जा सकता है: semver | skip | none ।
किसी एक समय में केवल एक semver लेबल मौजूद हो सकता है।
एक semver लेबल _must_ मौजूद होना चाहिए, जब तक कि कोई none अन्यथा मौजूद न हो।
एक skip लेबल केवल तभी मान्य होता है जब semver लेबल के साथ जोड़ा जाता है और अन्यथा एक नो-ऑप होता है।
एक none प्रकार अपने आप में कोई रिलीज उत्पन्न नहीं करता है, लेकिन एक अतिरिक्त चेंजलॉग प्रविष्टि को शामिल करने के लिए semver लेबल के साथ शामिल किया जा सकता है।
यदि semver लेबल मौजूद है तो none रिलीज रिलीज को छोड़ नहीं देता है।
चैंज के विभिन्न अनुभागों के तहत पीआर को जोड़ने के लिए एकाधिक none लेबल शामिल किए जा सकते हैं
इस प्रस्ताव में मनमाना लेबल जैसी कोई बात नहीं है। शामिल किए गए किसी भी लेबल का रिलीज पर कुछ प्रभाव पड़ता है।

उन विकल्पों का वर्णन करें जिन पर आपने विचार किया है

यह स्वीकार्य रूप से अभी भी जटिल है और निश्चित रूप से अधिक वर्बोज़ है। एक विकल्प (और जो आज हमारे पास है उससे थोड़ा समझौता) semver लेबल को अलग तरीके से व्यवहार करना होगा।

{
  labels: {
    major: "Version: Major",
    minor: {
      name: "Version: Minor",
      changelogTitle: "Bug fixes"
    },
    patch: "Version: Patch",
    other: [
      {
        name: 'Skip release',
        skipRelease: true
      },
      {
        name: 'Documentation',
        changelogTitle: 'Documentation updates'
      }
    ]
  }
}

इस संस्करण में, major , minor , और patch एक समान एपीआई रखते हैं जो उनके पास आज है। हालांकि उन्हें अनिवार्य रूप से विशेष मामलों के रूप में माना जाता है। अन्य सभी लेबल इस other बकेट में जाते हैं (जिसका एक बेहतर नाम हो सकता है)।

इस परिदृश्य में:

एक समय में केवल एक semver उपस्थित हो सकता है
skipRelease: true को other लेबल पर शामिल किया जा सकता है ताकि उन्हें छोड़ दिया जा सके।
changelogTitle को चेंजलॉग प्रविष्टि जोड़ने के लिए other लेबल पर शामिल किया जा सकता है। (फिर से, यह अन्य प्रविष्टियों का दोहराव होगा)।
न तो skipRelease या changelogTitle होने से लेबल एक गैर-ऑप मनमाना लेबल बन जाएगा (जो आज हमारे पास मनमाने लेबल समर्थन को संरक्षित करता है)।

अंतत: मैं अन्य विचारों के लिए खुला हूं। मुझे लगता है कि हमारा वर्तमान दृष्टिकोण अनियंत्रित कोने के मामलों और गोचर्स के साथ काफी प्रचलित है। मैं इसे जितना संभव हो सके समझने में आसान (और कोड करने के लिए) बनाना चाहता हूं।

enhancement major released

स्रोत

zephraph

🚀1 ❤1

सबसे उपयोगी टिप्पणी

यदि आपके पास कोई अतिरिक्त labels या skipReleaseLabels तो आपको नए प्रारूप का उपयोग करने की आवश्यकता होगी

https://intuit.github.io/auto/pages/autorc.html#label -customization

hipstersmoothie 12 दिस॰ 2019

👍2

सभी 17 टिप्पणियाँ

मुझे पहला विकल्प पसंद है। यह बहुत आसान और साफ है, मुझे none और skip बीच के अंतर को अलग करने में परेशानी हो रही है। अगर मैं सही ढंग से समझता हूं कि skip का चैंज पर कोई असर नहीं है और इसे एक सेवर लेबल के साथ होना चाहिए, और none एक रिलीज को छोड़ देगा लेकिन एक अद्वितीय चेंजलॉग प्रविष्टि बनाएगा।

hipstersmoothie 31 अग॰ 2019

इस पद्धति से अधिकांश शॉर्टहैंड से छुटकारा मिल जाता है लेकिन मुझे लगता है कि हम अभी भी कुछ का समर्थन कर सकते हैं?

उदाहरण के लिए निम्नलिखित डिफ़ॉल्ट major लेबल को ओवरराइड करेगा लेकिन विवरण और चेंजलॉगटाइटल को भी इनहेरिट करेगा

{
  labels: [
    {
      name: 'Breaking change',
      releaseType: 'major'
    }
  ]
}

या सिर्फ शीर्षक संपादित करना

{
  labels: [
    {
      releaseType: 'major',
      changelogTitle: 'Super Big Changes'
    }
  ]
}

hipstersmoothie 31 अग॰ 2019

skip रिलीज न करें। none अर्थ है कि लेबल का रिलीज़ पर कोई प्रभाव नहीं है... इसलिए यह अन्य लेबल की उपस्थिति के आधार पर रिलीज़ हो सकता है या रिलीज़ नहीं हो सकता है। इसे एक बेहतर नाम की जरूरत है।

तो आपके सुझाव के तहत, releaseType मौजूद होने के आधार पर लेबल में डिफ़ॉल्ट फ़ॉलबैक होते हैं? मुझे लगता है कि यह समझ में आता है।

zephraph 1 सित॰ 2019

👍1

तो आपके सुझाव के तहत, लेबल में डिफ़ॉल्ट फ़ॉलबैक होते हैं जो इस बात पर आधारित होते हैं कि कौन सा रिलीज़ टाइप मौजूद है? मुझे लगता है कि यह समझ में आता है।

हां

hipstersmoothie 3 सित॰ 2019

@zephraph इसे एक बेहतर नाम की आवश्यकता है।

मुझे लगता है कि यह एक महान है। कहने से बेहतर कुछ नहीं है "यह कोई नहीं है क्योंकि इसका रिलीज प्रक्रिया पर कोई प्रभाव नहीं पड़ता है, उदाहरण के लिए काम/निर्भरता/जो कुछ भी"।

सोचो कि समझ में आता है।

हाँ, बिलकुल।

प्रस्ताव शानदार है।
मुझे लगता है कि name और chagelogTitle दोनों में releaseType आधार पर डिफ़ॉल्ट होना चाहिए।

tunnckoCore 10 सित॰ 2019

मेरे पास अभी इसके लिए एक पीआर अप है। यह निम्नलिखित को संबोधित नहीं करता है

चेंजलॉग टाइटल को लेबल में जोड़ा जा सकता है, लेकिन यह बिल्कुल स्पष्ट नहीं है कि वे किस क्रम में मिसाल लेते हैं। यदि माइनर और डॉक्यूमेंटेशन लेबल दोनों मौजूद हैं, तो कौन सा चेंजलॉग टाइटल मिसाल लेता है?
Logic यहां वर्णित अधिकांश सत्यापन शायद ऑटोबोट में रहना चाहिए। मुझे नहीं लगता कि ऑटो को ही इसे मजबूर करना चाहिए
(से संबंधित 1) > चेंजलॉग के विभिन्न अनुभागों के तहत पीआर को जोड़ने के लिए एकाधिक कोई भी लेबल शामिल नहीं किया जा सकता है

hipstersmoothie 5 दिस॰ 2019

👍1

मुझे समझ नहीं आया। कैसे _"एक स्किप लेबल केवल तभी मान्य होता है जब एक सेवर लेबल के साथ जोड़ा जाता है और अन्यथा एक नो-ऑप होता है।"_ समझ में आता है? अगर मेरे पास deps लेबल या infra , तो टाइप skip और मैं रिलीज करना छोड़ना चाहता हूं कि मुझे सेवर लेबल भी जोड़ने की आवश्यकता क्यों है? मुझे लगता है कि मुझे तब none उपयोग करना चाहिए, लेकिन यह सेवर लेबल को भी जोड़ने की अनुमति देता है, इसलिए... वाट ?! :डी

वर्तमान में मेरे पास है

    "skipReleaseLabels": [
      "documentation",
      "skip-release",
      "devDeps",
      "infra"
    ],
    "labels": {
      "deps": {
        "name": "deps",
        "title": "🔩 Dependency Updates"
      },
      "devDeps": {
        "name": "devDeps",
        "title": "🔩 Dependency Updates"
      },
      "documentation": {
        "name": "documentation",
        "title": "🗒️ Documentation"
      },
      "core": {
        "name": "core",
        "title": "📦 Core"
      }
    },

और मैं डॉक्स, स्किप-रिलीज़, डेवडिप्स और इंफ़्रा को छोड़ना चाहता हूं, लेकिन उदाहरण के लिए deps को छोड़ना नहीं चाहता। क्योंकि मैं नवीनीकरण का उपयोग कर रहा हूं और fix(deps) पर पैच रिलीज चाहता हूं।

मेरे पास वैसे भी onlyPublishWithReleaseLabel सक्षम है, इसलिए यह मेरे लिए कोई बड़ी समस्या नहीं होगी।

और एक और बात, changelogTitle next डिस्ट-टैग पर है? मैं सिर्फ स्पष्टीकरण मांग रहा हूं, क्योंकि यह पीआर में नहीं दिखाया गया है।

tunnckoCore 6 दिस॰ 2019

@tunnkoCore मुझे लगता है कि आप सेटअप इस तरह नए तरीके से दिखाई देंगे:

{
  "labels": [
    {
      "name": "deps",
      "title": "🔩 Dependency Updates",
      // when deps are merged create a patch release
      "releaseType": "patch"
    },
    {
      "name": "devDeps",
      "title": "🔩 Dependency Updates",
      "releaseType": "none"
    },
    {
      "name": "documentation",
      "title": "🗒️ Documentation",
      "releaseType": "none"
    },
    {
      "name": "core",
      "title": "📦 Core",
      "releaseType": "patch"
    }
  ]
}

कोई भी प्रभावी रूप से skip रूप में कार्य नहीं करता है। लेकिन अगर आप वास्तव में एक को रिहा करने की जरूरत devDep आप जोड़ सकते अद्यतन patch और एक रिलीज किया जाएगा। यह एक skip लेबल जोड़ने से अलग है, जो अन्य लेबलों की परवाह किए बिना रिलीज़ को छोड़ देगा।

चेंजलॉगशीर्षक

मैंने यह भी नहीं किया है। यह अभी भी सिर्फ शीर्षक है। मैं इसे रिफैक्टर के लिए अपने पीआर में जोड़ूंगा (अभी भी अगले पर नहीं। मैं इसे चेंजलॉगटाइटल के बाद निकाल दूंगा)

hipstersmoothie 7 दिस॰ 2019

👍1

सही। ठीक है बढ़िया :)

मुद्दा v8.0.0-next.8 . में जारी किया गया था

क्या अभी हो रहा है? मैं अनुमान लगा रहा हूँ कि prerelease s next पर प्रकाशित होते हैं? : सोच: वैसे भी, मैं जल्दी में नहीं हूँ। अभी भी यार्न v2+pnp और बिल्डिंग/बंडलिंग के साथ लड़ रहे हैं।

संपादित करें: और लापता title/changelogTitle अभी भी इसका तात्पर्य है कि यह रिलीज नोट्स में कोई अनुभाग नहीं बनायेगा?

tunnckoCore 7 दिस॰ 2019

@tunnkoCore आपके द्वारा जारी किए जा रहे संस्करण के आधार पर चैंज शीर्षक पर चूक है।

zephraph 7 दिस॰ 2019

मैं अन्य "कस्टम लेबल" के बारे में पूछ रहा हूं जो हम कॉन्फ़िगरेशन से जोड़ते हैं और जो सेवर के बारे में नहीं हैं। अगर मेरे पास शीर्षक के बिना infra लेबल है तो इसे जोड़ा नहीं जाएगा, है ना? और जब मेरे पास शीर्षक होगा (जैसे devDeps में) तो इसे जोड़ा जाएगा।

tunnckoCore 7 दिस॰ 2019

:रॉकेट: मुद्दा v8.0.0 में जारी किया गया था: रॉकेट:

adierkens 12 दिस॰ 2019

@adierkens , ऐसा लगता है कि यह मुद्दा v8 प्रमुख संशोधन के पीछे प्रमुख प्रोत्साहन था, इसलिए मैं यह प्रश्न यहां पूछ रहा हूं ... क्या कुछ विशेष है जो मुझे v7.x से v8 में अपग्रेड करने के लिए करने की आवश्यकता है?

jrnail23 12 दिस॰ 2019

👍1

https://intuit.github.io/auto/pages/autorc.html#label -customization

hipstersmoothie 12 दिस॰ 2019

👍2

वूहू! :tada: मैं इसे सप्ताहांत में कोशिश करूँगा।

tunnckoCore 13 दिस॰ 2019

सबसे पहले, v8 के लिए अच्छे बदलाव!

के बारे में

चेंजलॉग टाइटल को लेबल में जोड़ा जा सकता है, लेकिन यह बिल्कुल स्पष्ट नहीं है कि वे किस क्रम में मिसाल लेते हैं। यदि माइनर और डॉक्यूमेंटेशन लेबल दोनों मौजूद हैं, तो कौन सा चेंजलॉग टाइटल मिसाल लेता है?

स्थानीय परीक्षण से, ऐसा लगता है कि वर्तमान व्यवहार है:

releaseType ( major , minor , patch प्राथमिकता क्रम में सत्य changelogTitle साथ पहले लेबल को दिए गए पीआर को असाइन करें, फिर अन्य सभी)
यदि पीआर में उपरोक्त समान releaseType प्राथमिकता से जुड़े कई लेबल हैं, तो पीआर को पहले कॉन्फ़िगरेशन में परिभाषित लेबल के अनुभाग में शामिल किया गया है (डिफ़ॉल्ट लेबल अन्य सभी से पहले हैं)

नीचे कुछ उदाहरण दिए गए हैं:

(1): मामूली और कोई लेबल नहीं
विन्यास:

"labels": [
  { "name": "typescript", "changelogTitle": "Typescript Change", "releaseType": "none" },
  { "name": "minor", "changelogTitle": "Enhancement", "releaseType": "minor" }
]

पीआर पर लेबल:

minor

चैंज लेबल अनुभाग: minor

क्योंकि minor releaseType की प्राथमिकता अधिक है

(2): एकाधिक पैच लेबल
विन्यास:

"labels": [
  { "name": "typescript", "changelogTitle": "Typescript Change", "releaseType": "patch" },
  { "name": "core", "changelogTitle": "Core Change", "releaseType": "patch" }
]

पीआर पर लेबल:

core

चैंज लेबल अनुभाग: typescript

क्योंकि typescript लेबल कॉन्फ़िगरेशन में core से पहले दिखाई देता है

(3): कोई भी लेबल नहीं और डिफ़ॉल्ट कोई भी लेबल नहीं
विन्यास:

"labels": [
  { "name": "typescript", "changelogTitle": "Typescript Change", "releaseType": "none" }
]

पीआर पर लेबल:

internal

चैंज लेबल अनुभाग: internal

क्योंकि internal लेबल typescript से पहले कॉन्फ़िगरेशन में दिखाई देता है (यह डिफ़ॉल्ट कॉन्फ़िगरेशन में दिखाई देता है जो उसी releaseType बीच उच्चतम प्राथमिकता लेता है

@hipsstersmoothie , क्या उपरोक्त व्यवहार/वरीयता क्रम का इरादा है?

यदि ऐसा है, तो दस्तावेज़ीकरण में जोड़ना अच्छा होगा, इसलिए यह स्पष्ट है कि चेंजलॉग लेबल अनुभाग कैसे उत्पन्न होते हैं और अनुभागों को कैसे प्राथमिकता दी जाती है (यदि आवश्यक हो तो मैं इसमें मदद कर सकता हूं)

यदि नहीं, तो क्या हम इस मुद्दे के हिस्से के रूप में या किसी अन्य के रूप में एक पूर्वता आदेश को परिभाषित करने के लिए काम कर सकते हैं?

bnigh 16 दिस॰ 2019

मैं इसे कुछ खास या गलत नहीं देखता। यह काफी सहज लगता है। केवल महत्वपूर्ण बात यह है कि major , minor और patch हमेशा चेंजलॉग में पहले स्थान पर रहें, सिर्फ इसलिए कि यह एक तरह की मानक चीज है। लेकिन भले ही आदेश विन्यास योग्य हो, यह भी ठीक है।

tunnckoCore 16 दिस॰ 2019

क्या यह पृष्ठ उपयोगी था?

0 / 5 - 0 रेटिंग्स

Auto: [आरएफसी] लेबल विन्यास को सरल बनाएं

सबसे उपयोगी टिप्पणी

सभी 17 टिप्पणियाँ

संबंधित मुद्दों