infra-docs-fpo/modules/sysadmin_guide/pages/github.adoc
Michal Konečný a4d85a492a Review github SOP
Signed-off-by: Michal Konečný <mkonecny@redhat.com>
2021-08-24 13:30:21 +02:00

70 lines
2.3 KiB
Text

= Using github for Infra Projects
We're presently using github to host git repositories and issue tracking
for some infrastructure projects. Anything we need to know should be
recorded here.
== Setting up a new repo
Create projects inside of the fedora-infra group:
https://github.com/fedora-infra
That will allow us to more easily track what projects we have.
*TODO*: How do we create a new project and import it?
* After creating a new repo, click on the Settings tab to set up some
fancy things.
+
If using git-flow for your project:
+
** Set the default branch from _master_ to _develop_. Having the default
branch be _develop_ is nice: new contributors will automatically start
committing there if they're not paying attention to what branch they're
on. You almost never want to commit directly to the master branch.
+
If there does not exist a _develop_ branch, you should create one by
branching off of _master_:
+
....
$ git clone GIT_URL
$ git checkout -b develop
$ git push --all
....
** Set up an IRC hook for notifications. From the `Settings` tab click
on `Webhooks & Services`. Under the `Add Service` dropdown, find `IRC`
and click it. You might need to enter your password. In the form, you
probably want the following values:
*** Server, irc.freenode.net
*** Port, 6697
*** Room, #fedora-apps
*** Nick, <nothing>
*** Branch Regexes, <nothing>
*** Password, <nothing>
*** Ssl, <on>
*** Message Without Join, <on>
*** No Colors, <off>
*** Long Url, <off>
*** Notice, <on>
*** Active, <on>
== Add an EasyFix label
The EasyFix label is used to mark bugs that are potentially fixable by
new contributors getting used to our source code or relatively new to
python programming. GitHub doesn't provide this label automatically so
we have to add it. You can add the label from the issues page of the
repository or use this curl command to add it:
....
curl -k -u '$GITHUB_USERNAME:$GITHUB_PASSWORD' https://api.github.com/repos/fedora-infra/python-fedora/labels -H "Content-Type: application/json" -d '{"name":"EasyFix","color":"3b6eb4"}'
....
Please try to use the same color for consistency between Fedora
Infrastructure Projects. You can then add the github repo to the list
that _easyfix.fedoraproject.org_ scans for easyfix tickets here:
https://fedoraproject.org/wiki/Easyfix