RFC: github PR workflow

[Jakub Hrozek]

Hi,

I documented workflow that we could use for submitting PRs:
    https://fedorahosted.org/sssd/wiki/GithubWorkflow

It's quite similar to what the FreeIPA team uses (although I don't think
they publicly document it yet).

Comments or edits welcome. If there are none, I'll link the page from
the Contribute page later.

[Petr Cech]

On 08/31/2016 10:28 AM, Jakub Hrozek wrote:
> Hi,
>
> I documented workflow that we could use for submitting PRs:
>     https://fedorahosted.org/sssd/wiki/GithubWorkflow
>
> It's quite similar to what the FreeIPA team uses (although I don't think
> they publicly document it yet).
>
> Comments or edits welcome. If there are none, I'll link the page from
> the Contribute page later.

Hello,

I have note to 'Submitting a pull-request'.
Now we advice to:
* use github repo,
* fork it,
* add it like remote.

If I understand correctly there is no reason
for contributors to clone original
fedorahosted repo. Is it right?

We should rewrite Contribute wiki page in this manner.

Regards

[Jakub Hrozek]

On Thu, Sep 01, 2016 at 09:49:50AM +0200, Petr Cech wrote:
> On 08/31/2016 10:28 AM, Jakub Hrozek wrote:
> > Hi,
> >
> > I documented workflow that we could use for submitting PRs:
> >     https://fedorahosted.org/sssd/wiki/GithubWorkflow
> >
> > It's quite similar to what the FreeIPA team uses (although I don't think
> > they publicly document it yet).
> >
> > Comments or edits welcome. If there are none, I'll link the page from
> > the Contribute page later.
>
> Hello,
>
> I have note to 'Submitting a pull-request'.
> Now we advice to:
> use github repo,
> fork it,
> add it like remote.
>
> If I understand correctly there is no reason
> for contributors to clone original
> fedorahosted repo. Is it right?

Yeah, you can clone github/sssd/sssd.git directly. Only those who want
to push need to clone the fedorahosted repo.

(Cloning fedorahosted would also make sure you always get the canonical
sources i ncase the fedorahosted->github mirroring breaks or in case we
move away from github in the future..)
> We should rewrite Contribute wiki page in this manner.

Yes, I'll do that later today I guess.

[Lukas Slebodnik]

On (01/09/16 10:30), Jakub Hrozek wrote:
> On Thu, Sep 01, 2016 at 09:49:50AM +0200, Petr Cech wrote:
> > On 08/31/2016 10:28 AM, Jakub Hrozek wrote:
> > > Hi,
> > >
> > > I documented workflow that we could use for submitting PRs:
> > >     https://fedorahosted.org/sssd/wiki/GithubWorkflow
> > >
> > > It's quite similar to what the FreeIPA team uses (although I don't think
> > > they publicly document it yet).
> > >
> > > Comments or edits welcome. If there are none, I'll link the page from
> > > the Contribute page later.
> >
> > Hello,
> >
> > I have note to 'Submitting a pull-request'.
> > Now we advice to:
> > use github repo,
> > fork it,
> > add it like remote.
> >
> > If I understand correctly there is no reason
> > for contributors to clone original
> > fedorahosted repo. Is it right?
>
> Yeah, you can clone github/sssd/sssd.git directly. Only those who want
> to push need to clone the fedorahosted repo.
>
> (Cloning fedorahosted would also make sure you always get the canonical
> sources i ncase the fedorahosted->github mirroring breaks or in case we
> move away from github in the future..)
> > We should rewrite Contribute wiki page in this manner.
>
> Yes, I'll do that later today I guess.

I do not agree.
github workflow wiki says: "Github pull requests are the preferred way"
It does not say it is a only way how to contribute
So fedorahosted repo is a primary repo therefore it should be
listed in the "Contribute wiki" page.

BTW editing .git/config is error prone; especially if name of remote repo
is not a "github"
e.g. hint
    [remote "github"]
    url = https://github.com/SSSD/sssd.git
    fetch = +refs/heads/*:refs/remotes/github/*
    fetch = +refs/pull/*/head:refs/remotes/github/pull/*

It would be better to use "git config"
e.g
GITHUB_REMOTE="gh"
git config --add remote.$GITHUB_REMOTE.fetch \
                 "+refs/pull/*/head:refs/remotes/$GITHUB_REMOTE/pull/*"

LS

[Jakub Hrozek]

On Thu, Sep 01, 2016 at 12:10:15PM +0200, Lukas Slebodnik wrote:
> On (01/09/16 10:30), Jakub Hrozek wrote:
> > On Thu, Sep 01, 2016 at 09:49:50AM +0200, Petr Cech wrote:
> > > On 08/31/2016 10:28 AM, Jakub Hrozek wrote:
> > > > Hi,
> > > >
> > > > I documented workflow that we could use for submitting PRs:
> > > >     https://fedorahosted.org/sssd/wiki/GithubWorkflow
> > > >
> > > > It's quite similar to what the FreeIPA team uses (although I don't think
> > > > they publicly document it yet).
> > > >
> > > > Comments or edits welcome. If there are none, I'll link the page from
> > > > the Contribute page later.
> > >
> > > Hello,
> > >
> > > I have note to 'Submitting a pull-request'.
> > > Now we advice to:
> > > use github repo,
> > > fork it,
> > > add it like remote.
> > >
> > > If I understand correctly there is no reason
> > > for contributors to clone original
> > > fedorahosted repo. Is it right?
> >
> > Yeah, you can clone github/sssd/sssd.git directly. Only those who want
> > to push need to clone the fedorahosted repo.
> >
> > (Cloning fedorahosted would also make sure you always get the canonical
> > sources i ncase the fedorahosted->github mirroring breaks or in case we
> > move away from github in the future..)
> > > We should rewrite Contribute wiki page in this manner.
> >
> > Yes, I'll do that later today I guess.
>
> I do not agree.
> github workflow wiki says: "Github pull requests are the preferred way"
> It does not say it is a only way how to contribute
> So fedorahosted repo is a primary repo therefore it should be
> listed in the "Contribute wiki" page.
>
> BTW editing .git/config is error prone; especially if name of remote repo
> is not a "github"
> e.g. hint
>     [remote "github"]
>     url = https://github.com/SSSD/sssd.git
>     fetch = +refs/heads/*:refs/remotes/github/*
>     fetch = +refs/pull/*/head:refs/remotes/github/pull/*
>
> It would be better to use "git config"
> e.g
> GITHUB_REMOTE="gh"
> git config --add remote.$GITHUB_REMOTE.fetch \
>                  "+refs/pull/*/head:refs/remotes/$GITHUB_REMOTE/pull/*"

OK, please edit the wiki.

[Lukas Slebodnik]

On (01/09/16 12:29), Jakub Hrozek wrote:
> On Thu, Sep 01, 2016 at 12:10:15PM +0200, Lukas Slebodnik wrote:
> > On (01/09/16 10:30), Jakub Hrozek wrote:
> > > On Thu, Sep 01, 2016 at 09:49:50AM +0200, Petr Cech wrote:
> > > > On 08/31/2016 10:28 AM, Jakub Hrozek wrote:
> > > > > Hi,
> > > > >
> > > > > I documented workflow that we could use for submitting PRs:
> > > > >     https://fedorahosted.org/sssd/wiki/GithubWorkflow
> > > > >
> > > > > It's quite similar to what the FreeIPA team uses (although I don't think
> > > > > they publicly document it yet).
> > > > >
> > > > > Comments or edits welcome. If there are none, I'll link the page from
> > > > > the Contribute page later.
> > > >
> > > > Hello,
> > > >
> > > > I have note to 'Submitting a pull-request'.
> > > > Now we advice to:
> > > > use github repo,
> > > > fork it,
> > > > add it like remote.
> > > >
> > > > If I understand correctly there is no reason
> > > > for contributors to clone original
> > > > fedorahosted repo. Is it right?
> > >
> > > Yeah, you can clone github/sssd/sssd.git directly. Only those who want
> > > to push need to clone the fedorahosted repo.
> > >
> > > (Cloning fedorahosted would also make sure you always get the canonical
> > > sources i ncase the fedorahosted->github mirroring breaks or in case we
> > > move away from github in the future..)
> > > > We should rewrite Contribute wiki page in this manner.
> > >
> > > Yes, I'll do that later today I guess.
> >
> > I do not agree.
> > github workflow wiki says: "Github pull requests are the preferred way"
> > It does not say it is a only way how to contribute
> > So fedorahosted repo is a primary repo therefore it should be
> > listed in the "Contribute wiki" page.
> >
> > BTW editing .git/config is error prone; especially if name of remote repo
> > is not a "github"
> > e.g. hint
> >     [remote "github"]
> >     url = https://github.com/SSSD/sssd.git
> >     fetch = +refs/heads/*:refs/remotes/github/*
> >     fetch = +refs/pull/*/head:refs/remotes/github/pull/*
> >
> > It would be better to use "git config"
> > e.g
> > GITHUB_REMOTE="gh"
> > git config --add remote.$GITHUB_REMOTE.fetch \
> >                  "+refs/pull/*/head:refs/remotes/$GITHUB_REMOTE/pull/*"
>
> OK, please edit the wiki.

In previous mail, you wrote: "Yes, I'll do that later today I guess."
So I would be good if you could chage it in the same time.
Thank you very much in advance.

LS

[Jakub Hrozek]

On Thu, Sep 01, 2016 at 01:11:54PM +0200, Lukas Slebodnik wrote:
> On (01/09/16 12:29), Jakub Hrozek wrote:
> > On Thu, Sep 01, 2016 at 12:10:15PM +0200, Lukas Slebodnik wrote:
> > > On (01/09/16 10:30), Jakub Hrozek wrote:
> > > > On Thu, Sep 01, 2016 at 09:49:50AM +0200, Petr Cech wrote:
> > > > > On 08/31/2016 10:28 AM, Jakub Hrozek wrote:
> > > > > > Hi,
> > > > > >
> > > > > > I documented workflow that we could use for submitting PRs:
> > > > > >     https://fedorahosted.org/sssd/wiki/GithubWorkflow
> > > > > >
> > > > > > It's quite similar to what the FreeIPA team uses (although I don't think
> > > > > > they publicly document it yet).
> > > > > >
> > > > > > Comments or edits welcome. If there are none, I'll link the page from
> > > > > > the Contribute page later.
> > > > >
> > > > > Hello,
> > > > >
> > > > > I have note to 'Submitting a pull-request'.
> > > > > Now we advice to:
> > > > > use github repo,
> > > > > fork it,
> > > > > add it like remote.
> > > > >
> > > > > If I understand correctly there is no reason
> > > > > for contributors to clone original
> > > > > fedorahosted repo. Is it right?
> > > >
> > > > Yeah, you can clone github/sssd/sssd.git directly. Only those who want
> > > > to push need to clone the fedorahosted repo.
> > > >
> > > > (Cloning fedorahosted would also make sure you always get the canonical
> > > > sources i ncase the fedorahosted->github mirroring breaks or in case we
> > > > move away from github in the future..)
> > > > > We should rewrite Contribute wiki page in this manner.
> > > >
> > > > Yes, I'll do that later today I guess.
> > >
> > > I do not agree.
> > > github workflow wiki says: "Github pull requests are the preferred way"
> > > It does not say it is a only way how to contribute
> > > So fedorahosted repo is a primary repo therefore it should be
> > > listed in the "Contribute wiki" page.
> > >
> > > BTW editing .git/config is error prone; especially if name of remote repo
> > > is not a "github"
> > > e.g. hint
> > >     [remote "github"]
> > >     url = https://github.com/SSSD/sssd.git
> > >     fetch = +refs/heads/*:refs/remotes/github/*
> > >     fetch = +refs/pull/*/head:refs/remotes/github/pull/*
> > >
> > > It would be better to use "git config"
> > > e.g
> > > GITHUB_REMOTE="gh"
> > > git config --add remote.$GITHUB_REMOTE.fetch \
> > >                  "+refs/pull/*/head:refs/remotes/$GITHUB_REMOTE/pull/*"
> >
> > OK, please edit the wiki.
>
> In previous mail, you wrote: "Yes, I'll do that later today I guess."
> So I would be good if you could chage it in the same time.
> Thank you very much in advance.

I added the git workflow page from the "Contribute" page. If there's
something odd, please just edit the wiki..

[Jakub Hrozek]

On Fri, Sep 16, 2016 at 10:45:52AM +0200, Jakub Hrozek wrote:
> I added the git workflow page from the "Contribute" page. If there's
> something odd, please just edit the wiki..

I also added a quick note to show how to allow pull requests from
developers outside the team to run through CI:
    https://fedorahosted.org/sssd/wiki/GithubWorkflow?action=diff&version=8&...