...
This is documented in the Sling Aggregator Github module.
Gitiquette
Force pushing to the master branch, or to other branches that are shared with others, is discouraged. It makes collaboration harder and potentially impacts other tools as well - Jenkins, SonarCloud, etc. If you need time experimenting and fiddling with history, it's better to start working with an individual repository and then bring it to Sling, once it's stable.
Merging pull requests from contributors
Maintaining a linear history in git is preferred, especially for small contributions. Each commit should be buildable and correct by itself, as much as possible. This is beneficial when reviewing history for changes and also when running git bisect
.
In practice, we have found that:
- for contributions which require no additional fixes we should use the 'Rebase and merge' workflow
- for contributions which require fixes
- in case of a single logical commit we should use the 'Squash and merge' workflow to create a single commit. This creates a fast-forward merge, so no merge commit.
- in case of multiple separate commits we should ask the reviewer to amend the original commits with the fixes and force-push the branch that is the source of the PR
- using the 'merge' button for PRs should be the exception
It is also important to maintain the original author of the pull request, giving them credit for their contribution. This is also useful when compiling various contribution metrics, e.g. in Kibble.
Accepting new significant contributions
When accepting an external contribution we will import it into the sling-whiteboard
repository. Before making a new release, we will move it to its own repository with the release manager also proposing a proper artifact id and therefore repository name.
...
See a recent example below
Note | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Sling uses the default branch name
See also the discussion from
|
Permission propagation
The scripts will be created in gitbox and github at the same time, but permissions will be granted to the GitHub repository sometime later, due to the way ASF infra tooling works. If permissions don't appear in two hours, raise an INFRA ticket. In the meantime you can use the gitbox backend to push your changes.
...
Reference: https://help.github.com/en/articles/splitting-a-subfolder-out-into-a-new-repository
Maven SCM settings
The SCM settings from the pom.xml file are read by various tools, but most often used by the maven-scm-plugin
when releasing. We set the connection and developerScm settings to reference the ASF-maintained gitbox service, but use GitHub for the URL since it offers a better browsing experience and receives special treatment from some tools, such as renovate.
Code Block | ||||
---|---|---|---|---|
| ||||
<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-$MODULE.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-$MODULE.git</developerConnection>
<url>https://github.com/apache/sling-org-apache-sling-$MODULE.git</url>
</scm>
|
Update the repo manifest
Regenerate the default.xml manifest form the sling-aggregator repo using groovy collect-sling-repos.groovy > default.xml
.
Update local Sling repo checkout
Execute the following comman in the root of the Sling repo checkout
Code Block | ||||
---|---|---|---|---|
| ||||
$ repo sync -j 16
$ cd ${NEW_REPO}
$ git checkout master |
Boilerplate files
Ensure that at a minimum the repository contains the following files:
...
Most of the files can be copied from any repository. We'll use org-apache-sling-api
as an example.
Code Block | ||||
---|---|---|---|---|
| ||||
$ cd org-apache-sling-api $ cp CODE_OF_CONDUCT.md |
...
CONTRIBUTING.md Jenkinsfile LICENSE .gitignore ../${NEW_REPO} |
Generate a default .asf.yaml
file and update it, if applicable:
Code Block | ||||
---|---|---|---|---|
| ||||
$ cd aggregator
$ groovy ./scripts/update-asf-yaml.groovy ../ |
...
org-apache-sling- |
...
commons-metrics-prometheus/ |
See Git -
...
...
more details:
- tags: include initially
sling
andjava
(or other programming language, as applicable ) - homepage: module documentation on Sling website, or the Sling homepage if none exists
- description: the name from the
pom.xml
Enroll in Kibble
Badges
The sling-aggregator/add-badges.sh script automates the creation of badges for the README. You will need a valid GitHub token for it. To add the badges for just a single repository, run.
Code Block |
---|
$ cd aggregator
$ groovy ./generate-project-badges.groovy ../ ${NEW_REPO} |
Enroll in Kibble
See Repository analysis with Kibble The repository should be added as a source in the Apache Kibble dev instance to make sure development statistics are collected from it. The Kibble dev instance repository list should be refreshed periodically, but if you don't see the data in a week or so ask on dev@kibble.apache.org about it .
Onboard to SonarCloud
See the onboarding section in SonarCloud analysis .
Customize GitHub settings
By placing an .asf.yaml file one can customize certain GitHub settings like label, features and merge options.
Creating links to Git commits
...