Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 579554 - repo/user/ssnb
Summary: repo/user/ssnb
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Infrastructure
Classification: Unclassified
Component: Gentoo Overlays (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Overlays Project
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-04-11 01:40 UTC by Samuel Bernardo
Modified: 2016-06-24 05:45 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
ssh public key (ssnb-overlay_rsa.pub,759 bytes, application/vnd.ms-publisher)
2016-04-11 01:40 UTC, Samuel Bernardo
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Samuel Bernardo 2016-04-11 01:40:16 UTC
Created attachment 430082 [details]
ssh public key

I opened this bug report to ask you for a repo in overlay.gentoo.org.

I would like to add my user overlay to overlay.gentoo.org repository to not bother about github push/pull rate limits in free repositories.

I pretend to add the following overlay:
repo/user/ssnb

My actual repository.xml would be like this with my actual github repository
<?xml version="1.0" encoding="UTF-8"?>
<repositories version="1.0">
  <repo priority="-2500" quality="experimental" status="unofficial">
    <name>ssnb</name>
    <description>Gentoo repository made by ssnb.</description>
    <homepage>https://github.com/samuelbernardo/ssnb-overlay</homepage>
    <owner>
      <email>samuelbernardo.mail@gmail.com</email>
      <name>Samuel Bernardo</name>
    </owner>
    <source type="git">https://github.com/samuelbernardo/ssnb-overlay.git</source>
    <feed>https://github.com/samuelbernardo/ssnb-overlay/commits/master.atom</feed>
  </repo>
</repositories>

Since I'm using repos.conf/ssnb.conf to keep it in my local repos:
[ssnb]
priority = -2500
location = /usr/local/overlay/ssnb
masters = gentoo
sync-type = git
sync-uri = git@github.com:samuelbernardo/ssnb-overlay.git
auto-sync = yes

I have my public overlay published at github for you to review:
https://github.com/samuelbernardo/ssnb-overlay

My ssh public key is in attachment.
Comment 1 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2016-04-11 07:39:07 UTC
Your user overlay "ssnb" is almost ready.
Please read (all of) this guide to get it to work.

If you have any question we'll be here to help.


In this Guide
=============
- Terms of Service
- The Initial Push
- After That
  - Online Browsing
  - Getting into Layman
  - Keeping your overlay healthy


Terms of Service
================
The infra team has worked out the terms of service for us. To make us host your user overlay you need to accept these terms, which I don't expect to be a problem. By pushing to the remote repository you are accepting these terms:

  -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
  Use of this service is  limited to overlays containing ebuilds
  and  supporting  files  (e.g.  init.d  scripts,  configuration
  files, patches,  but not distfiles)  and must follow  the same
  guidelines as apply to the gentoo-x86 tree of Gentoo.

  Any or all uses of this  service and all files on this service
  may  be  intercepted,  monitored, recorded,  copied,  audited,
  inspected, and disclosed to authorized site personnel, as well
  as authorized  officials of federal law  enforcement agencies,
  both domestic  and foreign.  By  using this service,  the user
  consents to such interception, monitoring, recording, copying,
  auditing,  inspection, and  disclosure  at  the discretion  of
  authorized site  personnel.  Use  of this  service constitutes
  consent to  security monitoring and testing.   All activity is
  logged with  your host name  and IP address.   Unauthorized or
  improper use of this service  may result in civil and criminal
  penalties.   By continuing  to use  this service  you indicate
  your awareness of and consent to these terms and conditions of
  use.   -- Gentoo Linux Infrastructure Admins

                      CEASE USE IMMEDIATELY,
   if you do not agree to the conditions stated in this warning.
                       *******************
  -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --


The Initial Push
================

First, before anybody can clone from your overlay an initial push is needed.

0) If you start with an empty repository be sure to setup your identity:

     # git init
     # git config user.name 'first last'
     # git config user.email foo@example.org
     [..]

1) Once you have ebuilds in there please set profiles/repo_name to
   'ssnb' in order to make it a valid overlay. Unless your ebuilds
   do not require any eclasses or licenses, and do not depend on any
   packages from Gentoo, set masters=gentoo in metadata/layout.conf
   as well.

     # mkdir metadata profiles
     # echo "masters = gentoo" > metadata/layout.conf
     # echo "ssnb" > profiles/repo_name
     # git add metadata/layout.conf profiles/repo_name
     # git commit

2) Now you are ready to push.  Proposed way of doing is this:

     # git remote add overlays-gentoo-org \
           git+ssh://git@git.gentoo.org/repo/user/ssnb.git
     # git push overlays-gentoo-org master


After That
==========

Online Browsing
---------------
After the initial push you can browse your overlay online at:
https://gitweb.gentoo.org/repo/user/ssnb.git/


Getting into Layman
-------------------
We have scripts to get hosted overlay into Layman easily: no need to write XML on your end.  Just let us know that you did complete the procedure from "The Initial Push" to get added.

Once it's in the Layman registry its content will be indexed at http://gpo.zugaina.org/ and two dedicated views of your overlay will appear at http://gentoo-overlays.zugaina.org/ssnb/ and http://gpo.zugaina.org/Overlays/ssnb/, too.


Keeping your overlay healthy
----------------------------
A few rules of thumb help to keep your overlay most useful to you and others:

 - If you package newer versions of software that is packaged in Gentoo
   already, try to get the version in Gentoo updated, too.
   (If there is no bump request on https://bugs.gentoo.org/ please file
   one and share patches you may have produced.)

 - If you apply custom patches make sure that you never use the very
   same revision that is used in Gentoo, e.g. if you use the ebuild
   of app-arch/bzip2-1.0.6-r3 do not call it app-arch/bzip2-1.0.6-r3
   in your overlay to avoid confusion.

A tool called "overlint" can support you with that process:

  # sudo emerge -av app-portage/overlint

For a quick introduction to overlint see http://blog.hartwork.org/?p=1667 .


Michał Górny
for the Gentoo Overlays Team
Comment 2 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2016-06-21 10:53:17 UTC
Samuel, it seems that you are actively using your repository yet you haven't requesting adding it to the official list yet. Would you like me to do that now?
Comment 3 Samuel Bernardo 2016-06-21 21:51:08 UTC
(In reply to Michał Górny from comment #2)
> Samuel, it seems that you are actively using your repository yet you haven't
> requesting adding it to the official list yet. Would you like me to do that
> now?

Yes please.
Sorry my misunderstanding, but I thought that it would happen eventually after my first push.

Thank you for keeping gentoo!
Comment 4 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2016-06-23 14:10:06 UTC
Added. It should appear in a few minutes. Thanks.
Comment 5 Samuel Bernardo 2016-06-23 22:59:22 UTC
(In reply to Michał Górny from comment #4)
> Added. It should appear in a few minutes. Thanks.

Is the folloing URL right for my overlay?
http://gentoo-overlays.zugaina.org/ssnb/

This gives me

Request headers
GET /ssnb/ HTTP/1.1
Host: gentoo-overlays.zugaina.org
Connection: keep-alive
Cache-Control: max-age=0
Upgrade-Insecure-Requests: 1
User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Accept-Encoding: gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8,pt;q=0.6

Response headers
HTTP/1.1 404 Not Found
Server: nginx/1.11.1
Date: Thu, 23 Jun 2016 23:00:01 GMT
Content-Type: text/html; charset=iso-8859-1
Content-Length: 203
Connection: keep-alive
Keep-Alive: timeout=120

Thanks
Comment 6 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2016-06-24 05:45:03 UTC
It seems that this is an outdated address. The top page [1] says it's updated every week. The gpo variant [2] is the modern one but it also doesn't have your overlay yet; you will probably have to wait a while more. It's already on the list [3] on our end.

[1]:http://gentoo-overlays.zugaina.org/
[2]:http://gpo.zugaina.org/Overlays
[3]:https://overlays.gentoo.org/