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

Update the release documentation #356

Open
sondreb opened this issue Oct 5, 2021 · 2 comments
Open

Update the release documentation #356

sondreb opened this issue Oct 5, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@sondreb
Copy link
Member

sondreb commented Oct 5, 2021

Update the release documentation to describe how development and releases are made. The current documentation is old.

https://github.com/block-core/blockcore/blob/master/Documentation/release-processes.md

@sondreb sondreb added the documentation Improvements or additions to documentation label Oct 5, 2021
@dangershony
Copy link
Member

dangershony commented Oct 5, 2021

Currently the process of release is as following

There is a github action that triggers on push to master and will build the code and create a draft release of current version on master, every commit to master will override that release until the version is bumped.

Wait for any builds

Wait for all builds on master that we want to be included in the current release to finish (best practice is wait for all builds on master to finish)

Bump version

Bump version in this file
https://github.com/block-core/blockcore/blob/1.0.23/src/Directory.Build.props#L3

Run changelog update.

In the project root run the command
npm run changelog
This will modify the fle
https://github.com/block-core/blockcore/blob/1.0.23/CHANGELOG.md

Release

On the release tab there will be a release draft created for the previous version (before the bump, bumping the version will create a new release draft)
Optional - update the change log in the release as well
Click "Release" on the release

@dangershony
Copy link
Member

Reminder we need to move this to the main repo (and potentially to documentation repo)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants