Skip to content

Partial updates / add missing versions #209

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

Closed
estahn opened this issue Mar 25, 2015 · 3 comments
Closed

Partial updates / add missing versions #209

estahn opened this issue Mar 25, 2015 · 3 comments

Comments

@estahn
Copy link
Contributor

estahn commented Mar 25, 2015

It would be great if the generator doesn't replace the entire file but just adds missing versions and ignores existing ones. We have some manual added information which we don't want to lose when generating the changelog.

Features:

  • Ability to keep manual added information for older version tags
  • Reduced GitHub API calls due to reduce amount of data necessary to retrieve
  • Stop/continue a changelog generation process due to partial updates

Implementation:
The CHANGELOG.md needs to be parsed and divided into sections which represent the versions, e.g.

[{ :version => 'v0.0.1', :content => '...' }, { :version => 'v1.0.0', :content => '...' }, ...]

Missing versions can be fetched from the GitHub API and appended.

This might be related to #172.

@skywinder
Copy link
Member

@estahn thanks for feature request! It would be a great addition 💥 , but it has a lot of work to implement this.

It can be splitted for a several little sub-tasks:

  1. First part: Generate change log between 2 specific tags #172 is already implemented. I will release it soon.
  2. The similar feature to help with partial updates: fetch since/due specific date Generate change log since/due specific date #210
  3. The next step is a parsing of existing Change log file. Parsing of existing Change Log file #212
  4. Another thing will be implement partial update of the CHANGELOG.md. i.e. fetch only specific issues (between specific tags, or between time) and not modify others. Fetch missing versions and amend them to existing change log #211
  5. And finally: Ability to keep manual added information for older version tags Ability to keep manual added changelog information #213

@skywinder
Copy link
Member

@estahn I created special repo to test, how generator works.
https://github.com/skywinder/changelog_test
Feel free to modify it to test new features.

@skywinder
Copy link
Member

This issue has been closed as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
Feel free to leave a comment below, if it's still actual.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants