ਚੇਂਜਲੌਗ ਜਨਰੇਟਰ

ਵਰਜਨ ਦੁਆਰਾ ਸੰਗਠਿਤ Git ਕਮਿਟਾਂ ਤੋਂ ਢਾਂਚਾਗਤ ਰੀਲੀਜ਼ ਨੋਟਸ ਅਤੇ CHANGELOG.md ਫਾਈਲਾਂ ਤਿਆਰ ਕਰੋ।

0 Conventional Commits ਪਾਰਸ ਕੀਤੇ

ਚੇਂਜਲੌਗ ਜਨਰੇਟਰ ਬਾਰੇ — ਵਿਸਤ੍ਰਿਤ ਗਾਈਡ

ਸ਼੍ਰੇਣੀ: DevOps ਅਤੇ ਮਿਆਰ 100% ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ ਲੋਕਲ

Changelog Generator ਕੱਚੇ Git ਕਮਿਟ ਲੌਗਸ ਨੂੰ ਪਾਰਸ ਕਰਦਾ ਹੈ ਅਤੇ ਉਹਨਾਂ ਨੂੰ ਮਿਆਰੀ, ਰੀਲੀਜ਼ ਲਈ ਤਿਆਰ `CHANGELOG.md` ਦਸਤਾਵੇਜ਼ਾਂ ਵਿੱਚ ਫਾਰਮੈਟ ਕਰਦਾ ਹੈ। ਇਹ Conventional Commits ਸੰਟੈਕਸ ਦੇ ਨਾਲ-ਨਾਲ ਮਿਆਰੀ ਕਮਿਟ ਸੁਨੇਹਿਆਂ ਨੂੰ ਸਮਝਦਾ ਹੈ।

ਕਮਿਟਾਂ ਨੂੰ ਢਾਂਚਾਗਤ ਸ਼੍ਰੇਣੀਆਂ ਵਿੱਚ ਵੰਡਿਆ ਗਿਆ ਹੈ: Features, Bug Fixes, Performance Improvements, Documentation, ਅਤੇ Refactoring। ਇੱਕ-ਕਲਿੱਕ Markdown ਨਿਰਯਾਤ ਲਈ ਮਰਜ ਕਮਿਟਾਂ ਨੂੰ ਫਿਲਟਰ ਕਰਦੇ ਹੋਏ, ਰੀਲੀਜ਼ ਸੰਸਕਰਣ ਟੈਗ ਅਤੇ ਮਿਤੀਆਂ ਕੌਂਫਿਗਰ ਕਰੋ।

#changelog #git #release #version #history

ਮੁੱਖ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਅਤੇ ਸਮਰੱਥਾਵਾਂ

  • ਨੇਟਿਵ `git log --oneline` ਟਰਮੀਨਲ ਕਮਾਂਡਾਂ ਤੋਂ ਆਊਟਪੁੱਟ ਨੂੰ ਸਿੱਧਾ ਪਾਰਸ ਕਰਦਾ ਹੈ
  • Conventional Commit ਕਿਸਮਾਂ (feat, fix, perf, docs) ਦੁਆਰਾ ਕਮਿਟ ਐਂਟਰੀਆਂ ਨੂੰ ਆਪਣੇ ਆਪ ਸ਼੍ਰੇਣੀਬੱਧ ਕਰਦਾ ਹੈ
  • Keep a Changelog ਮਿਆਰਾਂ ਦੀ ਪਾਲਣਾ ਕਰਦੇ ਹੋਏ ਸੰਰਚਨਾਯੋਗ ਰੀਲੀਜ਼ ਸੰਸਕਰਣ ਟੈਗ ਅਤੇ ਮਿਤੀ ਬੈਨਰ
  • ਬੇਲੋੜੇ ਮਰਜ ਕਮਿਟਾਂ ਨੂੰ ਬਾਹਰ ਫਿਲਟਰ ਕਰਦਾ ਹੈ ਅਤੇ ਸਾਫ਼, ਕਾਪੀ-ਪੇਸਟ ਕਰਨ ਯੋਗ Markdown ਆਊਟਪੁੱਟ ਕਰਦਾ ਹੈ

ਵਰਤੋਂ ਕਿਵੇਂ ਕਰੀਏ

  1. 1

    ਆਪਣੇ ਰਿਪੋਜ਼ਟਰੀ ਟਰਮੀਨਲ ਵਿੱਚ `git log --oneline` ਚਲਾਓ ਅਤੇ ਲੌਗਸ ਨੂੰ ਇਨਪੁੱਟ ਖੇਤਰ ਵਿੱਚ ਪੇਸਟ ਕਰੋ।

  2. 2

    ਆਪਣਾ ਨਿਸ਼ਾਨਾ ਰੀਲੀਜ਼ ਸੰਸਕਰਣ (ਉਦਾਹਰਨ ਵਜੋਂ `v1.2.0`) ਦਰਜ ਕਰੋ ਅਤੇ ਇੱਕ ਰੀਲੀਜ਼ ਮਿਤੀ ਚੁਣੋ।

  3. 3

    ਸ਼੍ਰੇਣੀਬੱਧ ਰੀਲੀਜ਼ ਨੋਟਸ ਦੀ ਸਮੀਖਿਆ ਕਰੋ ਅਤੇ Copy 'ਤੇ ਕਲਿੱਕ ਕਰੋ ਜਾਂ `CHANGELOG.md` ਡਾਊਨਲੋਡ ਕਰੋ।

ਆਮ ਵਰਤੋਂ ਦੇ ਮਾਮਲੇ

  • → ਉਤਪਾਦਨ ਅੱਪਡੇਟ ਤੈਨਾਤ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ GitHub Releases ਲਈ ਰੀਲੀਜ਼ ਨੋਟਸ ਇਕੱਠੇ ਕਰਨਾ
  • → ਓਪਨ-ਸੋਰਸ ਰਿਪੋਜ਼ਟਰੀਆਂ ਲਈ ਇੱਕ ਕੇਂਦਰੀਕ੍ਰਿਤ, ਇਤਿਹਾਸਕ CHANGELOG.md ਫਾਈਲ ਨੂੰ ਕਾਇਮ ਰੱਖਣਾ
  • → ਉਤਪਾਦ ਦੇ ਹਿੱਸੇਦਾਰਾਂ (stakeholders) ਲਈ ਗੁੰਝਲਦਾਰ ਤਕਨੀਕੀ ਕਮਿਟਾਂ ਨੂੰ ਪੜ੍ਹਨਯੋਗ ਚੇਂਜਲੌਗਾਂ ਵਿੱਚ ਅਨੁਵਾਦ ਕਰਨਾ

ਸਬੰਧਤ ਟੂਲ

SEO ਅਤੇ ਸੋਸ਼ਲ ਮੈਟਾ ਟੈਗ ਜਨਰੇਟਰ

ਖੋਜ ਇੰਜਣਾਂ ਅਤੇ ਸੋਸ਼ਲ ਨੈੱਟਵਰਕਾਂ ਲਈ Open Graph, Twitter Cards ਅਤੇ ਜ਼ਰੂਰੀ SEO ਮੈਟਾ ਟੈਗ ਤਿਆਰ ਕਰੋ।

.gitignore ਫਾਈਲ ਜਨਰੇਟਰ

Node.js, Python, Java, Go, Rust, macOS, Windows ਅਤੇ ਦਰਜਨਾਂ ਵਾਤਾਵਰਣਾਂ ਲਈ .gitignore ਫਾਈਲਾਂ ਤਿਆਰ ਕਰੋ।

ਓਪਨ ਸੋਰਸ ਲਾਇਸੈਂਸ ਜਨਰੇਟਰ

ਆਪਣੇ ਨਾਮ ਅਤੇ ਸਾਲ ਨਾਲ ਮਿਆਰੀ ਓਪਨ ਸੋਰਸ ਲਾਇਸੈਂਸ (MIT, Apache 2.0, GPL v3, BSD) ਤਿਆਰ ਕਰੋ।

README.md ਫਾਈਲ ਜਨਰੇਟਰ

ਬੈਜ, ਸਥਾਪਨਾ ਨਿਰਦੇਸ਼ਾਂ ਅਤੇ ਸੈਕਸ਼ਨਾਂ ਦੇ ਨਾਲ GitHub ਪ੍ਰੋਜੈਕਟਾਂ ਲਈ ਪੇਸ਼ੇਵਰ README ਦਸਤਾਵੇਜ਼ ਬਣਾਓ।

Conventional Commits ਸਹਾਇਕ

Conventional Commits ਨਿਯਮਾਂ (feat, fix, chore, docs, ਆਦਿ) ਦੀ ਪਾਲਣਾ ਕਰਦੇ ਹੋਏ ਮਿਆਰੀ ਗਿਟ ਕਮਿਟ ਸੰਦੇਸ਼ ਬਣਾਓ।

SemVer ਕੈਲਕੁਲੇਟਰ ਅਤੇ ਤੁਲਨਾਕਾਰ

ਸਿਮੈਂਟਿਕ ਵਰਜ਼ਨ (SemVer) ਦੀ ਪੁਸ਼ਟੀ ਕਰੋ, ਵਰਜਨਾਂ ਦੀ ਤੁਲਨਾ ਕਰੋ ਅਤੇ ਅਗਲੇ ਵਰਜਨ ਵਾਧੇ (major, minor, patch) ਦੀ ਗਣਨਾ ਕਰੋ।

ਅਕਸਰ ਪੁੱਛੇ ਜਾਣ ਵਾਲੇ ਸਵਾਲ ਅਤੇ ਪਰਦੇਦਾਰੀ

ਮੈਂ ਆਖਰੀ ਰੀਲੀਜ਼ ਟੈਗ ਤੋਂ ਬਾਅਦ ਦੇ ਕਮਿਟ ਕਿਵੇਂ ਪ੍ਰਾਪਤ ਕਰ ਸਕਦਾ ਹਾਂ?

ਪਿਛਲੀ ਰੀਲੀਜ਼ ਤੋਂ ਬਾਅਦ ਕੀਤੇ ਗਏ ਕਮਿਟਾਂ ਨੂੰ ਵੱਖ ਕਰਨ ਲਈ ਆਪਣੇ ਟਰਮੀਨਲ ਵਿੱਚ `git log <previous-tag>..HEAD --oneline` ਚਲਾਓ।

ਗੈਰ-ਰਵਾਇਤੀ (non-conventional) ਕਮਿਟਾਂ ਨੂੰ ਕਿਵੇਂ ਸ਼੍ਰੇਣੀਬੱਧ ਕੀਤਾ ਜਾਂਦਾ ਹੈ?

ਰਵਾਇਤੀ ਅਗੇਤਰਾਂ ਤੋਂ ਬਿਨਾਂ ਕਮਿਟਾਂ ਨੂੰ ਇੱਕ "Other Changes" ਭਾਗ ਅਧੀਨ ਸਮੂਹਬੱਧ ਕੀਤਾ ਜਾਂਦਾ ਹੈ, ਇਹ ਯਕੀਨੀ ਬਣਾਉਂਦੇ ਹੋਏ ਕਿ ਕੋਈ ਵੀ ਕਮਿਟ ਜਾਣਕਾਰੀ ਨਾ ਛੁੱਟੇ।