Prerequisites

• A GitHub repository
• Git installed: https://git-scm.com/
• For CLI: GitHub CLI (gh): https://cli.github.com/

Login with:

gh auth login

UI Method (Web)

Step 1: Commit and push

git add .
git commit -m "feat: add new feature"
git push origin main

Step 2: Create and push a tag

git tag v1.2.3
git push origin v1.2.3

Step 3: Create Release on GitHub

1. Go to your repo → find Releases in the sidebar
2. Click Create a new release
3. Fill in Tag version, Release title, Description
4. Click Publish release

CLI Method

Step 1–2: Same as above (commit, tag, push)

Step 3: Create release via CLI

gh release create v1.2.3 \
  --title "v1.2.3" \
  --notes "### Bug Fixes\n- Fix JSON special character handling (#2481)"

Or use a Markdown file:

gh release create v1.2.3 \
  --title "v1.2.3" \
  --notes-file CHANGELOG.md

Useful Commands

# Delete a release
gh release delete v1.2.3

# Delete a remote tag
git tag -d v1.2.3
git push origin :refs/tags/v1.2.3

Stage all changes at once

git add .

. means add all modified or new files.

Correct commit message format (to avoid commitlint errors)

git commit -m "feat: update about page and fix broken icons"

Commit message must follow the format type: message, otherwise commitlint or husky will block the commit.

Push to GitHub

git push origin main

Errors I Encountered

YAML syntax error

could not find expected ':' while scanning a simple key

Fix: Open the .yml file in VS Code, check indentation, colons, and quotes — especially in locale files like en.yml.

Local Jekyll Testing

bundle exec jekyll serve

Preview at http://localhost:4000. YAML errors will prevent startup — fix and restart.

Quick Tips

• Use git status before committing to see what changed
• If stuck on commit format, --no-verify ignores checks (not recommended long-term)