-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add version bumping instruction for README #158
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instructions and everything look really good! Thanks for adding this.
Just a few suggestions on the language and ordering of references:
5. `cd ..` and update `CHANGELOG.md` | ||
6. Create a PR from the changes targeting `main` branch | ||
|
||
*You can take [this PR](https://github.com/tumblr/kanvas-ios/pull/151) as an example.* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
*You can take [this PR](https://github.com/tumblr/kanvas-ios/pull/151) as an example.* | |
*Reference [this PR](https://github.com/tumblr/kanvas-ios/pull/151) as an example.* |
|
||
### Version naming rules | ||
|
||
(I suggest applying `Semantic Versioning` [technique](https://www.kodeco.com/7076593-cocoapods-tutorial-for-swift-getting-started#toc-anchor-008) from [Kodeco](https://www.kodeco.com/). Beside, [semver](https://semver.org/) should be worthing checking out.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove the first person here and just state that we're following Semver.
(I suggest applying `Semantic Versioning` [technique](https://www.kodeco.com/7076593-cocoapods-tutorial-for-swift-getting-started#toc-anchor-008) from [Kodeco](https://www.kodeco.com/). Beside, [semver](https://semver.org/) should be worthing checking out.) | |
We follow the [`Semantic Versioning` (semver) specification](https://semver.org/). You can find more Swift and Cocoapods specific details in [this tutorial](https://www.kodeco.com/7076593-cocoapods-tutorial-for-swift-getting-started#toc-anchor-008).``` |
2. Upgrade `spec.version`, please refer `Version naming rules` section below. | ||
3. `cd Example` | ||
4. Run `pod install` | ||
5. `cd ..` and update `CHANGELOG.md` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔍 Can we add a bit more detail to this step? I believe they have to put any of the unreleased change notes under the current version and check the recent PRs for any merges that have gone in since the last version that haven't made it on to the unreleased section of the change log.
Thanks for this btw, I'm literally reading it for my own upgrade. Don't wait for an approval from me. I agree with @bjtitus's comments and mine is just a bit that is just a suggestion. |
|
||
1. Open `Kanvas.podspec` | ||
2. Upgrade `spec.version`, please refer `Version naming rules` section below. | ||
3. `cd Example` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️ Nice job including this. Personally I forget this a lot and end up not knowing what's gone wrong 😅
Can we also include drafting a new release on github as an additional step? |
Add an instruction of how to to bump version for the project