website icon indicating copy to clipboard operation
website copied to clipboard

Changelog Automation Updates

Open Cahllagerfeld opened this issue 3 years ago • 2 comments

Small improvements to the changelog automation:

  • [ ] Improve date defaulting - When you run the script, currently it takes three dates, however these should be defaulted to the 1st of the month to the last date of the month, and set the date as the last date of the month. The first date for "release date" should be assumed to be defaulted as the same as the end date. Example: If I run on 2022.01.03 script should assume start on first date of the month, e.g. 2022.01.01, end on last date e.g. 2022.01.31 and default the release date as the end date e.g. 2022.01.31.
  • [ ] Overwrite existing changelog on script re-run - When running the script, it should overwrite the existing content in the current changelog, else create the new file. All changes to the PR information should be done via re-running the script, not updating the PR in the website repo.
  • [x] Ignore PRs from automation - Related to the above, there should be a way for the script to disable certain PR's, e.g. via label, or missing changelog field entry so that changes to the list are not made via the PR content (Add NONE in release notes field)
  • [ ] Clean up labels for changelog on gitpod repo
  • [ ] Support pagination - Current automation only supports last 100 PR's (we need to update for pagination for the GraphQL API)
  • [ ] Implement changelog page partials for the ad-hoc changelog updates - So that we can have per-team updates, not requiring changes to be applied in a single changelog. Example solution: Create changelog as a directory with an index.md being the main changelog, e.g. 2022-09-31. All files remaining in the directory are assumed to be as-hoc feature announcements (e.g. jetbrains-announcement.md). Whch are then injected into the body of index.md automatically, either as a build step in the script, or through some svelte include child page magic.
/changelog
    /2022-09-31
        /index.md
        /jetbrains-announcement.md
        /some-other-announcement.md

Related documentation:

Optional additions (possibly to be moved to another issue)

  • Roadmap Updates
  • Template for Other Components
  • **Latest Release:** You can enable Latest Release in [your preferences](https://gitpod.io/preferences) and try the latest updates as soon as they are available.
  • https://github.com/gitpod-io/website/issues/1859

Cahllagerfeld avatar Jul 21 '22 10:07 Cahllagerfeld

@Cahllagerfeld all good if I pick this one up, and work on it with @filiptronicek ?

loujaybee avatar Sep 20 '22 09:09 loujaybee

Yeah sure, go ahead 👍

Cahllagerfeld avatar Sep 20 '22 09:09 Cahllagerfeld