Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document configurable properties #12

Open
jensgreen opened this issue Dec 4, 2020 · 0 comments
Open

Document configurable properties #12

jensgreen opened this issue Dec 4, 2020 · 0 comments

Comments

@jensgreen
Copy link

I recently had to modify one of the properties below by setting a TeamCity internal property.

The property was undocumented, and I had to find it by searching the source code.

I would have expected to find important properties to be documented in the Configuration section of the README.

object GoogleConstants {
const val STORAGE_TYPE = "google-storage"
const val SETTINGS_PATH = "google-storage-settings"
const val SIGNED_URL_PATH = "google-signed-urls"
const val CREDENTIALS_TYPE = "credentials.type"
const val CREDENTIALS_ENVIRONMENT = "environment"
const val CREDENTIALS_KEY = "key"
const val USE_SIGNED_URL_FOR_UPLOAD = "credentials.useSignedUrl"
const val PARAM_ACCESS_KEY = Constants.SECURE_PROPERTY_PREFIX + "access-key"
const val PARAM_BUCKET_NAME = "bucket-name"
const val PATH_PREFIX_ATTR = "google_path_prefix"
const val PATH_PREFIX_SYSTEM_PROPERTY = "storage.google.path.prefix"
const val URL_LIFETIME_SEC = "storage.google.url.expiration.time.seconds"
const val SIGNED_URL_GET_CACHE_ENABLED = "storage.google.signedUrl.get.cache.enabled"
const val DEFAULT_URL_LIFETIME_SEC = 60
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant