From dba7afd4ff25d7ac823de1ce6586de162c976482 Mon Sep 17 00:00:00 2001 From: Silke Hofstra Date: Wed, 20 Sep 2023 17:08:48 +0200 Subject: [PATCH] Remove phab migration documentation (#379) The other documentation is sufficiently up to date that the warning can be removed. Rename the `.mdx` pages to `.md` to make GitHub render diffs again. --- docs/packaging/_markdown-migration-warning.md | 8 --- docs/packaging/creating-a-new-package.md | 1 - docs/packaging/{index.mdx => index.md} | 6 +- ...packaging.mdx => prepare-for-packaging.md} | 4 -- .../procedures/diff-to-pull-request.md | 58 ------------------- .../procedures/migrate-repos-to-github.md | 42 -------------- docs/packaging/submitting-a-pull-request.md | 3 +- docs/packaging/your-first-package-update.md | 7 +-- 8 files changed, 5 insertions(+), 124 deletions(-) delete mode 100644 docs/packaging/_markdown-migration-warning.md rename docs/packaging/{index.mdx => index.md} (91%) rename docs/packaging/{prepare-for-packaging.mdx => prepare-for-packaging.md} (98%) delete mode 100644 docs/packaging/procedures/diff-to-pull-request.md delete mode 100644 docs/packaging/procedures/migrate-repos-to-github.md diff --git a/docs/packaging/_markdown-migration-warning.md b/docs/packaging/_markdown-migration-warning.md deleted file mode 100644 index 5cd155e27..000000000 --- a/docs/packaging/_markdown-migration-warning.md +++ /dev/null @@ -1,8 +0,0 @@ -:::danger - -We are currently in the process of migrating our source repositories from Phabricator to GitHub. If you have any repos checked out from Phabricator, [migrate them](docs/packaging/procedures/migrate-repos-to-github.md) before proceeding. - -Updating all facets of the documentation will take some time. -If you notice any issues feel free to [file an issue](https://github.com/getsolus/help-center-docs/issues/new) on our docs tracker, or get in contact with us on our [Matrix](/docs/user/contributing/getting-involved#matrix-chat) channels. - -::: \ No newline at end of file diff --git a/docs/packaging/creating-a-new-package.md b/docs/packaging/creating-a-new-package.md index 392c1fd7c..5664fbc07 100644 --- a/docs/packaging/creating-a-new-package.md +++ b/docs/packaging/creating-a-new-package.md @@ -156,7 +156,6 @@ Once the build completes, your directory should now include the following files: ```text ├── abi_used_libs ├── abi_used_symbols -├── Makefile ├── package.yml ├── pspec_x86_64.xml └── tree-2.1.1-1-1-x86_64.eopkg diff --git a/docs/packaging/index.mdx b/docs/packaging/index.md similarity index 91% rename from docs/packaging/index.mdx rename to docs/packaging/index.md index b60d7e568..3e0484dd9 100644 --- a/docs/packaging/index.mdx +++ b/docs/packaging/index.md @@ -4,17 +4,13 @@ summary: Steps for setting up a packaging environment and submitting packages sidebar_position: 0 --- -import MigrationWarning from './_markdown-migration-warning.md'; - - - # Packaging Overview This is the overall workflow for creating or updating a package. ## Development Environment Preparation -1. [Prepare for Packaging](prepare-for-packaging.mdx) +1. [Prepare for Packaging](prepare-for-packaging.md) 2. Review the [requirements for the package.yml file](docs/packaging/package.yml.md). 3. Also review our [Packaging Practices](docs/packaging/packaging-practices.md). diff --git a/docs/packaging/prepare-for-packaging.mdx b/docs/packaging/prepare-for-packaging.md similarity index 98% rename from docs/packaging/prepare-for-packaging.mdx rename to docs/packaging/prepare-for-packaging.md index febb16abd..f9f2f6ee8 100644 --- a/docs/packaging/prepare-for-packaging.mdx +++ b/docs/packaging/prepare-for-packaging.md @@ -4,10 +4,6 @@ summary: Quick guide on getting your system set up for packaging on Solus sidebar_position: 1 --- -import MigrationWarning from './_markdown-migration-warning.md'; - - - # Prepare for Packaging ## Switch to the Unstable Repository diff --git a/docs/packaging/procedures/diff-to-pull-request.md b/docs/packaging/procedures/diff-to-pull-request.md deleted file mode 100644 index 347a97535..000000000 --- a/docs/packaging/procedures/diff-to-pull-request.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Diff to Pull Request -summary: How to make your Phabricator diff a GitHub Pull Request ---- - -# Open Diffs - -All but a few open package diffs on Phabricator were merged before the migration to GitHub. But what about the ones that weren't merged? Luckily, it should be a pretty straightforward process to turn your changes into a Pull Request on GitHub. - -This article will use our [Bottom](https://github.com/solus-packages/bottom) package as an example. - -To make the process even easier, we recommend installing `github-cli` (`sudo eopkg it github-cli`) to make working with GitHub a breeze. - -## Setup - -It would be a good idea to change the name of the directory to avoid a naming conflict when you fork and clone the new repository. - -```bash -cd ~/solus-builds # Change this to wherever your package packaging directory is -mv bottom bottom-old -``` - -The first step will be to fork the new GitHub repo. You can do this via GitHub's website, or via the command line. We'll use the command line here to help streamline the process. - -```bash -gh repo fork --clone solus-packages/bottom -``` - -This will create a fork of the Solus package under your user, in my case `EbonJaeger/bottom`. The command will also create a remote called `upstream` pointing to the repository in the `solus-packages` organization to make updating your copy easier, and the `--clone` option clones the fork to your disk. - -## Moving Your Commit - -Now to move your committed changes from the old repo to the new. Let's create a new branch in the newly cloned repository to work in. While not strictly necessary, it's a good practice to get in the habit of doing. - -```bash -cd bottom -git switch -c example-package-bump -``` - -Next, extract your commit from your old copy of the repository using `git format-patch`. Replace `bottom-old` below with the directory of your old repo. - -```bash -git --git-dir=../bottom-old/.git format-patch -k -1 --stdout HEAD | git am -3 -k -``` - -> **Breakdown:** This will take the latest commit from the repository passed to the `--git-dir` option as a patch, send it to *stdout*, and is applied to the current repository by piping it to `git am`, falling back to a three-way-merge if for some reason there is a merge conflict when applying the patch. - -Once this is complete, you can verify the operation with `git status` and `git log` to see that the commit was applied. - -Push the commit to your fork on GitHub with `git push`. - -## Creating a Pull Request - -You can now open a Pull Request as normal. This can be done from the website or from the command line: - -```bash -gh pr create --repo solus-packages/bottom -``` diff --git a/docs/packaging/procedures/migrate-repos-to-github.md b/docs/packaging/procedures/migrate-repos-to-github.md deleted file mode 100644 index 1e6a70574..000000000 --- a/docs/packaging/procedures/migrate-repos-to-github.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Migrating Existing Repos to GitHub -summary: Migrate Your Existing Repos From Phab to GitHub ---- - -# How To Migrate Pre-existing Repos and `common` to GitHub - -:::info -This is intended for people who have cloned package repos from Phabricator in the past. The information below will help you migrate your `common` repo and existing repo clones to work with our GitHub. -::: - -This document assumes your packages are stored under the folder `~/solus-builds`, adjust the commands to match the directory name on your system. - -People who have set up repos before the migration to GitHub will have git remote URLs pointing to dev.getsol.us. To see if this is the case, change to the common directory, and run the following to double check: - -``` bash -cd ~/solus-builds/common -❯ git remote -v -origin https://dev.getsol.us/source/common.git (fetch) -origin https://dev.getsol.us/source/common.git (push) - -``` - -You will need to make sure you are on the master branch and update the git remote URLs: - -```bash -cd ~/solus-builds/common -git switch master -git remote set-url origin https://github.com/getsolus/common -git remote set-url --push origin git@github.com:getsolus/common.git -git pull -git status -``` - -The output should indicate you are up to date with origin/master and that your working tree is clean. If not, please reach out to the Solus Packaging team on [Matrix](/docs/user/contributing/getting-involved#matrix-chat). - -Next, run this script to update all repos from Phab to GitHub: - -```bash -cd .. -./common/switch_repo_domains -``` \ No newline at end of file diff --git a/docs/packaging/submitting-a-pull-request.md b/docs/packaging/submitting-a-pull-request.md index bf6d28708..f7b6b664c 100644 --- a/docs/packaging/submitting-a-pull-request.md +++ b/docs/packaging/submitting-a-pull-request.md @@ -19,9 +19,8 @@ At minimum, your pull request will include changes for the following files: - `package.yml` - `pspec_*.xml` -It will also include these files: +It may also include these files: -- `Makefile` - `MAINTAINERS.md` Double check the `package.yml` to make sure the builddeps are in the right order, and that it otherwise adheres to the [standards](package.yml.md) Solus has set. diff --git a/docs/packaging/your-first-package-update.md b/docs/packaging/your-first-package-update.md index 94016ea97..ac879928f 100644 --- a/docs/packaging/your-first-package-update.md +++ b/docs/packaging/your-first-package-update.md @@ -5,7 +5,7 @@ summary: An example of how to build a package that exists in the Solus repos for # Your First Package Update -This page will guide you through the steps required to build your first package. This is really a test to make sure that your [build environment is set up correctly](docs/packaging/prepare-for-packaging.mdx). You will clone an existing package, build it, then install it, and finally remove it. +This page will guide you through the steps required to build your first package. This is really a test to make sure that your [build environment is set up correctly](docs/packaging/prepare-for-packaging.md). You will clone an existing package, build it, then install it, and finally remove it. ## Cloning and building `nano` @@ -58,10 +58,9 @@ You will be prompted to enter your password by sudo, and the `solbuild` tool wil If the build is successful, you will have a `nano` package file with a name like `nano-7.2-161-1-x86_64.eopkg`. Run the `ls` tool to check the exact name: ```bash -ls - +$ ls abi_used_libs files package.yml -abi_used_symbols Makefile nano-7.2-162-1-x86_64.eopkg pspec_x86_64.xml +abi_used_symbols nano-7.2-162-1-x86_64.eopkg pspec_x86_64.xml ``` Congratulations! You have successfully built your first package on Solus.