Skip to content

Commit 9de1d56

Browse files
committed
Update references for dev/stable split
1 parent 8cc4d14 commit 9de1d56

11 files changed

+23
-19
lines changed

.appveyor.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ for:
8080
-
8181
branches:
8282
only:
83-
- master
83+
- dev
84+
- stable
8485
-
8586
skip_non_tags: true
8687

.github/workflows/ccpp.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@ name: Cutter CI
33
on:
44
push:
55
branches:
6-
- master
6+
- dev
7+
- stable
78
tags:
89
- v*
910
- upload-test*
1011

1112
pull_request:
1213
branches:
13-
- master
14+
- dev
15+
- stable
1416

1517
jobs:
1618
build:

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Docs
33
on:
44
push:
55
branches:
6-
- master
6+
- dev
77

88
jobs:
99
deploy:

.github/workflows/linter.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ name: "Linter"
33
on:
44
push:
55
branches:
6-
- master
6+
- dev
7+
- stable
78
pull_request:
89
branches:
9-
- master
10+
- dev
11+
- stable
1012

1113
jobs:
1214
changes:

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please follow our contribution guidelines: https://cutter.re/docs/contributing.h
1616

1717
## Contributing to the documentation
1818

19-
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.
19+
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.
2020
The API Reference is automatically generated from the source code, so it is strongly advised to document your code.
2121
Check issues marked as "Documentation" on our issues [list](https://github.com/rizinorg/cutter/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation).
2222

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
<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">
1+
<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">
22

33
# Cutter
44

55
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.
66

77
[![Cutter CI](https://github.com/rizinorg/cutter/workflows/Cutter%20CI/badge.svg)](https://github.com/rizinorg/cutter/actions?query=workflow%3A%22Cutter+CI%22)
8-
[![Build status](https://ci.appveyor.com/api/projects/status/tn7kttv55b8wf799/branch/master?svg=true)](https://ci.appveyor.com/project/rizinorg/cutter/branch/master)
8+
[![Build status](https://ci.appveyor.com/api/projects/status/tn7kttv55b8wf799/branch/dev?svg=true)](https://ci.appveyor.com/project/rizinorg/cutter/branch/dev)
99
[![Total alerts](https://img.shields.io/lgtm/alerts/g/rizinorg/cutter.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/rizinorg/cutter/alerts/)
1010

11-
![Screenshot](https://raw.githubusercontent.com/rizinorg/cutter/master/docs/source/images/screenshot.png)
11+
![Screenshot](https://raw.githubusercontent.com/rizinorg/cutter/dev/docs/source/images/screenshot.png)
1212

1313
## Learn more at [cutter.re](https://cutter.re).
1414

docs/source/building.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Building
66
If you just want to use the latest Release version of Cutter, please note
77
that we provide pre-compiled binaries for Windows, Linux, and macOS on
88
our `release page <https://github.com/rizinorg/cutter/releases/latest>`_ and
9-
`CI page <https://nightly.link/rizinorg/cutter/workflows/ccpp/master>`_ for latest development builds.
9+
`CI page <https://nightly.link/rizinorg/cutter/workflows/ccpp/dev>`_ for latest development builds.
1010

1111
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>`.
1212

docs/source/contributing/code/development-guidelines.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ In order to update one submodule individually, use the following code:
257257
.. code:: sh
258258
259259
cd rizin
260-
git checkout master && git pull
260+
git checkout dev && git pull
261261
cd ..
262262
git add rizin
263263
git commit -m "Update rizin submodule"

docs/source/contributing/code/release-procedure.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Release Procedure
44
1. Update translations submodule `<https://github.com/rizinorg/cutter-translations>`_
55
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)
66
2. Update submodule in cutter
7-
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.
7+
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.
88
3. Lock rzghidra and rzdec versions downloaded by packaging scripts. Specify a tag or commit hash.
99
4. Update version
1010
#. appveyor.yml
@@ -19,11 +19,11 @@ Release Procedure
1919
6. Create a GitHub release, mark it as pre-release save draft, set the tag to v1.11.0-rc1
2020
7. Wait for packages to build
2121
8. On all operating systems do the `Basic testing procedure`_ to ensure nothing badly broken.
22-
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.
22+
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.
2323
10. Update version to 1.11.0
2424
11. Create tag
2525
12. Create release
26-
* 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.
26+
* 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.
2727
13. Prepare announcement tweets and messages to send in the Telegram group, reddit, and others.
2828
14. Close milestone if there was one
2929

@@ -33,8 +33,7 @@ Bugfix Release
3333
--------------
3434
The process for bugfix release is similar no normal release procedure described above with some differences.
3535

36-
* Create the branch from the last tag instead of master or reuse the branch from x.y.0 release if it was already created.
37-
* Cherry pick required bugfixes from master into the branch.
36+
* Cherry pick required bugfixes from dev into the stable.
3837
* Increase the third version number x.y.n into x.y.(n+1) .
3938

4039

docs/source/contributing/docs/getting-started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ How can you help?
1616

1717
The following sections suggest ways you can contribute to Cutter's documentation. The list isn't complete as the possibilities are limitless.
1818

19-
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.
19+
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.
2020

2121
.. tip::
2222
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.

src/re.rizin.cutter.appdata.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
<screenshots>
1818
<screenshot>
19-
<image>https://raw.githubusercontent.com/rizinorg/cutter/master/docs/source/images/screenshot.png</image>
19+
<image>https://raw.githubusercontent.com/rizinorg/cutter/stable/docs/source/images/screenshot.png</image>
2020
<caption>Main UI</caption>
2121
</screenshot>
2222
</screenshots>

0 commit comments

Comments
 (0)