Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 10.2 KB

DEVELOPER-ENVIRONMENT.md

File metadata and controls

33 lines (20 loc) · 10.2 KB

Developer environment notes (മലയാളം)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇧🇦 bs · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW


OmniRoute വികസിപ്പിക്കുമ്പോൾ പ്രോജക്റ്റിന്റെ ലോക്കൽ .env പ്രവർത്തനരീതിയും എൻവയോൺമെന്റ് ഫയലുകളും രഹസ്യങ്ങളും എങ്ങനെ കൈകാര്യം ചെയ്യണമെന്നതും ഈ പേജ് വിശദീകരിക്കുന്നു.

.env postinstall പ്രവർത്തനരീതി

ഡെവലപ്പർമാരുടെ സൗകര്യത്തിനായി npm install / postinstall സമയത്ത് പ്രോജക്റ്റ് ഒരു ലോക്കൽ .env ഫയൽ സൃഷ്ടിച്ചേക്കാം. ഈ ഫയൽ ലോക്കൽ ഡെവലപ്മെന്റിനും പരിശോധനയ്ക്കും മാത്രമുള്ളതാണ്; ഇത് ഒരിക്കലും വേർഷൻ കൺട്രോളിൽ കമ്മിറ്റ് ചെയ്യരുത്.

പ്രധാന കാര്യങ്ങൾ:

  • റിപ്പോസിറ്ററിയിലെ .gitignore ഇതിനകം തന്നെ .env* ഫയലുകളെ അവഗണിക്കുന്നു (.gitignore എൻട്രി കാണുക). ഒരു നിർദിഷ്ട ഉദാഹരണ ഫയൽ കമ്മിറ്റ് ചെയ്യാൻ നിങ്ങൾ ബോധപൂർവം ഉദ്ദേശിക്കുകയും അതിനായി രേഖപ്പെടുത്തിയ ഒരു പ്രക്രിയ ഉണ്ടായിരിക്കുകയും ചെയ്യുന്നില്ലെങ്കിൽ, ആ നിയമം നീക്കം ചെയ്യുകയോ മാറ്റുകയോ ചെയ്യരുത്.
  • ഒരു യഥാർഥ രഹസ്യം അബദ്ധത്തിൽ റിപ്പോയിലേക്ക് കമ്മിറ്റ് ചെയ്താൽ, ക്രെഡൻഷ്യൽ ഉടൻ റൊട്ടേറ്റ് ചെയ്യുകയോ റിവോക്ക് ചെയ്യുകയോ ചെയ്യുക; കൂടാതെ അത് റിപ്പോസിറ്ററി ചരിത്രത്തിൽനിന്ന് നീക്കം ചെയ്യുക (ഉദാഹരണത്തിന്, git filter-repo അല്ലെങ്കിൽ സമാനമായ പരിഹാര വർക്ക്ഫ്ലോ ഉപയോഗിച്ച്). സഹായം ആവശ്യമെങ്കിൽ സുരക്ഷാ/കോൺടാക്റ്റ് ഉടമയെ ബന്ധപ്പെടുക.
  • CI-യ്ക്കും പ്രൊഡക്ഷനും വേണ്ടി, രഹസ്യങ്ങൾ ഫയലുകളിലേക്ക് കമ്മിറ്റ് ചെയ്യുന്നതിനുപകരം CI സീക്രെറ്റുകളോ സീക്രെറ്റ്സ് മാനേജറോ (GitHub Actions Secrets, Azure Key Vault, HashiCorp Vault മുതലായവ) ഉപയോഗിക്കുക.

ശുപാർശ ചെയ്യുന്ന ലോക്കൽ വർക്ക്ഫ്ലോ

  • .env നിങ്ങളുടെ ലോക്കൽ വർക്ക്സ്പേസിൽ മാത്രം സൂക്ഷിക്കുക. ആവശ്യമായ വേരിയബിളുകളും സ്വീകാര്യമായ ഉദാഹരണ മൂല്യങ്ങളും രേഖപ്പെടുത്താൻ .env.example (ഇതിനകം ട്രാക്ക് ചെയ്തിരിക്കുന്നത്) ഉപയോഗിക്കുക.
  • രഹസ്യങ്ങളോട് സാമ്യമുള്ള മൂല്യങ്ങൾ ആവശ്യമായ ടെസ്റ്റുകൾ ലോക്കലായി പ്രവർത്തിപ്പിക്കുമ്പോൾ, യഥാർഥ ക്രെഡൻഷ്യലുകൾക്കുപകരം സിന്തറ്റിക് പ്ലേസ്ഹോൾഡറുകളോ റൺടൈമിൽ സൃഷ്ടിക്കുന്ന താൽക്കാലിക കീകളോ ഉപയോഗിക്കുക.
  • പ്ലേസ്ഹോൾഡറുകൾ ഉപയോഗിക്കുന്ന ടെസ്റ്റുകളിൽ, ഫിക്ചർ സിന്തറ്റിക് ആണെന്ന് റിവ്യൂവർമാർക്ക് മനസ്സിലാകുന്നതിനായി ഒരു ചെറിയ കമന്റ് ചേർക്കുക.

സ്കാനറിനെക്കുറിച്ചുള്ള കുറിപ്പുകൾ

  • കംപൈൽ ചെയ്തതോ ബൈനറിയായതോ ആയ ചില അസറ്റുകളിൽ (ഉദാ., ഉൾച്ചേർത്ത base64 WASM ബ്ലോബുകൾ) ക്രെഡൻഷ്യലുകളായി തോന്നുന്ന ASCII സബ്സ്ട്രിങ്ങുകൾ ഉണ്ടായേക്കാം; അവ ടെക്സ്റ്റ് അധിഷ്ഠിത സീക്രെറ്റ് സ്കാനറുകളെ ട്രിഗർ ചെയ്തേക്കാം. ഈ അസറ്റുകൾ സാധുതയുള്ളവയാണെങ്കിൽ, അവയെ സ്കാനറിന്റെ അലൗലിസ്റ്റിൽ അടയാളപ്പെടുത്തുക അല്ലെങ്കിൽ സ്കാനർ കോൺഫിഗിൽ ബന്ധപ്പെട്ട ഡയറക്ടറികളെ ഒഴിവാക്കുക.

ഒരു ചോർച്ച കണ്ടെത്തിയാൽ

  1. കീ ഉടൻ റൊട്ടേറ്റ് ചെയ്യുകയോ റിവോക്ക് ചെയ്യുകയോ ചെയ്യുക.
  2. ചരിത്രത്തിൽനിന്ന് രഹസ്യം നീക്കം ചെയ്യുക; ആവശ്യമെങ്കിൽ ശുദ്ധീകരിച്ച ബ്രാഞ്ച് ഫോഴ്സ്-പുഷ് ചെയ്യുക.
  3. മെയിന്റെയ്നർമാരെ അറിയിക്കുകയും നിങ്ങളുടെ സ്ഥാപനത്തിന്റെ ഇൻസിഡന്റ് റെസ്പോൺസ് ചെക്ക്ലിസ്റ്റ് പിന്തുടരുകയും ചെയ്യുക.