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

develop brnahc docs #79

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions docs/dev/beta-testing.md → docs/dev/pre-release.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,46 @@
---
id: beta-testing
id: pre-release
title: So you want to run some pre-release software?
sidebar_label: Beta testing
sidebar_label: Pre-release
---

We often need the community's help to test new applications. As the whole tool set is tracked in git, you can try new features quite easily.

:::warning Watch the fuck out!
Please make sure you only do this if you know what you're doing. A poorly written installer could easily destroy your entire machine beyond any hope of repair. If you do not know how you would get out of a completely broken install, do not attempt these steps!
:::

Anyway, if you're courageous enough, here's how you can test the latest and coolest stuff!

## Using the `develop` branch

We have two update rings. `master` (the default branch) is extremely closely monitored for stability, and our `develop` branch is used to put new bleeding edge features out in the open.

You can seemlessly transition between `develop` and `master` at any point by running the commands below.

```bash
sudo box switchbranch develop
```

Please note that going from `develop` to `master` will _not_ remove any changes that were applied while on `develop`. While we believe you should have no issue going in this direction, we cannot guarantee it 100%. Check with us in the discord if you face any issues when doing this.


## The branch checkout dance

:::warning Watch the fuck out!
Please make sure you only do this if you know what you're doing. A poorly written installer could easily destroy your entire machine beyond any hope of repair. If you do not know how you would get out of a completely broken install, do not attempt these steps!
:::

There are two types branches you might want to test. One that is made by the swizzin team, and one that is made on a repository forked from swizzin.

As soon as you're on the branch you need to be on, you just keep using `box` just like you usually would. Just watch out for `box update`s! read more about those [below](#preventing-updates).

### Branches on the swizzin repo

You can run the following quick set of commands
You can run the following commands to get onto a branch of a PR.

```bash
cd /etc/swizzin
sudo git fetch --all
sudo git checkout <branch name>
box branchswitch <name of PR branch>
```

Switching back to `master` or develop **will not be prevented** so make sure that you know what you're doing!

### Branches from any fork

Now this is a little more hands-on as you need to add the remote fork to your repository, but this can be done quite easily with the GitHub CLI tool.
Expand Down
3 changes: 3 additions & 0 deletions docs/dev/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: Getting a developer setup
sidebar_label: Setup
---

## Repo layout
We use the git flow, so please make sure you're working against the `develop` branch as well as targetting your PRs against it.

## VM
We highly suggest you use a virtualized environment to test your swizzin set up. It is extremely convenient to have this isolated from the rest of your system, and be able to discard and initialize a system within minutes.

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/customisations.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Below is a list of cusomtisations, scripts and repos that you can use to get som
Make sure to not update your swizzin from the git repo afterwards, as that could break your install. Please see the [section on updating](/dev/setup#updating-mechanism) in the dev documentation.
:::

:::success Check out our beta features too!
Our release cycle is a little slow due to a low amount of testers, so if you want to help out and provide feedback for us and get to use new apps and features before everyone else, please check out the [Beta testing docs](dev/beta-testing)
:::success Check out our pre-release features too!
We have a "fast" ring and a "slow" ring for our updates. Feel free to check out how to get the latest apps using our [Pre-release docs](dev/pre-release)
:::

<!--
Expand Down
Loading