HOWTO · Java

Archivo Gitignore para Java

Este tutorial analiza gitignore en Java y describe las reglas a seguir al crear gitignore manualmente.

Por Md Aminul IslamPublicado 2023-06-20Actualizado 2023-06-20
En esta página

El tutorial de hoy analiza el archivo .gitignore para Java a través de un ejemplo y enumera las reglas a seguir al crear .gitignore manualmente.

Descripción general del archivo .gitignore para Java

En Git, el término ignorar se usa para no rastrear archivos que Git debería ignorar, y no afecta a los otros archivos que ya están rastreados. Por ejemplo, a veces, deseamos no enviar archivos específicos al servicio Git como Github.

Hay un archivo llamado .gitignore a través del cual podemos especificar los archivos que deben ignorarse. En general, este archivo es generado por máquina. Algunos archivos comúnmente especificados en .gitignore se enumeran a continuación:

  • La dependencia de Cachés.
  • Códigos compilados.
  • Crear directorios de salida, como /bin, /out o /target.
  • Algún archivo de tiempo de ejecución generado, como .log, .lock o .tmp.
  • Archivos de sistema ocultos, como Thumbs.db o .DS_Store.
  • Sus archivos IDE config.

Reglas a seguir para crear el archivo .gitignore manualmente

Cuando intentamos crear un archivo .gitignore manualmente, debe seguir las siguientes reglas:

  • Git ignora las líneas que comienzan con # o las Líneas en blanco.
  • Solo debe seguir los patrones globales estándar y aplicarlo recursivamente.
  • Para evitar la recursividad, podemos empezar los patrones con un /.
  • Para especificar un directorio, podemos terminar los patrones con /.
  • Para negar un patrón, necesitamos comenzarlo con un !.

Ejemplo del Archivo .gitignore en Java

A continuación se muestra un ejemplo de un .gitignore generado especialmente para los proyectos IDE Intellij. Vamos a ver.

### Intellij ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm, and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# AWS User-specific
.idea/**/aws.xml

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated and may cause churn.
Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# SonarLint plugin
.idea/sonarlint/

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

### Intellij Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml
# .idea/misc.xml
# *.ipr

# Sonarlint plugin
# https://plugins.jetbrains.com/plugin/7973-sonarlint
.idea/**/sonarlint/

# SonarQube Plugin
# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
.idea/**/sonarIssues.xml

# Markdown Navigator plugin
# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
.idea/**/markdown-navigator.xml
.idea/**/markdown-navigator-enh.xml
.idea/**/markdown-navigator/

# Cache file creation bug
# See https://youtrack.jetbrains.com/issue/JBR-2257
.idea/$CACHE_FILE$

# CodeStream plugin
# https://plugins.jetbrains.com/plugin/12206-codestream
.idea/codestream.xml

# Azure Toolkit for IntelliJ plugin
# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
.idea/**/azureSettings.xml

### Java ###
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
replay_pid*

# End of https://www.toptal.com/developers/gitignore/api/java,intellij

El archivo .gitignore debe estar en un directorio raíz.

Sobre el autor

MD Aminul Islam

Aminul Is an Expert Technical Writer and Full-Stack Developer. He has hands-on working experience on numerous Developer Platforms and SAAS startups. He is highly skilled in numerous Programming languages and Frameworks. He can write professional technical articles like Reviews, Programming, Documentation, SOP, User manual, Whitepaper, etc.

Ver el perfil del autor
LinkedIn