BioArchLinux/Packages
2
0
Fork 0
mirror of https://github.com/BioArchLinux/Packages.git synced 2025-03-10 12:02:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

*: Documentation for adding packages to repo (#227)

Browse source 
* adding packages: initial documentation

* *: polish some format

---------

Co-authored-by: Kuoi <kuoi@bioarchlinux.org>
This commit is contained in:
Bipin Kumar 2024-12-13 19:47:30 +05:30 • committed by GitHub
parent 39b40da465
commit 5f059be696
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
Documentation/adding packages.md Normal file
View file

@ -0,0 +1,31 @@
# How to add packages to repo
Thanks for you interest in contributing packages to repo. Before submitting packages make sure your `PKGBUILD` is in line with packaging guidelines as outlined in [Arch Wiki](https://wiki.archlinux.org/title/PKGBUILD) and can be built in [clean chroot](https://wiki.archlinux.org/title/DeveloperWiki:Building_in_a_clean_chroot#Classic_way). This document also assumes you have signed up for github account and has setup ssh keys as outlined in github [documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh)
1. create a fork of the [Bioarchlinux Packages](https://github.com/BioArchLinux/Packages) repo and clone it locally.
```
git clone <ssh link to your forked repo>
```
2. Create a new branch for the package you wish to add.
```
git checkout -b <pkgname>
```
3. Set bioarchlinux repo as upstream for the branch.
```
git remote add upstream https://github.com/BioArchLinux/Packages.git
```
4. make the required changes such as adding respective package folder containing PKGBUILD and lilac.yaml files into the **Bioarchlinux** folder. The folder structure should look like this,
```
BioArchLinux/<pkgname>/
├── lilac.yaml
└── PKGBUILD
```
5. commit the changes by
```
git add <changed file name goes here>
git commit -m "pkgname: adding version *xxx.yyy*"
```
6. push the changes by,
```
git push -u origin <pkgname>
```
7. [ctrl]+left click the output URL to open pull request in a browser.
8. Wait for review and approval for PR to be merged.

3
README.md
View file

@ -59,3 +59,6 @@ You can use [junest](https://github.com/fsquillace/junest) BioArchLinux image to
> Zhang G. Hu Y. Drobot V. Staal J. Yi Y. Elliot MG. 2022. BioArchLinux: bioinformatics community with Arch Linux. F1000Research 11: 809. https://doi.org/10.7490/f1000research.1119039.1
[Get Bibtex Here](https://raw.githubusercontent.com/BioArchLinux/Packages/master/BioArchLinux.bibtex)
## Submitting packages
Those wishing to submit 'PKGBUILD' for packages to repo please refer to [adding packages](/Documentation/adding%20packages.md) document