tursom/memgraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Migrate release docs to Notion (#86)

Browse Source
This commit is contained in:
Marko Budiselić 2021-01-28 16:29:00 +01:00 committed by GitHub
parent 2caf0e617e
commit e4852cc5e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -6,8 +6,8 @@ data structures, multi-version concurrency control and asynchronous IO.
## Development Documentation
Please continue
[here](https://www.notion.so/memgraph/memgraph-0428591638604c8385550e214ea9f3e6).
Please continue in
[Notion](https://www.notion.so/memgraph/memgraph-0428591638604c8385550e214ea9f3e6).
## User Documentation

4
environment/README.md
View File

@ -1,4 +1,4 @@
# Memgraph Build and Run Environments
Please continue
[here](https://www.notion.so/memgraph/Tools-05e0baafb78a49b386e0063b4833d23d).
Please continue in
[Notion](https://www.notion.so/memgraph/Tools-05e0baafb78a49b386e0063b4833d23d).

45
release/README.md
View File

@ -1,43 +1,4 @@
# Memgraph Release Packaging
# Memgraph Release
Various tools and packaging configuration files should be put under this
directory. Common files for all packages can be kept in the root of this
directory, for example `memgraph.service`. If the common stuff should be
grouped, it should be in a subdirectory. `examples` directory is one such
case. Packaging specific stuff must have its own directory.
Currently we support distributing Memgraph binary through the following
packages.
* Debian package
* RPM package
* Docker image
* ArchLinux package
## Release process
While releasing an official version of Memgraph, there are two possible
scenarios:
* First release in new major.minor series
* Patch release in existing major.minor series
To release a new major.minor release of Memgraph you should execute the
following steps:
1. Merge all PRs that must be in the new release
2. Document all changes in `CHANGELOG.md` and merge them
3. From the `master` branch, create a branch named `release/X.Y` and push it
to `origin`
4. Create the release packages triggering a `Release {{Operating System}}`
workflow using branch `release/X.Y` on Github Actions
5. Enjoy
To release a new patch release in an existing major.minor series you should
execute the following steps:
1. Checkout to the `release/X.Y` branch
2. Cherry-pick all landed commits that should be included in the patch version
3. Document all changes in `CHANGELOG.md` and commit them
4. Edit the root `CMakeLists.txt` and set `MEMGRAPH_OVERRIDE_VERSION` to
`X.Y.patch` and commit the change
5. Create the release packages triggering a `Release {{Operating System}}`
workflow using branch `release/X.Y` on Github Actions
6. Enjoy
Please continue in
[Notion](https://www.notion.so/memgraph/Release-621733518c82456ebc119d2a025b5dd3).