New-repo
New repositories should be created in Phabricator and mirrored to GitHub.
Procedure depends if you can or not create a repository in Nasqueron orgz on GitHub. To do so, you must be a member of the Nasqueron orgz on GitHub, something you can ask to @dereckson
From 2020-09-25, any new repository should use main instead of master as the reference branch.
You would like to clone a repository already initialized
From experience, we know to create a repository correctly is not an easy task,
especially with traps like how to do the first commit with Arcanist or not
populate the GitHub mirror.
As such, the easiest is to just ask us to create the repository,
and watch the different steps we used for your next one.
You want to do it yourself
You have don't have access to GitHub
- Create the repository here
- Create a task against DevCentral project to require to mirror it to GitHub, with a link to this document
You have access to GitHub
DevCentral
- Generate a deployment SSH key to allow GitHub interaction, save it
- Name: Deployment key for GitHub nasqueron/foo
- Lock permanently: check
- Create the repository
- Name: the descriptive, typography-rich repository name, e.g. Phantom and Ghosts
- Callsign: a short uppercase symbol, like an abbreviation, e.g. PG
- Short name: the name of the repository folder when you clone it, e.g. phantom-ghosts
- Add a new remote URI
- URI: git@github.com:nasqueron/foo.git
- I/O type: Mirror
- Display type: Default (= hidden)
- Change default branch to main (manage > branches)
- Activate the repository (manage > basics)
- Tag it with a project (Notifications center will use it to know where announce related events)
GitHub
- Create a new repository with hub create nasqueron/foo or visiting https://github.com/new?owner=nasqueron
- Privacy : Check Public option
- Add a README file : Don't check the box, as the repository should be created empty. First commits should be reviewed on DevCentral too.
- Go to https://github.com/nasqueron/foo where foo is the repository name
- Add the deploy key to https://github.com/nasqueron/foo/settings/keys
- You can copy the public part of the key by visiting your secret and selecting in the right menu Show public key.
- Use something like DevCentral (K00) where K00 is the Passphrase object as title
- Allow write access
- Consider to add the repo to a relevant team: https://github.com/orgs/nasqueron/teams
What to do afterwards?
You may create and commit the following files:
.arcconfig | The callsign and the DevCentral URL |
.arclint | Linters configuration |
LICENSE | When in doubt, use BSD-2-Clause |
README or README.md | Relevant pointers to get started with the repository code |
Special tags
Those projects-as-a-tag allow to tag repositories for a specific purpose:
Python package | Indicate the repository is for a Python package |
Not audited repository | Don't trigger an audit for commits not associated to code review |
- Last Author
- dereckson
- Last Edited
- Nov 20 2024, 19:14