Giter VIP home page Giter VIP logo

changelog-generator's Introduction

Patrick Gatewood (he/him)

Probably clacking on his keyboard at 2 AM

Check out my blog. I'm usually up to some cool stuff.

Some of my recent favorites:

changelog-generator's People

Contributors

pg8wood avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

changelog-generator's Issues

Slug changelog filenames

The UUID-based filenames are great for ensuring no naming collisions occur, but they aren't readable. Giving them a more meaningful name will simplify developer workflows

Remove system dependencies from publish command tests

Now that the interactive prompt, file manager, and disk writing utility are all mocked, we should follow best testing practices and use these mocks.

Acceptance Criteria:

  • remove the dependency on TSCBasic from the PublishCommandTest cases
  • replace all calls to withTemporaryChangelogEntry with hooks into the mocked disk writing utility

Amend subcommand

changelog amend: opens the most-recently-created changelog entry for editing, similar to how git commit --amend works

Investigate using config file

As the tool becomes more feature-rich, using command-line arguments for configuration options that won't change after initial setup (e.g. custom CHANGELOG filename) might be cumbersome. A config file where users can customize the tool may relieve this

Expand interactive composition methods

It can sometimes be cumbersome to open the text editor and add entries using markdown syntax. Create an interactive way to add entries on the command line.

Example flow:

changelog add <-t | --ticket>
Enter the ticket number:
TICKET-1234
Enter the link to the ticket: 
https://blog.patrickgatewood.com

<create entry and emit existing success message>

Maybe let this be done via some flags too:
`changelog add <-t | --ticket>
^ don't forget about argument parser's ability to type check URLs!

After #2, this could be accomplished simply by typing
changelog add -t <hypertext> 1234โ—๏ธ

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.