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

Use Organization's .github README.md.gotmpl #368

Merged
merged 30 commits into from
Jan 30, 2024
Merged

Conversation

osterman
Copy link
Member

@osterman osterman commented Jan 25, 2024

@osterman osterman changed the title Fetch org readme template Use Organization's .github README.md.gotmpl Jan 25, 2024
goruha
goruha previously approved these changes Jan 25, 2024
@goruha goruha self-requested a review January 25, 2024 19:55
.github/workflows/lint.yml Outdated Show resolved Hide resolved
@osterman osterman requested a review from Nuru January 26, 2024 03:34
Nuru
Nuru previously approved these changes Jan 26, 2024
@Nuru Nuru self-requested a review January 26, 2024 04:56
@osterman osterman merged commit 56cac58 into master Jan 30, 2024
14 checks passed
@osterman osterman deleted the org-readme-templates branch January 30, 2024 20:15
.dockerignore Outdated
@@ -1 +1,2 @@
.git/*
Copy link
Member Author

@osterman osterman Jan 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Nuru these commands rely on
git remote get-url which doesn't work with out .git, which means it won't work in geodesic

export README_TEMPLATE_FILE ?= $(BUILD_HARNESS_PATH)/templates/README.md.gotmpl
export README_TEMPLATE_YAML := $(if $(findstring http,$(README_YAML)),$(README_YAML),$(BUILD_HARNESS_PATH)/templates/$(README_YAML))
export README_INCLUDES ?= $(file://$(shell pwd)/?type=text/plain)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Nuru this is needed by the README.md.gotmpl which uses it as the base for including other files (e.g. from docs/)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this syntax, README_INCLUDES is always empty. Probably meant for it to be automatically including $PWD but since it never worked, I would rather just remove it from the template.

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

Successfully merging this pull request may close these issues.

4 participants