Update references for dev/stable split

This commit is contained in:
Florian Märkl 2021-12-21 13:39:25 +01:00
parent 8cc4d14a6f
commit 9de1d56c93
11 changed files with 23 additions and 19 deletions

View File

@ -80,7 +80,8 @@ for:
- -
branches: branches:
only: only:
- master - dev
- stable
- -
skip_non_tags: true skip_non_tags: true

View File

@ -3,14 +3,16 @@ name: Cutter CI
on: on:
push: push:
branches: branches:
- master - dev
- stable
tags: tags:
- v* - v*
- upload-test* - upload-test*
pull_request: pull_request:
branches: branches:
- master - dev
- stable
jobs: jobs:
build: build:

View File

@ -3,7 +3,7 @@ name: Docs
on: on:
push: push:
branches: branches:
- master - dev
jobs: jobs:
deploy: deploy:

View File

@ -3,10 +3,12 @@ name: "Linter"
on: on:
push: push:
branches: branches:
- master - dev
- stable
pull_request: pull_request:
branches: branches:
- master - dev
- stable
jobs: jobs:
changes: changes:

View File

@ -16,7 +16,7 @@ Please follow our contribution guidelines: https://cutter.re/docs/contributing.h
## Contributing to the documentation ## Contributing to the documentation
The documentation is something important for newcomers. As of today the documentation can be found [here](https://cutter.re/docs/) and it stands in the [docs](https://github.com/rizinorg/cutter/tree/master/docs) folder. The documentation is something important for newcomers. As of today the documentation can be found [here](https://cutter.re/docs/) and it stands in the [docs](docs) folder.
The API Reference is automatically generated from the source code, so it is strongly advised to document your code. The API Reference is automatically generated from the source code, so it is strongly advised to document your code.
Check issues marked as "Documentation" on our issues [list](https://github.com/rizinorg/cutter/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation). Check issues marked as "Documentation" on our issues [list](https://github.com/rizinorg/cutter/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation).

View File

@ -1,14 +1,14 @@
<img width="150" height="150" align="left" style="float: left; margin: 0 10px 0 0;" alt="Cutter logo" src="https://raw.githubusercontent.com/rizinorg/cutter/master/src/img/cutter.svg?sanitize=true"> <img width="150" height="150" align="left" style="float: left; margin: 0 10px 0 0;" alt="Cutter logo" src="https://raw.githubusercontent.com/rizinorg/cutter/dev/src/img/cutter.svg?sanitize=true">
# Cutter # Cutter
Cutter is a free and open-source reverse engineering platform powered by [rizin](https://github.com/rizinorg/rizin). It aims at being an advanced and customizable reverse engineering platform while keeping the user experience in mind. Cutter is created by reverse engineers for reverse engineers. Cutter is a free and open-source reverse engineering platform powered by [rizin](https://github.com/rizinorg/rizin). It aims at being an advanced and customizable reverse engineering platform while keeping the user experience in mind. Cutter is created by reverse engineers for reverse engineers.
[![Cutter CI](https://github.com/rizinorg/cutter/workflows/Cutter%20CI/badge.svg)](https://github.com/rizinorg/cutter/actions?query=workflow%3A%22Cutter+CI%22) [![Cutter CI](https://github.com/rizinorg/cutter/workflows/Cutter%20CI/badge.svg)](https://github.com/rizinorg/cutter/actions?query=workflow%3A%22Cutter+CI%22)
[![Build status](https://ci.appveyor.com/api/projects/status/tn7kttv55b8wf799/branch/master?svg=true)](https://ci.appveyor.com/project/rizinorg/cutter/branch/master) [![Build status](https://ci.appveyor.com/api/projects/status/tn7kttv55b8wf799/branch/dev?svg=true)](https://ci.appveyor.com/project/rizinorg/cutter/branch/dev)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/rizinorg/cutter.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/rizinorg/cutter/alerts/) [![Total alerts](https://img.shields.io/lgtm/alerts/g/rizinorg/cutter.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/rizinorg/cutter/alerts/)
![Screenshot](https://raw.githubusercontent.com/rizinorg/cutter/master/docs/source/images/screenshot.png) ![Screenshot](https://raw.githubusercontent.com/rizinorg/cutter/dev/docs/source/images/screenshot.png)
## Learn more at [cutter.re](https://cutter.re). ## Learn more at [cutter.re](https://cutter.re).

View File

@ -6,7 +6,7 @@ Building
If you just want to use the latest Release version of Cutter, please note If you just want to use the latest Release version of Cutter, please note
that we provide pre-compiled binaries for Windows, Linux, and macOS on that we provide pre-compiled binaries for Windows, Linux, and macOS on
our `release page <https://github.com/rizinorg/cutter/releases/latest>`_ and our `release page <https://github.com/rizinorg/cutter/releases/latest>`_ and
`CI page <https://nightly.link/rizinorg/cutter/workflows/ccpp/master>`_ for latest development builds. `CI page <https://nightly.link/rizinorg/cutter/workflows/ccpp/dev>`_ for latest development builds.
This page describes how to do a basic build from the command line. If you are planning to modify Cutter it is recommended to also read our :doc:`development environment setup</contributing/code/ide-setup>`. This page describes how to do a basic build from the command line. If you are planning to modify Cutter it is recommended to also read our :doc:`development environment setup</contributing/code/ide-setup>`.

View File

@ -257,7 +257,7 @@ In order to update one submodule individually, use the following code:
.. code:: sh .. code:: sh
cd rizin cd rizin
git checkout master && git pull git checkout dev && git pull
cd .. cd ..
git add rizin git add rizin
git commit -m "Update rizin submodule" git commit -m "Update rizin submodule"

View File

@ -4,7 +4,7 @@ Release Procedure
1. Update translations submodule `<https://github.com/rizinorg/cutter-translations>`_ 1. Update translations submodule `<https://github.com/rizinorg/cutter-translations>`_
1. The latest archive from Crowdin should already be in the repository, if not make sure to merge any automated Pull Request from Crowdin (e.g. https://github.com/rizinorg/cutter-translations/pull/9) 1. The latest archive from Crowdin should already be in the repository, if not make sure to merge any automated Pull Request from Crowdin (e.g. https://github.com/rizinorg/cutter-translations/pull/9)
2. Update submodule in cutter 2. Update submodule in cutter
2. If there is a desire to keep working in the master branch, create branch for the release and do all the following work there. 2. Merge the current state of dev into stable. This can happen even earlier in order to feature-freeze the release while keeping development on dev alive. The rizin submodule on stable should point to a commit of stable in rizin and dev to a commit in dev.
3. Lock rzghidra and rzdec versions downloaded by packaging scripts. Specify a tag or commit hash. 3. Lock rzghidra and rzdec versions downloaded by packaging scripts. Specify a tag or commit hash.
4. Update version 4. Update version
#. appveyor.yml #. appveyor.yml
@ -19,11 +19,11 @@ Release Procedure
6. Create a GitHub release, mark it as pre-release save draft, set the tag to v1.11.0-rc1 6. Create a GitHub release, mark it as pre-release save draft, set the tag to v1.11.0-rc1
7. Wait for packages to build 7. Wait for packages to build
8. On all operating systems do the `Basic testing procedure`_ to ensure nothing badly broken. 8. On all operating systems do the `Basic testing procedure`_ to ensure nothing badly broken.
9. If any major problems are found, open an issue and fix them. If a release branch is used fix them in master and cherry pick into release branch. If the amount of changes is sufficiently large repeat from step 3. increasing rc number by one. 9. If any major problems are found, open an issue and fix them in dev and cherry pick into release branch. If the amount of changes is sufficiently large repeat from step 3. increasing rc number by one.
10. Update version to 1.11.0 10. Update version to 1.11.0
11. Create tag 11. Create tag
12. Create release 12. Create release
* Fill the release notes in the Release description. Preparing release notes can begin earlier. Compare current master or release branch against previous release to find all the changes. Choose the most important ones. Don't duplicate the commit log. Release notes should be a summary for people who don't want to read whole commit log. Group related changes together under titles such as "New features", "Bug Fixes", "Decompiler", "Rizin" and similar. * Fill the release notes in the Release description. Preparing release notes can begin earlier. Compare current dev branch against previous release to find all the changes. Choose the most important ones. Don't duplicate the commit log. Release notes should be a summary for people who don't want to read whole commit log. Group related changes together under titles such as "New features", "Bug Fixes", "Decompiler", "Rizin" and similar.
13. Prepare announcement tweets and messages to send in the Telegram group, reddit, and others. 13. Prepare announcement tweets and messages to send in the Telegram group, reddit, and others.
14. Close milestone if there was one 14. Close milestone if there was one
@ -33,8 +33,7 @@ Bugfix Release
-------------- --------------
The process for bugfix release is similar no normal release procedure described above with some differences. The process for bugfix release is similar no normal release procedure described above with some differences.
* Create the branch from the last tag instead of master or reuse the branch from x.y.0 release if it was already created. * Cherry pick required bugfixes from dev into the stable.
* Cherry pick required bugfixes from master into the branch.
* Increase the third version number x.y.n into x.y.(n+1) . * Increase the third version number x.y.n into x.y.(n+1) .

View File

@ -16,7 +16,7 @@ How can you help?
The following sections suggest ways you can contribute to Cutter's documentation. The list isn't complete as the possibilities are limitless. The following sections suggest ways you can contribute to Cutter's documentation. The list isn't complete as the possibilities are limitless.
The source for this documentation is available in the `docs directory <https://github.com/rizinorg/cutter/tree/master/docs>`_ on Cutter's repository. This source can be generated according to the steps described in the :ref:`building docs page<contributing/docs/building-docs:Building docs>`. When the docs are updated, they are generated and pushed directly to the website at <https://cutter.re/docs>. The source for the website and blog are available on the `cutter.re's repository <https://github.com/rizinorg/cutter.re>`_ and are served from the ``gh-pages`` branch. The source for this documentation is available in the `docs directory <https://github.com/rizinorg/cutter/tree/dev/docs>`_ on Cutter's repository. This source can be generated according to the steps described in the :ref:`building docs page<contributing/docs/building-docs:Building docs>`. When the docs are updated, they are generated and pushed directly to the website at <https://cutter.re/docs>. The source for the website and blog are available on the `cutter.re's repository <https://github.com/rizinorg/cutter.re>`_ and are served from the ``gh-pages`` branch.
.. tip:: .. tip::
Document what you wished to see. If you are a user of Cutter, try to think what things you would want to see documented when you started using the project. Sometimes, the best contributions are coming from your own needs. Document what you wished to see. If you are a user of Cutter, try to think what things you would want to see documented when you started using the project. Sometimes, the best contributions are coming from your own needs.

View File

@ -16,7 +16,7 @@
<screenshots> <screenshots>
<screenshot> <screenshot>
<image>https://raw.githubusercontent.com/rizinorg/cutter/master/docs/source/images/screenshot.png</image> <image>https://raw.githubusercontent.com/rizinorg/cutter/stable/docs/source/images/screenshot.png</image>
<caption>Main UI</caption> <caption>Main UI</caption>
</screenshot> </screenshot>
</screenshots> </screenshots>