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

Setup a release process #121

Closed
Totktonada opened this issue Dec 13, 2021 · 1 comment
Closed

Setup a release process #121

Totktonada opened this issue Dec 13, 2021 · 1 comment
Assignees
@ligurio
Labels
code health Improve code readability, simplify maintenance and so on

Comments

@Totktonada
Copy link
Member

Totktonada commented Dec 13, 2021 •
edited by ligurio
Loading

  • Add CHANGELOG.md1.
  • Whether we need to deploy the connector to pkg.go.dev2?
  • Start to tag releases and write release notes (within annotated tag and in release notes)3.
  • Describe release process in a wiki.

Anything else? Thoughts?

Initially requested in #65 (comment), but I added my thoughts here.

Footnotes

  1. I hope, we'll NOT strictly follow the 'keep a changelog; format. It is better to adopt it to be maximal expressive. Choose the best categories, add an overview section and so on. ↩

  2. I'm not a Go developer, so it is terra ingognita for me. Need to investigate the topic. ↩

  3. I hope the release notes will be just copy of the relevant section from the changelog. There is no need to support two representations of the same idea: offer a user information about changes in the easy to understand form (without gory details). ↩
@Totktonada Totktonada added teamE code health Improve code readability, simplify maintenance and so on labels Dec 13, 2021
@Totktonada Totktonada mentioned this issue Dec 13, 2021
Closed
@ligurio ligurio mentioned this issue Mar 31, 2022
Merged
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
changelog: add an initial version
5ee1eff 
Changelog contains commits added after tagging of alpha version (commit
855df82). Changelog entries and format
conforms to format described in "Keep a changelog" [1].

1. https://keepachangelog.com/en/1.0.0/

Closes #121
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
github: add template for pull-request description
776f3d4 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
github: add template for pull-request description
84013bd 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
@ligurio
Copy link
Member

ligurio commented Apr 6, 2022

Describe release process in a wiki.

https://github.com/tarantool/go-tarantool/wiki/How-to-release

ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
changelog: add an initial version
f208dca 
Changelog contains commits added after tagging of alpha version (commit
855df82). Changelog entries and format
conforms to format described in "Keep a changelog" [1].

1. https://keepachangelog.com/en/1.0.0/

Closes #121
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
github: add template for pull-request description
c5c01a4 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
changelog: add an initial version
1e3bb5b 
Changelog contains commits added after tagging of alpha version (commit
855df82). Changelog entries and format
conforms to format described in "Keep a changelog" [1].

1. https://keepachangelog.com/en/1.0.0/

Closes #121
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
github: add template for pull-request description
6d2d20f 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
changelog: add an initial version
80c7450 
Changelog contains commits added after tagging of alpha version (commit
855df82). Changelog entries and format
conforms to format described in "Keep a changelog" [1].

1. https://keepachangelog.com/en/1.0.0/

Closes #121
ligurio added a commit that referenced this issue Apr 6, 2022
@ligurio
github: add template for pull-request description
7f315a3 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
ligurio added a commit that referenced this issue Apr 7, 2022
@ligurio
changelog: add an initial version
fe4bfd0 
Changelog contains commits added after tagging of alpha version (commit
855df82). Changelog entries and format
conforms to format described in "Keep a changelog" [1].

1. https://keepachangelog.com/en/1.0.0/

Closes #121
ligurio added a commit that referenced this issue Apr 7, 2022
@ligurio
github: add template for pull-request description
5743e12 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
ligurio added a commit that referenced this issue Apr 11, 2022
@ligurio
changelog: add an initial version
c0b86a6 
Changelog contains commits added after tagging of alpha version (commit
855df82). Changelog entries and format
conforms to format described in "Keep a changelog" [1].

1. https://keepachangelog.com/en/1.0.0/

Closes #121
ligurio added a commit that referenced this issue Apr 11, 2022
@ligurio
github: add template for pull-request description
ee31805 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
ligurio added a commit that referenced this issue Apr 11, 2022
@ligurio
github: add template for pull-request description
2c3af56 
Commit for #153 introduces changelog and to remind contributors about
changelog entries this commit adds a template for pull-request
description. Learn more about templates on Github in [1].

1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Follows up #121
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ligurio ligurio

Labels
code health Improve code readability, simplify maintenance and so on
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Totktonada @ligurio