Skip to content
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

Update version release documentation #983

Closed
DawoudSheraz opened this issue Jan 16, 2024 · 0 comments · Fixed by #991
Closed

Update version release documentation #983

DawoudSheraz opened this issue Jan 16, 2024 · 0 comments · Fixed by #991
Assignees
Labels
documentation In order to close this issue, some documentation should be improved

Comments

@DawoudSheraz
Copy link
Contributor

In Tutor docs about releasing a new version https://docs.tutor.edly.io/tutor.html#releasing-a-new-version, the steps mentioned focus on updating version, adding changelog, and committing the change to upstream. These steps are a little outdated and need to be updated. In practice, the version upgrade happens in two phases:

  1. Add changes and generate individual changelog
  2. Update version and compile changelogs

Add changes and generate individual changelog
run make changelog-entry command - It will create changelog entries in a folder named changelog.d .
Commit and merge all the changes. e.g this commit.

Update version and compile changelogs
run make changelog command - It will delete all previous changelog entries from changelog.d folder and will add records of those entries to CHANGELOG.md file. The version is bumped in this commit.
merge your commit.
e.g. this commit.

@DawoudSheraz DawoudSheraz added the documentation In order to close this issue, some documentation should be improved label Jan 16, 2024
Faraz32123 pushed a commit to edly-io/tutor that referenced this issue Jan 23, 2024
Faraz32123 pushed a commit to edly-io/tutor that referenced this issue Jan 23, 2024
regisb pushed a commit that referenced this issue Jan 23, 2024
close #983

---------

Co-authored-by: Muhammad Faraz  Maqsood <faraz.maqsood@a006-01130.home>
kdmccormick pushed a commit to kdmccormick/tutor that referenced this issue Feb 8, 2024
close overhangio#983

---------

Co-authored-by: Muhammad Faraz  Maqsood <faraz.maqsood@a006-01130.home>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation In order to close this issue, some documentation should be improved
Projects
Development

Successfully merging a pull request may close this issue.

2 participants