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

prepare-for-packaging.md: Add git identy setup #505

Merged
merged 3 commits into from
Mar 5, 2024
Merged
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
13 changes: 12 additions & 1 deletion docs/packaging/prepare-for-packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
sudo eopkg it go-task git github-cli jq solbuild solbuild-config-unstable ypkg
```

## Setting up a GitHub account
## Setting up a GitHub account and Git

The Solus source repositories for the package repository currently reside on [github.com/getsolus/packages](https://github.com/getsolus/packages). You will need a GitHub account to submit patches and file issues. You can create a GitHub account [here](https://github.com/signup). Note that you will also need to set up [2FA](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa) (two factor authentication) for your account.

Expand All @@ -54,6 +54,17 @@

See the [GitHub CLI quickstart](https://docs.github.com/en/github-cli/github-cli/quickstart) for some common uses of the tool.

### Git identity setup

If you have not used git before, you should set your git identity in your global git config file (`~/.gitconfig`). Use the following commands:

```bash
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
```

See the [Git Book](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for more first-time setup options.

## Setting up solbuild

The `solbuild` tool must first be initialized with a base image. All builds thereafter will use this as a base, and construct a temporary overlay root to save on time and disk space in builds.
Expand Down Expand Up @@ -85,7 +96,7 @@
Create a local clone of the package repository you just forked. Here we are using the name `solus-packages` and cloning it into our home directoy. The rest of the documentation will presume this structure. You can choose a different name and path but will have to make sure to replace it in every command that refers to the `solus-packages` directory.

```bash
gh repo clone packages ~/solus-packages

Check warning on line 99 in docs/packaging/prepare-for-packaging.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (repo)
```

## Initialize git hooks
Expand Down