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

Better changelog / release notes support #52

Open
jpnelson opened this issue Jan 27, 2017 · 3 comments
Open

Better changelog / release notes support #52

jpnelson opened this issue Jan 27, 2017 · 3 comments

Comments

@jpnelson
Copy link

Currently the changelog is generated as a file in the repository, which complicates the release process – to get the changelog file published to NPM correctly, we need to do the post step before the perform step, which is not how it should be.

Ideally instead, we would be able to publish release notes summaries instead. Github has a releases API which we could support, and to enable bitbucket support, we can make it agnostic to where it posts these changelogs to – it could be bitbucket snippets, or a third party changelog hosting service.

@vovacodes
Copy link

I don't think the current approach is bad, the naming is simply not appropriate (post). I would call it generate-changelog. All this pre-perform-post are too opinionated IMO. Adding Releases API support is a good thing though, but as an extra, not instead.

@jpnelson
Copy link
Author

jpnelson commented Feb 6, 2017

I agree, particularly since the current recommended order is pre / post / perform – I'd like to stick closely to how semantic-release does the naming if that is possible somehow

@vovacodes
Copy link

It is nice to have some predefined set of actions like pre / post / perform, but the reality is that the environments people work in are different so release process might divert a lot from team to team. The approach semantic-release takes seems to be too opinionated to me. That is the reason why they still cannot work with GitLab or Bitbucket. I would rather have a set of "semantic" tools for lerna that I could use to assemble my release process from. I like the way conventional-changelog is organized. They have a bunch of tools (changelog generation, github releases, version bump, etc.) each of which has a narrow scope of responsibility that allows them to be easily composed together for a precisely tailored release process. @jpnelson what is your opinion on this?

jan-molak added a commit to serenity-js/serenity-js that referenced this issue Mar 4, 2017
affects: serenity-js

So that the changelog is included in the package published to the NPM the \`post\` step needs to be
invoked _before_ the \`perform\` step.
See: atlassian/lerna-semantic-release#52
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

2 participants