You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

(warning) This page does not at all covering every piece of general information, be we have to start somewhere. Contributions/Reviews are welcome! (warning)

This page outlines some of the most commonly referenced information for committers.

Setting up your committer account

You should received an email detailing how to setup your committer account. However, here are some of the additional useful information.

You will be able to find out some commonly asked questions. Such as: how to setup local dev environments for managing commits, merge pull requests; how to setup your ASF LDAP account to manage JIRA tickets as well as wiki edits; etc.

Submit ICLA form

The first step is to fill and sign the ICLA submission form, send it to secretary@apache.org and get confirmation from an Apache secretary.

The ICLA submission form also contains your preferred account id. Check that the preferred id is not already used by other committers here.

This will enable and trigger creation of your Apache account.

Tips for email setup

Your new apache email address will be <your id>@apache.org. By default, all its incoming messages will be forwarded to an email address filled in the ICLA submission form. So if you want to have a dedicated email setup for apache mail (where e.g. you respond to messages as '<your id>@apache.org') you can setup it before hand and fill into the ICLA submission form. For example, Gmail has nice features to integrate with an apache account: Settings → Accounts and Import → Send mail as → Add another email address → Email address → <your id>@apache.org, once it is added you can make it default. It is convenient to have this setup to not switch between email addresses to reply from all the time.

Apache guide to new committer

The ASF website has a very handy guide for new committers. Please first follow the instructions to setup your new committer accounts.

Linking Github account

Flink project is currently hosted on GitBox. Thus committers can directly push to Github repository.

You will have to setup your own Github account in order to be able to directly push Apache/Flink Github repository. Please use the GitBox Account Linking Utility to link your personal Github account to your ASF LDAP account.

Merging personal JIRA account and ASF LDAP account

Some of us are managing multiple ASF JIRA accounts. For example, one can have an early contributor JIRA account while later during committer onboarding, an ASF LDAP committer account was created. Sometimes you will find it useful to merge these different accounts of yours under the one-single ASF LDAP account.

Unfortunately there’s no self-service way to merge accounts at this moment. If you wish to merge your personal JIRA account with your newly created ASF LDAP account, you need to file an INFRA JIRA ticket (similar to this one) to have your accounts merged. 

Wiki edit permissions

You might find out that you do not have edit permission to the Apache Flink wiki page. Unfortunately, the Apache Flink Wiki page editing privilege is currently still managed separately from the ASF LDAP permission. If you find yourself missing wiki edit permissions, please follow the normal procedure: email your JIRA account (preferably your ASF LDAP account) to dev@apache.flink.org in order to request for permission.

GitBox vs. Github

Flink project is currently hosted on GitBox. So there are two ways to setup your fetch/push privilege as committer. 

(warning) NOTE: Due to recently found synchronization issue between GitBox and Github repositories, committers should only use Github repositories for pushing commits.

Using Github

  1. Make sure you following the setup to link your Github account with your ASF account.

  2. Use the following remote as your push/fetch:

    Github settings
    > git remote add <remote_name> git@github.com:apache/flink

    For example, if you are setting up a remote "github", your setup should look like this:

    Github settings
    > git remote -v
github  git@github.com:apache/flink (fetch)
github  git@github.com:apache/flink (push)

Using GitBox

Using GitBox, you are not required to link your Github account using the utility. Your remote setup should look like the following:

Github settings
> git remote -v
gitbox  https://gitbox.apache.org/repos/asf/flink.git (fetch)
gitbox  https://gitbox.apache.org/repos/asf/flink.git (push)



  • No labels