Repository and service setup
This page is the one-time bootstrap checklist for the two public repositories and the services owned by EnderFall LTD. None of these steps weaken the release gates in the build.
GitHub repositories
Create these public repositories in the EnderFall-LTD GitHub organization:
| Repository | Purpose | License |
|---|---|---|
EnderFall-LTD/enderfall-sdk |
SDK source, API, runtimes, plugin, tests, and documentation | Apache-2.0 |
EnderFall-LTD/enderfall-sdk-template |
Minimal project users create their own repository from | CC0-1.0 |
For enderfall-sdk, use main as the default branch, enable Issues and private
vulnerability reporting, and select GitHub Actions as the Pages source. Create
the protected release environment and restrict deployments to main. Require a
review before that environment may run once more than one maintainer is available.
Protect main from force-pushes and deletion. Require the build and documentation
checks after their first successful run. The runtime smoke matrix is deliberately
reported separately from compilation.
For enderfall-sdk-template, enable Template repository in repository settings.
Its default branch is also main.
Documentation DNS
The Pages workflow builds MkDocs in strict mode and deploys the site directory.
The committed docs/CNAME file declares sdk.enderfall.co.uk.
At the authoritative DNS provider, create:
Type: CNAME
Name: sdk
Value: enderfall-ltd.github.io
TTL: 1 hour (or provider default)
After the Pages deployment succeeds and DNS resolves, enter
sdk.enderfall.co.uk as the repository's custom domain and enable Enforce HTTPS.
Do not create a second A or AAAA record for sdk; a CNAME must be unambiguous.
Maven Central ownership
- Sign in to the Central Publisher Portal using the EnderFall-owned account.
- Add the parent namespace
uk.co.enderfall. - Copy the verification key generated by Central.
- Create a TXT record at the root of
enderfall.co.ukwith that exact value. - Confirm the TXT record resolves publicly, then click Verify Namespace.
- Generate a Central user token. Store its generated username and password only
in the protected GitHub
releaseenvironment.
Central checks the exact domain represented by the requested namespace. The
domain enderfall.co.uk therefore proves the parent namespace
uk.co.enderfall. Authorization for a parent namespace includes all child
group IDs, so it permits the SDK to keep publishing as uk.co.enderfall.sdk.
Do not request uk.co.enderfall.sdk for this verification: that represents
sdk.enderfall.co.uk, which is already a CNAME used by the documentation site
and cannot also carry the required TXT record.
In GoDaddy, use @ as the TXT record name. Verify the newly issued key against
both authoritative name servers before asking Central to check it:
nslookup -type=TXT enderfall.co.uk ns41.domaincontrol.com
nslookup -type=TXT enderfall.co.uk ns42.domaincontrol.com
Gradle Plugin Portal ownership
Create an organization-owned Plugin Portal account and API key. The plugin ID is
uk.co.enderfall.sdk; its website and VCS URLs must already be public before the
first submission. The first version is manually reviewed, and Gradle may request
a DNS TXT record proving ownership of enderfall.co.uk.
Protected release secrets
Store all six values in the GitHub release environment, not as repository files
or developer Gradle properties:
| Secret | Meaning |
|---|---|
MAVEN_CENTRAL_USERNAME |
Username from a Central Portal user token |
MAVEN_CENTRAL_PASSWORD |
Password from the same Central token |
MAVEN_SIGNING_KEY_BASE64 |
Base64-encoded ASCII-armored private OpenPGP key |
MAVEN_SIGNING_PASSWORD |
Private-key passphrase |
GRADLE_PUBLISH_KEY |
Plugin Portal API key |
GRADLE_PUBLISH_SECRET |
Plugin Portal API secret |
Use a dedicated signing key for releases, publish its public key to a public key server, keep an encrypted offline recovery copy, and never print the private key or tokens in workflow logs. Store the private key as single-line Base64 so GitHub does not alter the armored key's line endings; the workflows decode it only in memory.
Current external-state check
The setup is complete only when all of these are true:
- both GitHub URLs are public and the template flag is enabled;
- the Pages workflow has deployed successfully;
sdk.enderfall.co.ukresolves and HTTPS is enforced;- Central shows the parent namespace
uk.co.enderfallas verified; - the Plugin Portal account and API key are ready to submit
uk.co.enderfall.sdk(the first publication can remain pending while Gradle performs its manual review); - the protected release environment contains all six secrets;
- the release workflow's nine target jobs and
verifyRuntimeMatrixaudit pass for the exact release commit; - the manual release-candidate checklist has been completed for that commit.