feat(docs): seed .env.example + add release-sync workflow (#101)#106
Merged
Conversation
Initial drop of `public/config/env.example` copied from plugwerk/plugwerk main and a `sync-env-example.yml` workflow that mirrors `sync-openapi.yml` / `sync-docker-compose.yml` so future releases refresh the file via the new `env-example-update` dispatch fired from plugwerk/plugwerk#527. Issue: #101
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.env.examplefrom plugwerk/plugwerk@main intopublic/config/env.exampleso the file is visible on the website immediately, without waiting for the next release..github/workflows/sync-env-example.ymlworkflow listening for theenv-example-updaterepository_dispatchevent (mirrorssync-openapi.yml/sync-docker-compose.yml). Future releases that touch.env.examplewill refresh this file via PR automatically.Test plan
sync-openapi.ymlexactly (same SHA-pinned actions, samegh apipattern, samepeter-evans/create-pull-requestconfiguration).gh workflow run sync-env-example.yml --field version=<latest-tag>to confirm the workflow runs and produces a no-oppull-request-operation = none(initial seed equals fetched content)..env.examplein plugwerk/plugwerk and tag a release; expect achore: sync .env.example from plugwerk <version>PR to open here.Out of scope
configuration.mdx(rendering the synced file inline, retiring duplicated env-var tables) — that lives in the parent issue docs: consume .env.example from plugwerk/plugwerk in configuration page #101 as a follow-up.Refs #101