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

Rename config.yml to hugo.yml #38582

Merged
merged 1 commit into from May 17, 2023
Merged

Rename config.yml to hugo.yml #38582

merged 1 commit into from May 17, 2023

Conversation

coliff
Copy link
Contributor

@coliff coliff commented May 10, 2023

Description

hugo.yml is now recommended (over the generic sounding config.yml) as the default config based filename.
REF: https://gohugo.io/getting-started/configuration/#hugotoml-vs-configtoml

(This change isn't important, feel free to close if you'd rather use config.yml for any reason)

Motivation & Context

Changing this may make it easier for code editors and build tools to identify this as a Hugo configuration file and project.

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Live previews

Related issues

@coliff coliff marked this pull request as draft May 10, 2023 07:21
@julien-deramond
Copy link
Member

julien-deramond commented May 10, 2023

Thanks for the PR @coliff
On my side, I don't mind the change if it is the recommended way :)
There's probably a change to do in generate-sri.js as well.
@XhmikosR You have more experience than me with Hugo. Thoughts about this change?

@XhmikosR XhmikosR self-assigned this May 10, 2023
hugo.yml is now recommended (over the generic sounding config.yml) as the default config based filename
REF: https://gohugo.io/getting-started/configuration/#hugotoml-vs-configtoml
Changing this may make it easier for code editors and build tools to identify this as a Hugo configuration file and project.
@coliff coliff marked this pull request as ready for review May 11, 2023 11:20
@coliff coliff requested a review from a team as a code owner May 11, 2023 11:20
@XhmikosR XhmikosR added the docs label May 17, 2023
@XhmikosR XhmikosR merged commit 07a08c2 into twbs:main May 17, 2023
15 checks passed
@coliff coliff deleted the patch-3 branch May 17, 2023 05:28
romankupchak93 pushed a commit to romankupchak93/bootstrap that referenced this pull request Jan 5, 2024
hugo.yml is now recommended (over the generic sounding config.yml) as the default config based filename
REF: https://gohugo.io/getting-started/configuration/#hugotoml-vs-configtoml
Changing this may make it easier for code editors and build tools to identify this as a Hugo configuration file and project.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants