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

Autogenerating CHANGELOG.md capability #23

Closed
7 tasks done
apolopena opened this issue Feb 4, 2021 · 0 comments
Closed
7 tasks done

Autogenerating CHANGELOG.md capability #23

apolopena opened this issue Feb 4, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request gitpod-config Related to gitpod configuration (bash scripts etc...) passed-dev-qa Optional state. Use this when QAing other peoples fixes in another branch.ready to be merged to main

Comments

@apolopena
Copy link
Owner

apolopena commented Feb 4, 2021

Problem this feature will solve

There is no CHANGELOG.md. Creating a Changelog by hand is hard to standardize and maintain and is time consuming especially when new releases come out quicky.

Background

Versioning a project with a detailed, neat and, standardized changelog is an important task. This process is time consuming to do by hand. Tracking changes for releases all one one tidy page is a must have for a well organized project.

Proposed Solution

  • Implement github-changelog-generator
  • Make the ruby gem install for this silent and quick (omit doc generation) but display a spinner in the terminal.
  • Add a rake task for generating CHANGELOG.md without having to pass it any flags, simply run: rake changelog
  • The rake task should accept for any flags that github-changelog-generator supports.
  • Add a dynamic system to create rake tasks based on starter.ini and gitpod env vars.
  • Automatically derive github user and the github project.
  • Allow for configuration of --user, --project, --since_tag, and --future_release by default

Constraints and Assumptions

  • Support just github for now.
  • Requires ruby and as awesome as Gitpod is, the Gitpod environment comes with ruby and rake right out of the box.
  • CHANGELOG will require a (git) tag in order to properly output the version number. set this tag as the value for future_release in starter.ini or the most recent changes in the changelog will have a title of UNRELEASED.

Alternatives or Workarounds

Compile changelogs by hand. This will make it almost impossible to standardize though.

Additional context

Time saved doing chores is time gained fixing bugs and coding features 💪🏽

@apolopena apolopena added the enhancement New feature or request label Feb 4, 2021
@apolopena apolopena self-assigned this Feb 4, 2021
apolopena added a commit that referenced this issue Feb 4, 2021
apolopena added a commit that referenced this issue Feb 4, 2021
apolopena added a commit that referenced this issue Feb 4, 2021
apolopena added a commit that referenced this issue Feb 4, 2021
@apolopena apolopena added the passed-dev-qa Optional state. Use this when QAing other peoples fixes in another branch.ready to be merged to main label Feb 5, 2021
@apolopena apolopena changed the title Add autogenerating CHANGELOG.md capability. Autogenerating CHANGELOG.md capability. Feb 6, 2021
@apolopena apolopena changed the title Autogenerating CHANGELOG.md capability. Autogenerating CHANGELOG.md capability Feb 6, 2021
@apolopena apolopena added the gitpod-config Related to gitpod configuration (bash scripts etc...) label Feb 6, 2021
@apolopena apolopena mentioned this issue Feb 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request gitpod-config Related to gitpod configuration (bash scripts etc...) passed-dev-qa Optional state. Use this when QAing other peoples fixes in another branch.ready to be merged to main
Projects
None yet
Development

No branches or pull requests

1 participant