Propagate environment #1358

[ajain58]

Adds propagate-environment: true to all pipeline templates and removes the environment definition from docker compose files

Closes #1358

[changeset-bot]

🦋 Changeset detected

Latest commit: 10ddc21

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
skuba	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[72636c]

Great find. Looks like a straightforward port of the Docker plugin implementation buildkite-plugins/docker-compose-buildkite-plugin#344 so I'm not seeing any additional risks.

[72636c]

👏

We should add a changeset for this

[ajain58]

👏

We should add a changeset for this

this would be a minor right @72636c ?

[72636c]

@ajain58 Great question, we have an informal & impure 🙃 practice of filing template updates as patches. This is dishonest to semver but the rationale is that existing projects are the ones that upgrade to new versions & review release notes, and once you've run skuba init then updates to the built-in templates don't really impact you beyond an FYI about about a best current practice.

[72636c]

That reminds me that we should update https://github.com/seek-oss/skuba/blob/master/CONTRIBUTING.md#creating-a-changeset

[samchungy]

Any ideas where VERSION comes from? @72636c. I can see ENVIRONMENT in the UI so it will get propagated successfully by the propagate-environment setting.

[samchungy]

skuba/template/lambda-sqs-worker/.buildkite/pipeline.yml

Line 46 in 454710c

VERSION: ${BUILDKITE_COMMIT:0:7}.${BUILDKITE_BUILD_NUMBER}

Is this template meant to have this line?

[72636c]

Ah yes, I think that's right re: VERSION. Maybe we should extend the CDK template to use the version variable too

CDK

skuba/template/lambda-sqs-worker-cdk/src/app.ts

Lines 4 to 6 in 454710c

	const logger = createLogger({
	name: '<%- serviceName %>',
	});

Serverless

skuba/template/lambda-sqs-worker/src/config.ts

Line 48 in 454710c

version: Env.string('VERSION'),

skuba/template/lambda-sqs-worker/src/framework/logging.ts

Lines 14 to 17 in 454710c

	base: {
	environment: config.environment,
	version: config.version,
	},

[samchungy]

I did a quick test and pipeline variables which are defined within steps and/or on the pipeline at upload time also get passed to the container via the propagate-environment option.

[72636c]

Thanks a bunch for this 🙌