Skip to content

CHANGELOG.md shouldn't include pre-release changes? #31491

Closed

Description

@iget-master

I was looking for v8.1.0 changelog, and realized that I need to read all pre-release versions in order to know what's changed. See the changes on changelog.md:

8.1.0 (2019-07-02)

Bug Fixes

  • core: handle undefined meta in injectArgs (#31333) (80ccd6c), closes CLI #14888
  • service-worker: cache opaque responses in data groups with freshness strategy (#30977) (b0c3453), closes #30968
  • service-worker: cache opaque responses when requests exceeds timeout threshold (#30977) (a9038ef)

Reading the other releases, there was many, many other changes on this release that are not on changelog of the version itself, but on .rc*, .next-*...

Shouldn't the changelog be a merge of all pre-release versions?

Activity

  1. changed the title [-]CHANGELOG shouldn't include pre-release changes?[/-] [+]CHANGELOG.md shouldn't include pre-release changes?[/+] on Jul 10, 2019
  2. jasonaden commented on Jul 10, 2019

    @jasonaden
    Contributor

    @iget-master You're correct, in general the changelog should be a merge of pre-release versions. But in the case of .next-*, any of these changes that are currently landing are targeting the next minor release, which would be 8.2.0 and therefore won't be in the 8.1.x changelog. With the .rc-* version, it depends on what was in RC. So if it was 8.1.0-rc.x, those changes should be in the changelog for 8.1.x.

    If you could call out specific items in the changelog that you feel are missing, that would be great. It's possible we miss some when running our release scripts.

  3. jasonaden commented on Jul 10, 2019

    @jasonaden
    Contributor

    Also, for the most part, reading the changelog at master should give you a combination of all changes from all versions. The only exception here is when there's a change to an earlier version that for some reason doesn't need to be applied to the most recent version. An example could be a fix to code in something like 8.1.x that doesn't need to be fixed on master because the behavior has already been refactored or changed in master and that change wasn't applied to the stable version. This is very rare though.

  4. added this to the Backlog milestone on Jul 10, 2019
  5. iget-master commented on Jul 10, 2019

    @iget-master
    Author

    Let me give you a sample:

    On changelog for 8.1.0, excluding .next-*, we have:

    8.1.0 (2019-07-02)

    Bug Fixes

    • core: handle undefined meta in injectArgs (#31333) (80ccd6c), closes CLI #14888
    • service-worker: cache opaque responses in data groups with freshness strategy (#30977) (b0c3453), closes #30968
    • service-worker: cache opaque responses when requests exceeds timeout threshold (#30977) (a9038ef)

    8.1.0-rc.0 (2019-06-26)

    Bug Fixes

    8.1.0-beta.0 (2019-05-30)

    Bug Fixes

    • bazel: allow ts_library interop with list-typed inputs (#30600) (3125376)
    • bazel: Bump ibazel to 0.10.1 for windows fixes (#30196) (1353bf0)
    • bazel: Directly spawn native Bazel binary (#30306) (2a0f497)
    • bazel: Disable sandbox on Mac OS (#30460) (b6b1aec)
    • bazel: Exclude common/upgrade* in metadata.tsconfig.json (#30133) (1f4c380)
    • bazel: ng test should run specific ts_web_test_suite (#30526) (e688e02)
    • bazel: pass correct arguments to http_server in Windows (#30346) (3aff79c), closes #29785
    • bazel: update peerDep ranges (#30155) (4ae0ee8)
    • bazel: Use existing npm/yarn lock files (#30438) (ff29ccc)
    • compiler-cli: log ngcc skipping messages as debug instead of info (#30232) (60a8888)
    • core: consistently use ng:/// for sourcemap URLs (#29826) (392473e)
    • core: CSS sanitizer now allows parens in file names (#30322) (728db88)
    • core: fix interpolate identifier in AOT (#30243) (30d1f29)
    • core: migrations not always migrating all files (#30269) (349935a)
    • core: remove deprecated TestBed.deprecatedOverrideProvider API (#30576) (a96976e)
    • core: require 'static' flag on queries in typings (#30639) (84dd267)
    • core: static-query migration errors not printed properly (#30458) (6ceb903)
    • core: static-query migration fails with default parameter values (#30269) (6357d4a)
    • core: static-query migration should gracefully exit if AOT compiler throws (#30269) (509352f)
    • core: static-query migration should handle queries on accessors (#30327) (0ffdb48)
    • core: static-query migration should not fallback to test strategy (#30458) (0cdf598)
    • core: static-query migration should not prompt if no queries are used (#30254) (4c12d74)
    • core: static-query usage migration strategy should detect ambiguous query usage (#30215) (8d3365e)
    • core: temporarily remove @deprecated jsdoc tag for a TextBed.get overload (#30514) (f6bf892), closes #29290 #29905
    • language-service: Remove tsserverlibrary from rollup globals (#30123) (124e497)
    • router: ensure history.state is set in eager update mode (#30154) (b40f6f3)
    • router: ensure navigations start with the current URL value incase redirect is skipped (#30344) (0fd9d08), closes #30340 #30160
    • router: fix a problem with router not responding to back button (#30160) (3327bd8)
    • router: IE 11 bug can break URL unification when comparing objects (#30393) (197584d)
    • router: type cast correctly for IE 11 bug breaking URL Unification when comparing objects (#30464) (53f3564)

    Features

    • bazel: use rbe_autoconfig() and new container. (#29336) (9abf114)
    • common: add ability to watch for AngularJS URL updates through onUrlChange hook (#30466) (1aff524)
    • common: stricter types for SlicePipe (#30156) (95830ee)
    • core: deprecate integration with the Web Tracing Framework (WTF) (#30642) (f310a59)
    • language-service: Implement definitionAndBoundSpan (#30125) (f491673)
    • platform-webworker: deprecate platform-webworker (#30642) (ccc76f7)

    Note that the 8.1.0 final release changelog is not a merge of beta.0 + rc.0 + 8.1.0

  6. rockument69 commented on May 27, 2020

    @rockument69
    Contributor

    @kapunahelewong : I don't think this is a docs issue. This doc seems to be generated, not edited by us:
    CHANGELOG.md

  7. added
    P4A relatively minor issue that is not relevant to core functions
    and removed on Oct 1, 2020
  8. JoostK commented on May 24, 2021

    @JoostK
    Member

    Since opening this issue the changelog is now being updated to combine all changes since next/rc releases when the final release is made, so I'm closing this as addressed.

  9. angular-automatic-lock-bot commented on Jun 24, 2021

    @angular-automatic-lock-bot

    This issue has been automatically locked due to inactivity.
    Please file a new issue if you are encountering a similar or related problem.

    Read more about our automatic conversation locking policy.

    This action has been performed automatically by a bot.

  10. locked and limited conversation to collaborators on Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions