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.

Sign up for GitHub

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

Jump to bottom

[GH-1051] Add documentation about release process and the automation to generate changelog #206

Merged
merged 11 commits into from
Nov 3, 2020
Merged

[GH-1051] Add documentation about release process and the automation to generate changelog #206

merged 11 commits into from
Nov 3, 2020

Conversation

rexwangcc
Copy link
Contributor

@rexwangcc rexwangcc commented Nov 1, 2020 •
edited
Loading

Purpose

  • No ticket is linked to this PR. But this is stated as one of the issues in What the WFL doc

Changes

  • Add a command to cli.py to generate changelog for us.
  • Use the new command to generate the current changelog for us.
  • Add docs about releases.
  • Make the release Action use this new command. Instead, the generation of changelog will happen in the "release" PR to provide more control to the devs.
  • Clean up the main readme and redirect people to the docsite so the main readme syntax does not confuse people. This is another item in What the WFL doc

Review Instructions

  • No instructions.

ehigham
ehigham reviewed Nov 2, 2020
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
jack-r-warren
jack-r-warren reviewed Nov 2, 2020
View reviewed changes
ops/cli.py Outdated Show resolved Hide resolved
@jack-r-warren
Copy link
Contributor

(Review approval based on Ed's comment being addressed, just wanted to communicate that my suggestion was in no way blocking)

rexwangcc
rexwangcc commented Nov 2, 2020
View reviewed changes
ops/cli.py Outdated Show resolved Hide resolved
@rexwangcc rexwangcc marked this pull request as ready for review November 2, 2020 20:16
@rexwangcc rexwangcc changed the title Start writing changelog Add release process and the automation to generate changelog Nov 2, 2020
@rexwangcc rexwangcc changed the title Add release process and the automation to generate changelog Add documentation about release process and the automation to generate changelog Nov 2, 2020
jack-r-warren
jack-r-warren approved these changes Nov 2, 2020
View reviewed changes
Copy link
Contributor

@jack-r-warren jack-r-warren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. Very much appreciate cleaning up the README linking and stuff too, thanks for doing this

docs/md/dev-release.md Outdated Show resolved Hide resolved
@rexwangcc @jack-r-warren
Update docs/md/dev-release.md
79e1440 
Co-authored-by: Jack Warren <jack@jackwarren.info>
@rexwangcc rexwangcc merged commit ef7f8e6 into master Nov 3, 2020
@rexwangcc rexwangcc deleted the rex/let-us-write-changelogs branch November 3, 2020 16:00
@rexwangcc rexwangcc changed the title Add documentation about release process and the automation to generate changelog [GH-1051] Add documentation about release process and the automation to generate changelog Nov 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jack-r-warren jack-r-warren jack-r-warren approved these changes

@ehigham ehigham ehigham approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rexwangcc @jack-r-warren @ehigham