obsidianmd / obsidianmd/obsidian-sample-plugin

Version number for tags and releases

Open
#97 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
4.5k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Following the instructions in the README, if we run
yarn version [major | minor | patch

Yarn will do a number of things, including create a git tag with the next version, but that tag will be of the form V# (e.g., v1.0.0)

But README also states to not include prefix 'v' in the tag version.

Instead I propose that the commands instructions should be

# make sure to rebuild main.js
yarn build 
# make sure to update minAppVersion (min Obsidian version) in manifest.json to whatever is required
# bumps package.json, versions.json, manifest.json (note that yarn has an internal version scrip that runs before the version script in package.json)
yarn version --new-version [major | minor | patch] --no-git-tag-version
git tag <version_num, no V!>
git push origin <version_num>
# use gh cli, or go to github to create a release
gh release create <version_num> manifest.json main.js <any other files> --title "Version <version_num>" --notes "<Version Note>"

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the versioning and release instructions in README. Compare the documented tag format with the behavior of yarn version and the proposed commands, then update the instructions so the version format and release steps are consistent. Done means the README no longer contradicts itself about the v prefix and clearly shows the intended tag and release workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github
Domain
documentation, release
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.