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.

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

[#678] Updated .gitignore configs. #679

Merged
merged 1 commit into from
Jul 3, 2024
Merged

[#678] Updated .gitignore configs. #679

Show file tree
Hide file tree
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
17 changes: 17 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Drupal editor configuration normalization
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Providing this file in a template allows to have a "place" to put additional editor configurations.

# @see http://editorconfig.org/

# This is the top-most .editorconfig file; do not search in parent directories.
root = true

# All files.
[*]
end_of_line = LF
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[composer.{json,lock}]
indent_size = 4
26 changes: 16 additions & 10 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Ignore directories generated by Composer
# To ignore OS temporary files use global .gitignore
# https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The local-specific overrides should be managed by users themselves using a global .gitignore. Ignoring vendor-specific entries make this selection biased, so it is better to exclude them from the list. The entries removed below.


# Ignore directories generated by Composer.
/drush/contrib/
/vendor/
/web/core/
Expand All @@ -7,19 +10,22 @@
/web/profiles/contrib/
/web/libraries/

# Ignore sensitive information
# Ignore sensitive information.
/web/sites/*/settings.php
/web/sites/*/settings.local.php

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this and missed services.local.yml files are now managed with Drupal Scaffold .gitignore files created during composer install.

# Ignore Drupal's file directory
# Ignore Drupal's file directory.
/web/sites/*/files/

# Ignore SimpleTest multi-site environment
# Ignore SimpleTest multi-site environment.
/web/sites/simpletest

# Ignore files generated by common IDEs
/.idea/
/.vscode/

# Ignore .env files as they are personal
# Ignore .env files as they could contain sensitive information.
/.env

# Manage .gitattributes with Drupal scaffold for cross-platform compatibility.
# Remove the line below and commit the file for more granular control.
/.gitattributes

# Manage all .gitignore files with Drupal scaffold.
# Remove the line below and commit the files for more granular control.
**/.gitignore
5 changes: 5 additions & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@
"extra": {
"composer-exit-on-patch-failure": true,
"drupal-scaffold": {
"file-mapping": {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Important section

"[project-root]/.gitignore": false,
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The .gitignore provided by this template replaces the .gitignore provided by Drupal scaffold as an "example" since our files is an "extended example".

"[web-root]/INSTALL.txt": false,
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Explicitly exclude both INSTALL and README as these files have been reported to be a source of identification of the Drupal version (on misconfigured servers), that opens an additional attack vector.

"[web-root]/README.txt": false
},
"locations": {
"web-root": "web/"
}
Expand Down
Loading