Repository navigation
Expand file tree
/
Copy pathsecrets.example.properties
More file actions
60 lines (50 loc) · 2.73 KB
/
Copy pathsecrets.example.properties
File metadata and controls
60 lines (50 loc) · 2.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# v2.2.4
# =====================================================================================
# SECRETS (EXAMPLE FILE)
# =====================================================================================
# THIS IS AN EXAMPLE FILE. RENAME IT TO `secrets.properties` AND FILL IN THE VALUES.
# DO NOT COMMIT `secrets.properties` TO VERSION CONTROL. (.gitignore ALREADY INCLUDES IT)
#
# Format:
# KEY = value
#
# Notes:
# - Only fill in what you need. Leave a value empty if you don't use that feature,
# e.g. skip the publishing sections if you never publish from this machine.
# - Never share these values or paste them into issues, logs or screenshots.
# - If a secret leaks, revoke it on the respective website and create a new one.
# - Keys are uppercase because they can also be provided as environment variables of
# the same name (e.g. in CI). An environment variable takes precedence over this file.
#
# Sections:
# 1. Minecraft development environment
# 2. Publishing CurseForge and Modrinth uploads
# 3. Maven Publishing credentials for the maven repository
# 4. GitHub bypass rate limit
# =====================================================================================
# ---- 1. Minecraft -------------------------------------------------------------------
# The username used when running the game from your development environment.
DEV_USERNAME =
# ---- 2. Publishing ------------------------------------------------------------------
# API token for CurseForge, used to upload your mod files.
# Create one in your CurseForge account settings under "API tokens".
CURSEFORGE_TOKEN =
# API token for Modrinth, used to upload your mod files.
# The token must have the `CREATE_VERSION` and `PROJECT_WRITE` permissions.
# Create one in your Modrinth account settings under "Personal access tokens".
MODRINTH_TOKEN =
# ---- 3. Maven Publishing ------------------------------------------------------------
# Credentials for the maven repository your artifacts are published to.
MAVEN_USERNAME =
MAVEN_PASSWORD =
# ---- 4. GitHub ----------------------------------------------------------------------
# Used for fetching files from GitHub (api.github.com and raw.githubusercontent.com).
# Without a token, requests are unauthenticated and quickly hit rate limits,
# especially on shared IPs or CI runners. Usual limits (REST API, per hour):
# - Unauthenticated: 60 requests (per IP)
# - Authenticated (personal token): 5,000 requests
# - GITHUB_TOKEN in GitHub Actions: 1,000 requests (per repository)
#
# Create a token: https://github.com/settings/personal-access-tokens/new
# Docs: https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api
GITHUB_TOKEN =