Skip to content

Fix documentation links in validation errors #46

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.

Sign up for GitHub

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

Merged
GrahamCampbell merged 1 commit into from
Jun 12, 2026
Merged

Fix documentation links in validation errors #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/configuration/validate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ function validateConfiguration(configuration, configurationPath) {
if (configuration == null || typeof configuration !== 'object') {
throw new ServerlessError(
`Resolved "${configurationFilename}" does not contain valid osls compose configuration.\n` +
'Read about osls compose in the documentation: https://github.com/oss-serverless/osls/blob/main/docs/guides/compose.md',
'Read about osls compose in the documentation: https://github.com/oss-serverless/osls/blob/4.x/docs/guides/compose.md',
'INVALID_NON_OBJECT_CONFIGURATION'
);
}

if (!hasOwn(configuration, 'services') || !isObject(configuration.services)) {
throw new ServerlessError(
`Invalid configuration: "${configurationFilename}" must contain "services" property.\n` +
'Read about osls compose configuration in the documentation: https://github.com/oss-serverless/osls/blob/main/docs/guides/compose.md',
'Read about osls compose configuration in the documentation: https://github.com/oss-serverless/osls/blob/4.x/docs/guides/compose.md',
'INVALID_NON_OBJECT_SERVICES_CONFIGURATION'
);
}
Expand All @@ -35,7 +35,7 @@ function validateConfiguration(configuration, configurationPath) {
if (!isObject(value)) {
throw new ServerlessError(
`Invalid configuration: definition of "${key}" service must be an object.\n` +
'Read about osls compose configuration in the documentation: https://github.com/oss-serverless/osls/blob/main/docs/guides/compose.md',
'Read about osls compose configuration in the documentation: https://github.com/oss-serverless/osls/blob/4.x/docs/guides/compose.md',
'INVALID_NON_OBJECT_SERVICE_CONFIGURATION'
);
}
Expand Down Expand Up @@ -73,7 +73,7 @@ function validateConfiguration(configuration, configurationPath) {
if (extraProperties.length > 0) {
throw new ServerlessError(
`Unrecognized property ${extraProperties.join(', ')} in "${configurationFilename}".\n` +
'Read about osls compose configuration in the documentation: https://github.com/oss-serverless/osls/blob/main/docs/guides/compose.md',
'Read about osls compose configuration in the documentation: https://github.com/oss-serverless/osls/blob/4.x/docs/guides/compose.md',
'INVALID_CONFIGURATION'
);
}
Expand Down
Loading